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

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

2025-08-27T10:00:27Z

Ka.shapovalov:

===== '''Общее описание''' =====
Сервис 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/'''
! 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/data/{id}'''
! colspan="3" |Получение архива модели.
|-
| colspan="3" |id — идентификатор модели.
|ZIP-файл с моделью, либо <code>{ error: INT , message: DESCRIPTION }</code>
|-
!style="color:green;width: 15%"|'''POST:/spr/data/{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/data/{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>
|}

UPS. Описание API

2025-08-27T09:59:36Z

Ka.shapovalov:

===== '''Описание часто используемых параметров''' =====
{| 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''' =====

{| 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''' =====
{| class="wikitable" style="width: 110%"
|+
!style="color:blue;width: 15%" |'''GETsmc/classify/{model}'''
! colspan="3" style="width: 85%" |Классификация текстовой фразы. В случае если модель была создана из меток, в ответе groups и nearest будут пустыми, а ответ будет построен без учета confidenceThreshold из запроса.
В ответе:

* classes — список, для каждого класса которого отображается название класса, к которому был отнесен текст, и вероятность его принадлежности к этому классу.
* groups — название группы и число совпавших классов. Если метки совпадают с несколькими группами, они отображаются в порядке убывания числа совпавших классов (т. е. чем полнее группа, тем выше ее позиция в списке).
* nearest — отображаются группы, до которых не хватает всего одной метки, с указанием процента заполненности и сортировкой по убыванию этого процента.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
*'''text''' - текст, подлежащий классификации
*'''correction''' - уровень коррекции ошибок, от 0 до 3, по умолчанию 0
*'''confidenceThreshold''', % - минимальный порог доверия.
| colspan="2" style="width: 50%" |{ "corrected": "исправленный текст", # при наличии флага коррекции "classes": [

 { "class": "название класса",

 "confidence": 1 },

 { "class": "название класса 2",

 "confidence": 1 } ],

 "groups": [

 { "group": "название группы 1",

 "intersection": 2,

 "classes": [ "название класса", "название класса 2" ] } ],

 "nearest": [

 { "group": "название группы 2",

 "percent": 0.67,

 "need": "название класса которого не хватило 1" },

 { "group": ""название группы 3",

 "percent": 0.67,

 "need": "название класса которого не хватило 2" } ] }
|-
!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'''"
*'''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''' - генерирует кэш через разные ответы на каждый вопрос по документации

*'''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:blue;width: 15%" |'''GET/qas/chat'''
! colspan="2" | Поиск ответа за пределами документов. Аналогичен методу "POST/qas/chat". Не поддерживает большие тексты.На стадии разработки, не используется.
|-
| colspan="2" |
*'''text -''' текст вопроса
*'''history''' - история вопросов, будет склеена с text при запросе
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''useInternalTemplate''' - использовать ли шаблон запроса. '''no''' - не использовать, либо код шаблона запроса к LLM. Необязательный параметр. Если не указан, используется шаблон по умолчанию.
*'''params''' - необязательный параметр. JSON с произвольными параметрами запроса к LLM. Описание параметров см. в [[QAS. Руководство администратора|руководстве администратора]].
|Аналогично методу "POST/qas/chat".
|-
! style="color:green;width: 15%" |'''POST/qas/cleandoc'''
! colspan="2" |Очистка документа от лишней информации
|-
| colspan="2" |
*'''text -''' текст документа
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|{"error": 0, "message": "success", "text": "измененный текст"}
|-
! 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''' — фильтр вопросов, ограничение списка по вопросам

*'''answer''' — фильтр ответов, ограничение списка по ответам
| 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:blue;width: 15%" |'''GET/qas/mismatchsearcher/answers'''
! colspan="2" |Отображает лог найденных несоответствий
|-
| colspan="2" |Входные параметры отсутствуют
|на выходе :массив из объектов {

 'question_id'

'category'

'answer_id'

'answer'

'description'

'error'

}
|-
! style="color:green;width: 15%" |'''POST/qas/mismatchsearcher/start'''
! colspan="2" |Старт поиска несоответствий
|-
| colspan="2" |
*'''category''' — id категории документа. Если не указать категорию, метод вернет ответ на основе всех документов в базе данных. Допускается указание нескольких категорий через разделитель "|".
*'''model''' - имя модели GPT, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|<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/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''' — категория (раздел) знаний. Допускается указание нескольких категорий через разделитель "|".
*'''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)
|[ "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 - замена информации в тексте

*'''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. Руководство пользователя

2025-08-27T08:24:32Z

Ka.shapovalov:

===== '''Общее описание''' =====
Сервис 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/'''
! 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/data/{id}'''
! colspan="3" |Получение архива модели.
|-
| colspan="3" |id — идентификатор модели.
|ZIP-файл с моделью, либо <code>{ error: INT , message: DESCRIPTION }</code>
|-
!style="color:green;width: 15%"|'''POST:/spr/data/{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/data/{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, автоматическое определение количества
* '''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>
|}

UPS. Описание API

2025-08-27T07:53:37Z

Ka.shapovalov: /* /sbs: работа с сервисом SBS */

===== '''Описание часто используемых параметров''' =====
{| 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''' =====

{| 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, автоматическое определение количества
* '''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''' =====
{| class="wikitable" style="width: 110%"
|+
!style="color:blue;width: 15%" |'''GETsmc/classify/{model}'''
! colspan="3" style="width: 85%" |Классификация текстовой фразы. В случае если модель была создана из меток, в ответе groups и nearest будут пустыми, а ответ будет построен без учета confidenceThreshold из запроса.
В ответе:

* classes — список, для каждого класса которого отображается название класса, к которому был отнесен текст, и вероятность его принадлежности к этому классу.
* groups — название группы и число совпавших классов. Если метки совпадают с несколькими группами, они отображаются в порядке убывания числа совпавших классов (т. е. чем полнее группа, тем выше ее позиция в списке).
* nearest — отображаются группы, до которых не хватает всего одной метки, с указанием процента заполненности и сортировкой по убыванию этого процента.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
*'''text''' - текст, подлежащий классификации
*'''correction''' - уровень коррекции ошибок, от 0 до 3, по умолчанию 0
*'''confidenceThreshold''', % - минимальный порог доверия.
| colspan="2" style="width: 50%" |{ "corrected": "исправленный текст", # при наличии флага коррекции "classes": [

 { "class": "название класса",

 "confidence": 1 },

 { "class": "название класса 2",

 "confidence": 1 } ],

 "groups": [

 { "group": "название группы 1",

 "intersection": 2,

 "classes": [ "название класса", "название класса 2" ] } ],

 "nearest": [

 { "group": "название группы 2",

 "percent": 0.67,

 "need": "название класса которого не хватило 1" },

 { "group": ""название группы 3",

 "percent": 0.67,

 "need": "название класса которого не хватило 2" } ] }
|-
!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'''"
*'''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''' - генерирует кэш через разные ответы на каждый вопрос по документации

*'''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:blue;width: 15%" |'''GET/qas/chat'''
! colspan="2" | Поиск ответа за пределами документов. Аналогичен методу "POST/qas/chat". Не поддерживает большие тексты.На стадии разработки, не используется.
|-
| colspan="2" |
*'''text -''' текст вопроса
*'''history''' - история вопросов, будет склеена с text при запросе
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''useInternalTemplate''' - использовать ли шаблон запроса. '''no''' - не использовать, либо код шаблона запроса к LLM. Необязательный параметр. Если не указан, используется шаблон по умолчанию.
*'''params''' - необязательный параметр. JSON с произвольными параметрами запроса к LLM. Описание параметров см. в [[QAS. Руководство администратора|руководстве администратора]].
|Аналогично методу "POST/qas/chat".
|-
! style="color:green;width: 15%" |'''POST/qas/cleandoc'''
! colspan="2" |Очистка документа от лишней информации
|-
| colspan="2" |
*'''text -''' текст документа
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|{"error": 0, "message": "success", "text": "измененный текст"}
|-
! 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''' — фильтр вопросов, ограничение списка по вопросам

*'''answer''' — фильтр ответов, ограничение списка по ответам
| 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:blue;width: 15%" |'''GET/qas/mismatchsearcher/answers'''
! colspan="2" |Отображает лог найденных несоответствий
|-
| colspan="2" |Входные параметры отсутствуют
|на выходе :массив из объектов {

 'question_id'

'category'

'answer_id'

'answer'

'description'

'error'

}
|-
! style="color:green;width: 15%" |'''POST/qas/mismatchsearcher/start'''
! colspan="2" |Старт поиска несоответствий
|-
| colspan="2" |
*'''category''' — id категории документа. Если не указать категорию, метод вернет ответ на основе всех документов в базе данных. Допускается указание нескольких категорий через разделитель "|".
*'''model''' - имя модели GPT, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|<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/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''' — категория (раздел) знаний. Допускается указание нескольких категорий через разделитель "|".
*'''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)
|[ "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 - замена информации в тексте

*'''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. Руководство пользователя

2025-08-27T07:52:06Z

Ka.shapovalov:

===== '''Общее описание''' =====
Сервис 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 со всеми методами с возможностью их проверки.

{| 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
}

<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>
|}

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

2025-08-21T08:21:59Z

Ka.shapovalov:

====='''Общее описание'''=====
Сервис предназначен для поиска ответа на заданный вопрос. Входным значением для сервиса являются данные в текстовом формате. В ответ на входящий запрос сервис возвращает данные в формате 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 осуществляется скриптом <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 - для работы с документами

Расположение моделей 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.gpu_layers
|12
|Количество слоёв встроенной нейросети.
|-
|gpt.context
|32768
|Размер контекста встроенной нейросети.
|-
|logs.path
|logs/
|Папка для хранения логов. Примеры абсолютного пути: "/var/log/qas/".
|-
|logs.backups
|10
|Количество файлов ротации.
|-
|logs.maxSize
|5242880
|Максимальный размер файла в байтах, триггер для ротации.
|-
|cache.size
|2560000
|Максимальный размер кэша векторов
|-
|cache.update
|3600
|Период сохранения кэша на диск (секунды)
|-
|fragments.context
|8192
|Максимальная длина текста, которая будет подана в генератор для поиска ответа на вопрос.
|-
|fragments.threshold
|0.6
|Уровень достоверности при векторном поиске фрагментов в загруженных документах.
|-
|fragments.limit
|1
|Максимальное количество фрагментов, которые должны быть найдены в документах в порядке убывания доверия.
|-
|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. Руководство администратора

2025-08-20T14:15:37Z

Ka.shapovalov:

====='''Общее описание'''=====
Сервис предназначен для поиска ответа на заданный вопрос. Входным значением для сервиса являются данные в текстовом формате. В ответ на входящий запрос сервис возвращает данные в формате 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 осуществляется скриптом <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 - для работы с документами

Расположение моделей 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.gpu_layers
|12
|Количество слоёв встроенной нейросети.
|-
|gpt.context
|32768
|Размер контекста встроенной нейросети.
|-
|logs.path
|logs/
|Папка для хранения логов. Примеры абсолютного пути: "/var/log/qas/".
|-
|logs.backups
|10
|Количество файлов ротации.
|-
|logs.maxSize
|5242880
|Максимальный размер файла в байтах, триггер для ротации.
|-
|cache.size
|100000
|Максимальный размер кэша векторов
|-
|cache.update
|3600
|Период сохранения кэша на диск (секунды)
|-
|cache.path
|/opt/qas/.cache
|Путь к файлу кэша
|-
|fragments.context
|8192
|Максимальная длина текста, которая будет подана в генератор для поиска ответа на вопрос.
|-
|fragments.threshold
|0.6
|Уровень достоверности при векторном поиске фрагментов в загруженных документах.
|-
|fragments.limit
|1
|Максимальное количество фрагментов, которые должны быть найдены в документах в порядке убывания доверия.
|-
|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>. Команда деинсталлирует сервис и удалит рабочий каталог, включая все установленные модели.

SES. UPS руководство по работе с интерфейсом

2025-07-21T10:36:33Z

Ka.shapovalov:

=== SES (Script Engine Service) Сценарная машина ===
[[Файл:UPS SES.png|мини|''Рис. 1 Главный экран UPS'']]

В главном меню UPS (Universal Proxy Server) расположены кнопки для перехода в блоки (см. рис. 1):

# [[SMC. UPS руководство по работе с интерфейсом|SMC Классификатор]],
# [[SEE. UPS руководство по работе с интерфейсом|SEE Сущности]],
# [[SPR. UPS руководство по работе с интерфейсом|SPR Распознавание]],
# [[SBS. UPS руководство по работе с интерфейсом|SBS Биометрия]],
# [[TTS. UPS руководство по работе с интерфейсом|TTS Синтез]],
# [[QAS. UPS руководство по работе с интерфейсом|QAS ЧаВО]],
# SES Сценарная машина,
# Выход.

Переключаться между продуктами можно двумя способами:

# Воспользоваться кнопкой на панели управления «На главную» [[Файл:Меню пользователя new.png|безрамки|20x20px]].
# Воспользоваться кнопкой в виде линии, которая находится снизу в центе экрана (см. рис. 2).
[[Файл:2025-06-09 14-33-48.png|мини|''Рис. 2 Рабочая область SES'']]

Рабочая область SES включает в себя (рис. 2):

* список роботов, расположенный на левой панели
* панель управления,
* облако/таблица элементов данных и конечных точек,
* кроме того, есть вкладки: «[[SES. UPS руководство по работе с интерфейсом#Вкладка «Скрипты»|Скрипты]]», «[[SES. UPS руководство по работе с интерфейсом#Вкладка «Календарь»|Календарь]]», «[[SES. UPS руководство по работе с интерфейсом#Вкладка «Интервалы»|Интервалы]]», «[[SES. UPS руководство по работе с интерфейсом#Вкладка «Настройки»|Настройки]]» и информационная вкладка «Серверы», которая отображает информацию о серверах и процессах. Все они находятся с правой стороны рабочей области.

==== Добавление и настройка робота ====
Чтобы добавить нового робота, нажмите кнопку '''«Добавить робота»'''. В появившемся диалоговом окне введите название и нажмите '''«Добавить»'''. В нижнем правом углу экрана появится сообщение «Добавлено!». По умолчанию робот создается с предварительными настройками. В нем сразу есть текстовки для исключений и событий, ознакомиться и поправить их можно, перейдя на вкладку [[SES. UPS руководство по работе с интерфейсом|«Настройки»]]. Робот может быть 3х версий: черновик, рабочий и архивный, подробная информация о версиях представлена в таблице 1.
{| class="wikitable"
|+''Табл. 1 Версии робота.''
!'''Иконка версии'''
!'''Наименование версии робота'''
!'''Описание'''
|-
|[[Файл:Черновик.png|центр|безрамки|40x40пкс]]
|Черновик
|это не примененный робот. Можно добавлять новые элементы данных, конечные точки, менять настройки, применять эти настройки и тестировать робота. После применения робота (см. [https://wiki.connect2ai.net/index.php?title=SES._UPS_руководство_по_работе_с_интерфейсом&veaction=edit&section=2#Панель_управления_SES табл.2] «Применение») становится «Рабочей версией».
|-
|[[Файл:Рабочая_нов.png|центр|безрамки|40x40пкс]]
|Рабочая
|это робот, который уже используется в прод (англ. ''production –'' производство'')''. Применённого робота нельзя установить заново или менять. Можно провести ручное тестирование (см. раздел «[[SES. UPS руководство по работе с интерфейсом#Тестирование робота|Тестирование робота]]») . Можно менять настройки робота и применять эти настройки, они применяются в фоновом режиме незаметно для пользователя, то есть пользователю ничего не нужно обновлять со своей стороны. Если была применена черновая версия робота ''–'' «Рабочий» робот переходит в архивную версию.
|-
|[[Файл:Архив_нов.png|центр|безрамки|40x40пкс]]
|Архивная
|это рабочий робот, который переводится в архив (резервную копию) после применения черновика. Можно вернуть архивную модель в рабочую версию, нажав на кнопку «Восстановить» (см. [https://wiki.connect2ai.net/index.php?title=SES._UPS_руководство_по_работе_с_интерфейсом&veaction=edit&section=2#Панель_управления_SES Панель управления SES]). При этом рабочая версия также становится архивной, то есть рабочая и архивная версии меняются местами.
|}

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

- Все требуемые модели [[SMC. UPS руководство по работе с интерфейсом|SMC]];

- Все требуемые модели [[SEE. UPS руководство по работе с интерфейсом|SEE]];

- База вопросно-ответных пар в [[QAS. UPS руководство по работе с интерфейсом|QAS]], если вы планируете предоставлять консультации.

Здесь представлен общий перечень необходимых сервисов. В зависимости от специфики проекта некоторые из них могут отсутствовать.
[[Файл:2025-07-04 17-15-25.png|мини|''Рис. 3 Интерфейс вкладки Скрипты'']]

====== Вкладка «Скрипты» ======
предоставляет вам возможность работать с кодом скриптов интеграции в системе напрямую. Вы можете вносить изменения в код, используя выпадающий список «Скрипт». В этом списке вы найдете все доступные скрипты и сможете выбрать нужный. После выбора скрипта вы сможете отредактировать его название и непосредственно область для внесения изменений.

У скриптов есть параметр '''''«Область действия»''''', в котором есть 5 опций:

- ''конечные точки'', позволяет подключать скрипт в действиях конечных точек;

- ''элементы данных'', позволяет подключать скрипт в действиях элементов данных и контейнеров;

- ''завершение сессии'' — скрипты, которые могут выполняться после завершения диалога, если скрипт указать в настройках в действиях на событии «Завершение диалога»;

- ''перед каждым вопросом'' - для случаев, когда нужно актуализировать какую-то информацию постоянно и использовать ее в условиях.<blockquote>

Скриптом «перед каждым вопросом» можно выставить, например, сегодняшнюю дату - custom.today, а потом ее в сравнении дат использовать в условиях получения данных. Для случаев записи на прием проверять, '''что дата точно больше сегодняшней.''' </blockquote>

- ''после каждого ответа'' - для случаев, требуется пошагово после каждого ответа передавать информацию во внешнюю систему.

[[Файл:Scrirts.png|мини|''Рис. 4 Отладка скриптов интеграции'']]
Есть '''режим отладки скриптов интеграций''' с функцией извлечения данных из сессии (рис. 4). То есть можно [[SES. UPS руководство по работе с интерфейсом#Тестирование робота|тестировать робота в чате отладчика]] и, в случае если отработка некорректна или нужно проверить внесенные изменения в скрипт, то можно открыть вкладку «Скрипты» -> выбрать нужный скрипт -> кликнуть на закладку «Проверка» (слева откроется дополнительное окно) и нажать на кнопку «Вставить данные сессии». Тогда в открывшемся окне появятся все данные из текущей сессии из чата отладчика. По нажатию на кнопку «Тест», появится окно с результатом отработки скрипта.

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

[[Файл:Интервалы2.png|мини|''Рис. 5 Интерфейс вкладки «Интервалы»'']]
====== Вкладка «Интервалы» ======
предлагает вам возможность заранее задать временные промежутки (утро, день, вечер, ночь), которые будут определять реакцию робота в зависимости от времени суток. Например, вы можете настроить приветствия, такие как «Доброе утро!» или «Добрый день!» и бот будет выбирать нужное в соответствии с текущем временем. А так же периоды, например, настроить рабочее время до перерыва или после. Периодов может быть несколько на одном интервале. Чтобы добавить новый интервал, нужно найти меню «Интервал времени» в верхней части вкладки «Интервалы» (рис. 5). Затем нажмите кнопку «Добавить интервал времени». В появившемся окне введите название нового интервала и настройте его параметры по своему усмотрению. Вы можете выбрать необходимое количество минут и часов из выпадающего списка или ввести их с клавиатуры. Чтобы удалить период, просто нажмите на иконку корзины, расположенную напротив выбранного периода. Для удаления интервала времени воспользуйтесь кнопкой «Удалить», расположенной в нижней правой части окна.

====== Вкладка «Настройки» ======
изображённая на рисунке 6, содержит следующие поля:
* название робота,
* описание
А так же меню с настройками:

* события — это настройка действий робота, при наступлении этого события, например «Не найдено» (см. раздел «События» ниже);
* исключения — это то, сколько раз допускается событие (см. раздел «Исключения» ниже);
* данные;[[Файл:2025-07-04 17-26-03.png|мини|''Рис. 6 Интерфейс вкладки «Настройки»'']]
* модели — настройка моделей, если требуется использовать параметры, отличные от параметров по умолчанию;

'''''События''''' есть 11-ти типов и прописываются для каждого канала связи отдельно:

# Старт — старт новой сессии — это когда робот приветствует пользователя и представляется. Это событие срабатывает, если человек впервые начинает общение с ботом. Также полное приветствие необходимо при начале разговора по телефону.
# Горячий старт — это событие настраивается для случаев, если диалог был приостановлен. То есть, при горячем старте бот не станет снова представляться абоненту, а просто поприветствует его в зависимости от времени суток (настроенных интервалов) и ответит на его вопросы.
# Возврат на старт — это действие, которое должен выполнить бот, чтобы вернуться к началу разговора. Например, в диалоге в голосовом чате можно спросить у пользователя: «Чем я могу вам ещё помочь?»
# Запрос повтора — действия на случай, если абонент запросил повтор информации.
# Тишина — добавляем действие в моменты, когда от человека нет ответа, то есть тишина.
# Перебивание — событие доступно ''только для голосовых каналов (например, voice)''. Она позволяет настроить реакцию на прерывание речи.
# Задержка ответа — событие доступно ''только для голосовых каналов (например, voice)''. Это действия, которые появляются, когда идет генерация. Например, можно написать: «Секундочку, выясняю». Это нужно, чтобы человек понимал, что робот не просто молчит.
# Не найдено — здесь указывается действие, которое должен выполнить робот, если он не смог найти ответ на вопрос пользователя, то есть настройка действий если это событие произошло. Например, можно предложить пользователю попробовать переформулировать свой вопрос.
# Нет данных — это событие происходит, когда система пытается получить конкретный недостающий элемент данных, например название филиала, и ей это не удалось.
# Ошибка.
# Запрос повтора — если пользователь не расслышал информацию в голосовом канале, он может запросить её повторение. В этом разделе можно настроить функцию повтора последнего или двух последних ответов.

'''Если произойдет какое-либо событие, будет выполнено действие из канала по умолчанию, если в канале не указано иное.'''

Вы можете настроить реакции робота на определённые события. Более подробную информацию о них вы найдёте в разделе «Исключения».

'''''Исключения''''' есть трех типов '''Тишина''', '''Не найдено''' и '''Нет данных'''.

При '''Тишине''', когда пользователь молчит, можно выставить одно или несколько исключений подряд (одно исключение равно 4000 мс.) (параметр ''Макс. кол-во исключений подряд'') и если были выполнены эти исключения подряд, то можно выполнить определенные действия: ''Сказать'', ''Завершить диалог, Отправить файл или Передача диалога'''''.''' Также здесь указано ''время жизни сессии'' в секундах. Это означает, что по истечении заданного периода сессия будет завершена.
[[Файл:Функционал действий.png|мини|''Рис. 7 Функционал Действий'']]
Действие ''Сказать'' тоже разделяется на 4 типа:

- последовательно — это означает, что робот будет задавать вопросы и выдавать информацию по порядку, в соответствии с тем, что будет записано в полях «Фразы»,

- случайная фраза — вы получите любую фразу из имеющегося списка.<blockquote>По клику правой клавишей мыши на поле «Фраза» появляется меню, где можно выбрать одно из действий:

# Добавить кнопку (подробнее см. раздел [[SES. UPS руководство по работе с интерфейсом#Добавление кнопок в действия|«Добавление кнопок в действия»]]).
# Перефразировать. Если нужно добавить вариации фразы (рис. 7). Предложенные фразы можно отредактировать или удалить, кликнув по иконке корзинки напротив нужной фразы.
# Удалить лишнюю фразу можно, если она не единственная, кликнув на поле с этой фразой правой клавишей мыши и в появившемся меню выбрать «Удалить фразу». Также можно кликнуть на иконку корзины, которая появится справа от фразы при наведении на нее курсора.</blockquote>- из внутреннего источника — в этом случае выполняется консультация из [[QAS. UPS руководство по работе с интерфейсом|QAS]] (системы ответов на вопросы) после настройки ''условий присвоения''. Так же требуется настроить условия вывода ответа: использование кэша ответов, генерация и требуется ли кэширование формулировки (подробнее об этих настройках см. инструкцию по [[QAS. UPS руководство по работе с интерфейсом#Поиск ответа|QAS.Поиск ответа]]). Второй вариант — QAS-чат. В этом случае ответы на вопросы будут поступать не из базы данных, а от встроенной модели LLM по умолчанию или из любой другой модели, которую [[QAS. Руководство администратора|добавит]] администратор.

- из внешнего источника — в этом случае можно подключить скрипты-интеграций для выполнения необходимых действий, если они есть.

Для действий предусмотрены три опции: «Копировать», «Переместить» и «Удалить действие», соответственно порядку на картинке [[Файл:Для действий.png|безрамки|80x80пкс]]. Чтобы скопировать действие в другой канал, нажмите соответствующую кнопку и в открывшемся окне выберите нужный канал из списка. Если вы хотите переместить действие, выполните те же действия. Обратите внимание, что при перемещении действие будет удалено из исходного канала. Чтобы удалить действие, нажмите на кнопку в виде корзинки.<blockquote>
''Примечание: допускается запись фраз шаблоном - [Уточните|Подскажите] что вас интересует по...? - и бот случайным образом будет выбирать слова из скобок и строить фразу.''</blockquote>Для действий можно настроить '''условия запуска'''. Это условия, при которых действие будет выполняться (этих условий может не быть). Такой подход удобен, когда для исключения нужно настроить разные действия в зависимости от поступающих данных или переменных. <blockquote>Например, в случае действия «Передача диалога», в зависимости от значения переменной с номером телефона, можно отправить информацию в разные контактные центры.</blockquote>

При исключении типа '''«Не найдено»''', то есть в запросе абонента обнаружилась неизвестная тематика или отсутствие ответа. Выставляется параметр «Макс. кол-во исключений подряд», то есть сколько раз бот может не найти информацию (сколько раз допускается это событие), после чего происходит переключение на оператора, либо выполнить действия «Сказать», «Завершить диалог» или «Передать диалог».

При исключении типа '''«Нет данных»''' также выставляется параметр «Макс. кол-во исключений подряд», то есть сколько раз бот может не найти информацию (сколько раз допускается это событие), после чего происходит переключение на оператора либо выполнить действия «Сказать», «Завершить диалог» или «Передать диалог».<blockquote>Важно: Если элемент отсутствует в начале, счётчик увеличивается на единицу. То есть учитывается самое первое сообщение абонента, в котором не было нужной информации. </blockquote>Вкладка '''''Данные''''' позволяет настроить процесс обработки сервисных данных, таких как согласие, отрицание, повторение и так далее. Для каждого элемента сервисных данных указывается его ''Тип'' (Класс или Сущность), ''Модель'', из которой берутся данные, а также конкретный ''Класс'' или ''Сущность''.

На вкладке '''''Модели''''' нужно добавить все модели, которые нужны для работы робота, например, модели SMC, SEE и голоса.

На вкладке можно настроить параметры голосового канала. Вот что там можно сделать:

* Выбрать голос, которым будет говорить робот.

* Установить основную модель распознавания (рекомендуем оставлять common).

* Определить фоновую модель распознавания (рекомендуем background).

Для каждой модели можно задать порог доверия, который определяет, какие данные от этой модели будут использоваться в сценарии, а какие — нет. Данные (метки), которые не достигают этого уровня, будут исключены из сценария, и в нём останутся только те, что превышают или равны этому уровню. Для моделей SMC можно выбрать один из режимов «Коррекции»:

* '''Базовая''': исправляет только слова с минимальными опечатками (1-2 ошибки для коротких слов, макс. 1 ошибка)
* '''Расширенная''': допускает больше исправлений для сложных случаев (добавляет +1 ошибку к базовому порогу, макс. 2 ошибки).
* '''Агрессивная''': корректирует даже сильно искажённые слова (добавляет +2 ошибки к базовому порогу, макс. 3 ошибки).
* либо коррекция может '''Отсутствовать'''.

==== Добавление и настройка элементов данных ====
[[Файл:Снимок экрана 2025-07-16 154838.png|мини|''Рис. 8. Массовое добавление элементов данных'']]
[[Файл:2025-06-09 14-43-00.png|мини|''Рис. 8.1. Бланк настройки элемента данных'']]
После того как вы добавили робота нужно добавить элементы данных, нажав на кнопку '''«Добавить элемент»'''. В появившемся диалоговом окне возможны два варианта добавления: '''"Одиночное"''' и '''"Массовое"'''.

Для '''одиночного''' режима обязательно заполните поле '''«Название элемента данных»''', выберите тип элемента в выпадающем списке («Класс», «Сущность» или «Контейнер») и нажмите на кнопку '''«Добавить»'''. Все созданные элементы данных формируют ''облако данных'' и находятся на левой части рабочей области.

'''Класс''' — данные, полученные из моделей SMC.

'''Сущность''' — информация из моделей SEE.

'''Контейнер''' — составной элемент данных, который собирает необходимые данные, чтобы отправить их во внешнюю БД по API с помощью скриптов интеграции.

Для '''массового''' режима (''доступно только для типа "Класс"'') необходимо выбрать модель (''Рис. 8''). Далее, в появившейся таблице будет представлен список классов этой модели, которых еще нет в списке элементов данных, с указанием подтипа (''см. подраздел '''«Подтип»''' ниже'') для каждого класса. После нажатия кнопки '''«Добавить»''' будут добавляться элементы данных, отмеченные галочкой, с заполненными полями "Название", "Модель", "Класс", "Подтип", "Вес" соответственно (''см. обозначения ниже'').

===== Настройка элемента данных =====
[[Файл:2025-04-23 14-43-07.png|мини|''Рис. 9 Проверка модели в ЭД'']]
На предыдущем этапе вы добавили новый элемент. После этого откроется окно, в котором необходимо настроить новый элемент данных (''Рис. 8.1''). В этом окне есть два поля: «'''Название элемента данных»''' и '''«Тип»''', которые вы заполнили при создании элемента данных. Однако, если вы передумаете, вы сможете изменить только название элемента данных. Далее необходимо заполнить поле '''«Модель»''', а в поле '''«Класс»''' выбрать класс этой модели ([[SMC. UPS руководство по работе с интерфейсом|SMC]]), соответствующий типу элемента данных. ''Если получили класс от SMC, следовательно, получен и элемент данных, ему соответствующий.'' Возле названия модели появится значок серой галочки — «Проверка модели» (см. рис. 9). При нажатии на него откроется функция ручной проверки модели, аналогичная проверке [[SEE. UPS руководство по работе с интерфейсом|SEE]] и [[SMC. UPS руководство по работе с интерфейсом|SMC]]. '''«Вес»''' — это параметр, который определяет приоритет этого элемент данных в спорных ситуациях. По умолчанию установлено значение 3. Также вес ЭД отображается в [[SES. UPS руководство по работе с интерфейсом#Тестирование робота|отладчике]] и, если у вас активировано [[SES. UPS руководство по работе с интерфейсом#Панель управления SES|табличное представление сценария]], то и в самой таблице. <blockquote>Совет по работе с весом ЭД.

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

* Предварительная запись, отмена записи, уточнение записи и её перенос.
* Проверка статуса,
* Запрос оператора,
* а так же данные (тематики), которые должны отрабатываться иным способом, например, ЭД Выплаты и пособия, Опека и др. должны уходить на оператора, по ним нет консультации в ЧаВО.

Рассмотрим пример. ЭД «Предварительная запись» имеет вес 4 и приоритет в случае, если одновременно с ней от модели пришла метка СНИЛС (вес по умолчанию 3). В таком случае сочетание этих меток должно привести к КТ «Запись на прием».

Однако существуют некоторые '''исключения'''. Например, если метка «Предварительная запись» (вес 4) появляется вместе с меткой «Детский сад» (вес 3), то их комбинация должна привести в КТ «Консультация ЧаВО», а не в КТ «Запись на приём». Чтобы избежать такой ситуации, можно ''добавить это сочетание меток для входа в раздел «Консультация ЧаВО»''. Тогда при поступлении такого запроса от модели сценарная машина отправит его в QAS.

'''То есть в случае однозначного приоритета можно повысить вес у конкретного элемента данных, а все исключения из этого правила отрабатывать добавлением сочетания меток на вход нужной КТ.'''</blockquote>В выпадающем списке '''«Подтип»''' можно выбрать один из двух вариантов:

«Сервисный» — этот элемент данных не нужно включать в отчет.

«Отчетный» — такой элемент должен быть отображен в отчетах.

Есть возможность '''оставлять комментарии''' по нажатию на кнопку [[Файл:Комментарий.png|безрамки|20x20пкс]]. Это удобно, например, если нужно сделать заметку для себя или коллег. Например, если было изменено значение веса ЭД, можно указать причину в комментарии. Как только будет оставлен комментарий, иконка поменяется на [[Файл:Комментарий полный.png|безрамки|20x20пкс]] — это означает, что комментарий не пустой.
[[Файл:Настройка исключений.jpg|мини|''Рис. 10 Настройка нестандартных исключений'']]

Рядом с комментарием находится кнопка '''Исключения''' [[Файл:Исключения .png|безрамки|20x20пкс]]. По нажатию на эту кнопку можно для определенных элементов данных настроить нестандартные исключения, то есть исключения, отличные от общих настроек (рис.10). <blockquote>
Например, для ЭД «Название филиала». [[SES. UPS руководство по работе с интерфейсом#Вкладка «Настройки»|В общих настройках]] робота МФЦ указано, что количество исключений для события «Нет данных» равно 3 (в счетчик входит и первое обращение к роботу, если там не было нужной информации). Однако мы хотим, чтобы, если с первого раза филиал не был найден, робот больше не запрашивал у абонента его название. Вместо этого робот должен показать заглушку с предложением поискать нужный филиал на сайте. Для таких случаев можно настроить '''нестандартное исключение.''' </blockquote>Настройка нестандартного исключения:

# выберете нужный элемент данных,
# кликните на значок исключения [[Файл:Исключения .png|безрамки|20x20пкс]],
# в появившемся окне активируйте флаг «включить нестандартные исключения»,
# заполните тип исключения Нет данных,
# установите максимальное кол-во исключений подряд (если хотите уточнять один раз, то макс.кол-во устанавливайте равным 2),
# установите канал связи при необходимости,
# и выберете действие на случай, если исключение наступило.

В настройках есть флажок '''«Получать только прямым запросом»'''. Он предназначен для элементов данных, которые следует извлекать только тогда, когда мы находимся в конечной точке, где они необходимы и только в случае если сценарий дошел до точки дозапроса этого элемента данных.<blockquote>'''Пример: Запись на прием'''

1. Процесс взаимодействия с пользователем

Пользователь хочет записаться на прием. Для этого необходимо собрать следующие данные:

* Намерение (цель обращения).
* Адрес (куда хочет попасть пользователь).
* ФИО.
* Номер телефона.

2. Работа моделей в КТ "Запись на прием"

* Все модели, отвечающие за обработку запроса, работают в фоновом режиме.
* На любом этапе диалога они могут «выхватывать» сущности (например, извлекать ФИО, адрес и т. д.).

3. Проблема ложного срабатывания

Модель может ошибочно извлечь данные, если:

* Пользователь вводит информацию, которая частично совпадает с искомой сущностью (например, город ''"Владимир"'' может быть ошибочно принят за имя).
* Это приводит к некорректной обработке данных до завершения сценария.

4. Решение: ограничение работы модели

Чтобы избежать ложных срабатываний:

* Активируйте галочку '''«Получать только прямым запросом»''' в настройках ЭД.
* Если галочка активна, модель (например, извлечение ФИО) сработает только когда:
** Сценарий диалога дошел до запроса ФИО.
** Пользователь явно отвечает на вопрос о недостающих данных по ФИО.

Таким образом, '''система не будет обрабатывать случайные упоминания имен или других сущностей вне контекста запроса.'''</blockquote>Флажок '''«Подставлять ответ модели в сообщение»''' предназначен для работы с типами ЭД «Сущность».

Его основная функция — подставлять в запросы пользователей ответ от модели (название тэга) SEE вместо исходного текста абонента, на который среагировала модель.<blockquote>'''Пример использования'''

Например, для оформления загранпаспорта необходимо уточнить возраст получателя.

# Создаем модель SEE с тегами:
#* <code>до 14 лет</code>
#* <code>с 14 лет до 18 лет</code>
#* <code>с 18 лет</code> ''(Теги формируются на основе предоставленной документации.)''
# Добавляем ЭД в качестве недостающего элемента в настройки КТ.
# Когда сценарий доходит до дозапроса этого ЭД или абонент сам предоставляет данные, система отправляет запрос в QAS. Например, абонент отвечает, что ему 44 года, но в документах нет такого варианта. В них информация сгруппирована <code>до 14 лет</code>, <code>с 14 лет до 18 лет</code> и <code>с 18 лет.</code> Соответственно система не найдет похожую информацию.
# Решение:
#* Если флажок активирован, система подставит ближайший подходящий тег (в данном случае — <code>с 18 лет</code>).
#* Это поможет QAS корректно находить информацию в документации.
'''Важно:''' если ваша модель SEE '''не отдаст ответ''', то настройка '''не сработает'''. Проверьте и при необходимости дообучите модель.</blockquote>

Флажок '''«Режим долгого ожидания»''' Открывает дополнительное меню с триггерами окончания ожидания. Это данные, при получении которых мы прекращаем ждать именно этот элемент данных (ЭД). Например, если получили его же или другие данные, например, просьбу позвать оператора.<blockquote>'''Обратите внимание:''' чтобы этот режим работал правильно, создайте нестандартное исключение для ЭД (описание выше). Иначе система будет ориентироваться на общие настройки количества исключений.</blockquote>После завершения всех настроек нажмите на кнопку '''«Добавить элемент»''', и он появится в списке элементов данных.

Если в карточку ЭД были внесены изменения, закрыть её можно только после того, как вы сохраните эти изменения и кликните на любую область за пределами карточки, или принудительно закрыть её, нажав на кнопку «Закрыть» (без сохранения внесенных изменений). Если открыли карточку просто для просмотра, то закрывается по клику вне карточки или по кнопке «Закрыть».

===== События элемента данных =====

Так же можно настроить События. Это действия которые будут происходить при получении этого элемента данных (если пришел класс от [[SMC. UPS руководство по работе с интерфейсом|SMC]]). События есть двух типов:

# если найден только текущий,
# недостающий элемент,
# нет данных,
# тишина.
<blockquote>'''Обратите внимание:''' для событий «Тишина» и «Нет данных» на ЭД доступны ''нестандартные исключения''. Подробнее об этом читайте в предыдущем разделе.</blockquote>

'''Тип события «Если найден только текущий»''' позволяет настроить реакцию на получение только одного этого класса.<blockquote>
Например, у нас есть такой элемент данных, как Дата. Если абонент называет или пишет: «25 января», мы получили класс от SSE, а значит получили и элемент данных. Но поскольку ответить на такое сообщение не возможно, то в этом типе события можно указать уточнение, например: «Что вы имеете в виду?»</blockquote>
Можно настроить разные события для разных каналов. Чтобы переключиться между каналами связи, просто откройте выпадающий список «Канал». По умолчанию выбран канал «default».

'''Действия''' для этого типа события могут быть 4 видов:

- сказать,

- завершить диалог,

- отправить файл,

- передача диалога.

Действие ''Сказать'' тоже разделяется на 3 типа:

- последовательно — это означает, что робот будет задавать вопросы и выдавать информацию по порядку, в соответствии с тем, что будет записано в полях «Фразы»,

- случайную фразу — робот выберет случайную фразу из предложенных вариантов для ответа на обращение пользователя,

- из внешнего источника — в этом случае можно подключить скрипты для выполнения необходимых действий, если они есть,<blockquote>По клику правой клавишей мыши на поле «Фраза» появляется меню, где можно выбрать одно из действий:
# Добавить кнопку (подробнее см. раздел [[SES. UPS руководство по работе с интерфейсом#Добавление кнопок в действия|«Добавление кнопок в действия»]]).
# Перефразировать. Если нужно добавить вариации фразы. Предложенные фразы можно отредактировать или удалить, кликнув по иконке корзинки напротив нужной фразы.
# Удалить лишнюю фразу можно, кликнув на поле с этой фразой правой клавишей мыши и в появившемся меню выбрать «Удалить фразу». Можно кликнуть на иконку корзины, которая появится справа от фразы при наведении на нее курсора.</blockquote>
Затем в параметре «Дополнительно» можно настроить интервал времени, когда это действие выполнять.<blockquote>''Примечание: допускается запись фраз шаблоном - [Уточните|Подскажите] что вас интересует по...? - и бот случайным образом будет выбирать слова из скобок и строить фразу.''</blockquote>Для действий предусмотрены три опции: «Копировать», «Переместить» и «Удалить действие», соответственно порядку на картинке [[Файл:Для действий.png|безрамки|80x80пкс]]. Чтобы скопировать действие в другой канал, нажмите соответствующую кнопку и в открывшемся окне выберите нужный канал из списка. Если вы хотите переместить действие, выполните те же действия. Обратите внимание, что при перемещении действие будет удалено из исходного канала. Чтобы удалить действие, нажмите на кнопку в виде корзинки.

У всех действий, кроме Завершения диалога, есть опция:

* Прерываемое — этот флаг активируется для голосового канала и говорит о том, что допускается прерывание (перебивание) робота в момент синтеза ответа. Если он активен, робот будет реагировать на стоп-слова, в противном случае — нет.

'''Тип события «Недостающий элемент»''' предоставляет возможность создать сценарий на случай, если для активации конечной точки не хватает именно этого конкретного элемента данных. Если есть необходимость дозапросить информацию при получении какого-то элемента данных, то можно сделать это следующим образом:

# Создаем элемент данных (класс или сущность). <blockquote>Например, пользователь обращается с вопросом о замене паспорта, но не уточняет, какой паспорт ему нужно заменить — заграничный или внутренний. Для этого случая есть элемент данных «Тип паспорта», который является сущностью. У этого элемента данных будет стоять событие типа «Недостающий элемент» с уточнением: «Какой паспорт нужен — заграничный или внутренний?». То есть мы запрашиваем у пользователя информацию, для того чтобы получить этот элемент данных и перейти либо в конечную точку «Паспорт РФ» (при получении тега от [[SEE. UPS руководство по работе с интерфейсом|SEE]] «РФ»), либо в конечную точку «Загранпаспорт» (при получении тега от [[SEE. UPS руководство по работе с интерфейсом|SEE]] «Загран»).</blockquote>2. Выбираем тип события «Недостающий элемент» и настраиваем действие. И сохраняем настройки.
[[Файл:Фильтрация и настройка кон.точки.png|мини|''Рис. 11 Окно с настройкой элемента данных'']]'''Действия''' для этого типа события могут быть 4 видов:

- сказать,

- завершить диалог,

- отправить файл,

- передача диалога.

Действие ''Сказать'' тоже разделяется на 3 типа:

- последовательно — это означает, что робот будет задавать вопросы и выдавать информацию по порядку, в соответствии с тем, что будет записано в полях «Фразы»,

- случайную фразу — робот выберет случайную фразу из предложенных вариантов для ответа на обращение пользователя,

- из внешнего источника — в этом случае можно подключить скрипты для выполнения необходимых действий, если они есть,<blockquote>По клику правой клавишей мыши на поле «Фраза» появляется меню, где можно выбрать одно из действий:
# Добавить кнопку (подробнее см. раздел [[SES. UPS руководство по работе с интерфейсом#Добавление кнопок в действия|«Добавление кнопок в действия»]]).
# Перефразировать. Если нужно добавить вариации фразы. Предложенные фразы можно отредактировать или удалить, кликнув по иконке корзинки напротив нужной фразы.
# Удалить лишнюю фразу можно, кликнув на поле с этой фразой правой клавишей мыши и в появившемся меню выбрать «Удалить фразу». Можно кликнуть на иконку корзины, которая появится справа от фразы при наведении на нее курсора.</blockquote>
Затем в параметре «Дополнительно» можно настроить интервал времени, когда это действие выполнять.<blockquote>''Примечание: допускается запись фраз шаблоном - [Уточните|Подскажите] что вас интересует по...? - и бот случайным образом будет выбирать слова из скобок и строить фразу.''</blockquote>Для действий предусмотрены три опции: «Копировать», «Переместить» и «Удалить действие», соответственно порядку на картинке [[Файл:Для действий.png|безрамки|80x80пкс]]. Чтобы скопировать действие в другой канал, нажмите соответствующую кнопку и в открывшемся окне выберите нужный канал из списка. Если вы хотите переместить действие, выполните те же действия. Обратите внимание, что при перемещении действие будет удалено из исходного канала. Чтобы удалить действие, нажмите на кнопку в виде корзинки.

У всех действий, кроме Завершения диалога, есть опция:

* Прерываемое — этот флаг активируется для голосового канала и говорит о том, что допускается прерывание (перебивание) робота в момент синтеза ответа. Если он активен, робот будет реагировать на стоп-слова, в противном случае — нет.
[[Файл:2025-05-21 12-31-27.png|мини|''Рис. 12 Добавление кнопок'']]
Окно с полностью заполненными настройками выглядит так, как показано на рисунке 10. Так же на рисунке 10 показана возможность фильтрации и поиска по заданному значению. При отображении в виде облака все элементы данных, которые совпадают с поисковыми критериями, будут выделены синим цветом. В случае табличного представления будут отображены только те элементы данных, которые соответствуют запросу, и соответствующие КТ, где на входе есть искомый ЭД.

'''Тип события''' '''«Тишина»''' настраивается на каждом элементе данных при необходимости, чаще это нужно для недостающего элемента, который мы запрашиваем. Тут можно прописать действия на случай, если в ответ на вопрос от робота человек молчит.<blockquote>
Например, если робот спрашивает у абонента, какой паспорт ему нужен, а человек молчит, можно через некоторое время повторить вопрос или сказать: «Говорите громче, не слышно».</blockquote>'''Действия''' для этого типа события могут быть 4 видов:

- сказать,

- завершить диалог,

- отправить файл,

- передача диалога.

Действие ''Сказать'' тоже разделяется на 3 типа:

- последовательно — это означает, что робот будет задавать вопросы и выдавать информацию по порядку, в соответствии с тем, что будет записано в полях «Фразы»,

- случайную фразу — робот выберет случайную фразу из предложенных вариантов для ответа на обращение пользователя,

- из внешнего источника — в этом случае можно подключить скрипты для выполнения необходимых действий, если они есть,<blockquote>По клику правой клавишей мыши на поле «Фраза» появляется меню, где можно выбрать одно из действий:
# Добавить кнопку (подробнее см. раздел [[SES. UPS руководство по работе с интерфейсом#Добавление кнопок в действия|«Добавление кнопок в действия»]]).
# Перефразировать. Если нужно добавить вариации фразы. Предложенные фразы можно отредактировать или удалить, кликнув по иконке корзинки напротив нужной фразы.
# Удалить лишнюю фразу можно, кликнув на поле с этой фразой правой клавишей мыши и в появившемся меню выбрать «Удалить фразу». Можно кликнуть на иконку корзины, которая появится справа от фразы при наведении на нее курсора.</blockquote>
Затем в параметре «Дополнительно» можно настроить интервал времени, когда это действие выполнять.<blockquote>''Примечание: допускается запись фраз шаблоном - [Уточните|Подскажите] что вас интересует по...? - и бот случайным образом будет выбирать слова из скобок и строить фразу.''</blockquote>Для действий предусмотрены три опции: «Копировать», «Переместить» и «Удалить действие», соответственно порядку на картинке [[Файл:Для действий.png|безрамки|80x80пкс]]. Чтобы скопировать действие в другой канал, нажмите соответствующую кнопку и в открывшемся окне выберите нужный канал из списка. Если вы хотите переместить действие, выполните те же действия. Обратите внимание, что при перемещении действие будет удалено из исходного канала. Чтобы удалить действие, нажмите на кнопку в виде корзинки.

У всех действий, кроме Завершения диалога, есть опция:

* Прерываемое — этот флаг активируется для голосового канала и говорит о том, что допускается прерывание (перебивание) робота в момент синтеза ответа. Если он активен, робот будет реагировать на стоп-слова, в противном случае — нет.

'''Тип события''' '''«Нет данных»''' настраивается на каждом элементе данных при необходимости, чаще это нужно для недостающего элемента, который мы запрашиваем. Тут можно прописать действия на случай, если в ответ на вопрос от робота человек говорит что-то, но не ответ на вопрос.

'''Действия''' для этого типа события могут быть 4 видов:

- сказать,

- завершить диалог,

- отправить файл,

- передача диалога.

Действие ''Сказать'' тоже разделяется на 3 типа:

- последовательно — это означает, что робот будет задавать вопросы и выдавать информацию по порядку, в соответствии с тем, что будет записано в полях «Фразы»,

- случайную фразу — робот выберет случайную фразу из предложенных вариантов для ответа на обращение пользователя,

- из внешнего источника — в этом случае можно подключить скрипты для выполнения необходимых действий, если они есть,<blockquote>По клику правой клавишей мыши на поле «Фраза» появляется меню, где можно выбрать одно из действий:
# Добавить кнопку (подробнее см. раздел [[SES. UPS руководство по работе с интерфейсом#Добавление кнопок в действия|«Добавление кнопок в действия»]]).
# Перефразировать. Если нужно добавить вариации фразы. Предложенные фразы можно отредактировать или удалить, кликнув по иконке корзинки напротив нужной фразы.
# Удалить лишнюю фразу можно, кликнув на поле с этой фразой правой клавишей мыши и в появившемся меню выбрать «Удалить фразу». Можно кликнуть на иконку корзины, которая появится справа от фразы при наведении на нее курсора.</blockquote>
Затем в параметре «Дополнительно» можно настроить интервал времени, когда это действие выполнять.<blockquote>''Примечание: допускается запись фраз шаблоном - [Уточните|Подскажите] что вас интересует по...? - и бот случайным образом будет выбирать слова из скобок и строить фразу.''</blockquote>Для действий предусмотрены три опции: «Копировать», «Переместить» и «Удалить действие», соответственно порядку на картинке [[Файл:Для действий.png|безрамки|80x80пкс]]. Чтобы скопировать действие в другой канал, нажмите соответствующую кнопку и в открывшемся окне выберите нужный канал из списка. Если вы хотите переместить действие, выполните те же действия. Обратите внимание, что при перемещении действие будет удалено из исходного канала. Чтобы удалить действие, нажмите на кнопку в виде корзинки.
[[Файл:Уведомление об отсутствующем классе.png|мини|''Рис. 12.1. Уведомление об отсутствующем классе'']]
У всех действий, кроме Завершения диалога, есть опция:

* Прерываемое — этот флаг активируется для голосового канала и говорит о том, что допускается прерывание (перебивание) робота в момент синтеза ответа. Если он активен, робот будет реагировать на стоп-слова, в противном случае — нет.

В таблице элементов данных предусмотрено уведомление ''(Рис 12.1)'' об отсутствующей модели на сервере, которую использует элемент данных, а также об отсутствующем классе в выбранной модели. При таких случаях левее элемента данных расположен значок [[Файл:Warning.png|безрамки]] , при наведении на которого будет показано соответствующее сообщение.

==== Добавление кнопок в действия ====
[[Файл:2025-03-28 14-35-58.png|мини|''Рис. 13 Редактирование и удаление кнопки'']]

В сценарной машине предусмотрена возможность добавления кнопок. Для этого нужно кликнуть правой клавишей мыши (ПКМ) на поле «Фраза» в любом блоке действий и в появившемся меню выбрать «Добавить кнопку» (рис. 12). После этого раскроется блок с настройками, где требуется ввести:

# название кнопки;
# текст для отправки — это тот текст, который отправится на модели ([[SMC. UPS руководство по работе с интерфейсом|SMC]], [[SEE. UPS руководство по работе с интерфейсом|SEE]]).

Чтобы внести изменения в созданную кнопку, кликните по ней левой клавишей мыши (ЛКМ) и в открывшемся меню можно редактировать или удалить эту кнопку (рис. 13). <blockquote>Есть возможность выполнить настройки кнопок для разных каналов. Для этого переключите канал в меню напротив «Типа» события, по умолчанию все настройки производятся в канале default.</blockquote>
[[Файл:2024-11-18 12-00-28.png|мини|''Рис. 14 Рабочая область SES'']]

==== Добавление и настройка конечных точек ====
Конечная точка — это то, что выполняет определённое действие, например, предоставляет консультацию, завершает диалог и так далее. Процесс добавления конечной точки похож на добавление элемента данных. В верхней правой части рабочей области расположена кнопка '''«Добавить конечную точку»''' (рис. 14). Нажав на неё и заполнив поле с названием, вы создадите новую конечную точку. Все созданные точки образуют «облако конечных точек».

===== Настройка конечной точки =====
После того как вы ввели название конечной точки и нажали кнопку '''«Добавить»''', слева на рабочей панели появится окно для настройки конечной точки. В самом верху этого окна отображается ''название конечной точки'', при желании его можно сменить. Также доступен выпадающий список «Тип». Здесь можно выбрать один из четырёх вариантов:

'''«Отчетный»''' — эта та, которая участвует в статистике, т.е. несет какую-то полезную для анализа информационную нагрузку.

'''«Сервисный»''' — это такие конечные точки, как «приветствие» и другие, которые служат для поддержания диалога.

'''«Передача диалога»''' — точки, отвечающие за переключение звонка или передачу разговора операторам.

'''«Завершение диалога»''' — конечная точка, которая ставит точку в общении с пользователем.
[[Файл:2025-03-28 14-57-55.png|мини|''Рис. 15 Типы входа в конечные точки'']]

Также можно выбрать еще '''Тип входа в КТ''' может быть трех видов (рис. 15):

'''- по условиям''', когда попадаем в КТ при условии получения определенных данных, например, класс от SMC.

- '''по бездействию''', когда КТ отрабатывает по таймауту, указанному в поле Время, если абонент приостановил взаимодействие с роботом, но сессия еще не завершилась. <blockquote>Пример.

Абонент обратился за консультацией. Робот предоставил ответ. После консультации абонент бездействует, а сессия еще не закрыта. Можно настроить КТ Оценка качества обслуживания, которая по истечению указанного времени запросит оценку, после ответа абонента, завершит сессию.</blockquote>- '''по ручному запуску''', когда КТ нужно принудительного запустить, например из рассылки

Есть возможность '''оставлять комментарии''' по нажатию на кнопку [[Файл:Комментарий.png|безрамки|20x20пкс]]. Это удобно, например, если нужно сделать заметку для себя или коллег. Как только будет оставлен комментарий, иконка поменяется на [[Файл:Комментарий полный.png|безрамки|20x20пкс]] — это означает, что комментарий не пустой.

[[Файл:2025-05-28 16-23-27.png|мини|''Рис. 16 Вход в КТ по условиям'']]

===== Вход в конечную точку «по условиям» =====
Чтобы настроить вход в конечную точку по определённым условиям, выберите из выпадающего меню «Вход» опцию «По условиям» (рис. 15).

Далее есть 2 вкладки:

- Условия,

- Действия.

На вкладках «Условия» доступна ''фильтрация по элементу данных.''

'''Условия входа и запуска'''. Для того чтобы попасть в конечную точку и выполнить определенные действия, нужно выполнить условия входа. Их может быть как один элемент данных, так и их сочетание (см.рис. 16). <blockquote>Пример: У нас есть конечная точка «Загранпаспорт». И в эту конечную точку приводят элемент данных: ''«Загранпаспорт»'' (получена метка от [[SMC. UPS руководство по работе с интерфейсом|SMC]], соответствующая этому элементу данных). А также сочетание элементов данных: ''«Паспорт»'' (получаем, если тип паспорта не указан сразу) и ''«Тип паспорта-загран»'' (тег «Загран» получили после уточнения типа паспорта).</blockquote>Условия входа объединены в блоки, которые имеют логическое условие «И». Чтобы добавить новое условие, необходимо нажать на кнопку «Добавить условие» [[Файл:Добавить условие.png|безрамки|20x20пкс]]. Блоки с условиями «И» разделены логическим «ИЛИ».
[[Файл:Рис. 17 Условия запуска.png|мини|''Рис. 17 Условия запуска'']]
'''''Условия запуска''.''' По нажатию на эту кнопку открывается окно, где нужно указать '''''все''''' случаи (данные и их комбинации), '''''при которых точка сработает''''' (см.рис. 17). В окне «Условия запуска» элементы данных разделяются логическим оператором «ИЛИ». В случае с комбинациями условий ЭД отделяются друг от друга логическим «И». Как в случае с элементами, разделёнными операторами «ИЛИ», так и с элементами, разделёнными «И», порядок элементов можно менять. Для того, чтобы изменить порядок элементов, разделённых «ИЛИ», необходимо навести курсор (он изменится на курсор перемещения) на любой край элемента и перетянуть элемент на необходимую позицию. Для изменения порядка элементов, разделённых «И», необходимо навести курсор (он изменится на курсор в форме маленькой руки) на специальную иконку для перетаскивания слева от строки с условием и перетащить его в нужное место. Условия можно редактировать: добавлять и удалять. Окно можно двигать как удобно, достаточно просто зажать левую клавишу мыши и перетащить как нужно.<blockquote>Например, конечная точка «Консультация» активируется, если будут получены метки «Апостиль» ИЛИ «Банкротство» ИЛИ «Загранпаспорт» и «Тип паспорта — загран».</blockquote>В меню условий запуска есть повторяющиеся кнопки ''«Сохранить»'' и ''«Закрыть»''. '''Обратите внимание:''' при нажатии на кнопку «Сохранить» '''сохраняются''' не только текущие условия запуска, но и '''все настройки КТ'''. При нажатии на кнопку «Закрыть» '''без сохранения изменения теряются'''.

У условий есть параметр ''«Тип»'', принимающий два значения: данные или переменная. Параметр ''«Искать»'' имеет три варианта:

* ''Во всем диалоге''. Если выбрали эту опцию, то система будет искать этот ЭД во всем диалоге. Например, если спрашиваем у абонента имя или номер телефона, то сохраняем эти данные навсегда и больше не переспрашиваем.
* ''В текущей точке''. Поиск данных (ЭД) будет происходить с момента входа в КТ и до выхода из этой КТ или повторного входа в нее, но уже с новыми условиями. Например, для случаев с КТ Консультация или любой другой КТ, множеством условий входа.
* ''В последнем сообщении''. Система будет учитывать только последнее сообщение абонента, игнорируя предыдущие.

Далее идет поле «Название», где из выпадающего списка требуется выбрать нужный элемент данных. <blockquote>Если в выбранном элементе данных не заполнено событие "Недостающий элемент", то в правом верхнем углу будет расположен значок [[Файл:Warning.png|безрамки]] со всплывающим уведомлением при наведении на него.</blockquote>Справа от поля «Название» из выпадающего списка можно выбрать один из операторов:

* Существует — это любое значение этого элемента данных, то есть важно просто наличие этого элемента данных,
* != — не равно,
* = — равно,
* < — меньше,
* > — больше,
* <= — меньше или равно,
* => — больше или равно,
* Длина равна — длина ответа абонента равна определенному значению, которое указывается в поле «Значение». Например, когда абонент вводит код для проверки статуса заявления, который должен быть равен 7 знакам,
* Длина меньше — длина ответа абонента меньше определенного значения, указанного в поле «Значение»,
* Длина больше — длина ответа абонента больше определенного значения, указанного в поле «Значение».

Если в карточку КТ были внесены изменения, закрыть её можно только после того, как вы сохраните эти изменения и кликните на любую область за пределами карточки, или принудительно закрыть её, нажав на кнопку «Закрыть» (без сохранения внесенных изменений). Если открыли карточку просто для просмотра, то закрывается по клику вне карточки или по кнопке «Закрыть»

.

'''Действия.''' В этом разделе настраиваются действия, которые будет выполняться при условии, что все данные получены. А так же условия присвоения категорий из [[QAS. UPS руководство по работе с интерфейсом|QAS]] для выполнения консультаций. Напоминаем, что '''действия''' для этого типа события могут быть 4 видов:

- сказать,

- завершить диалог,

- отправить файл,

- передача диалога.

Действие ''Сказать'' тоже разделяется на 4 типа:

- последовательно — это означает, что робот будет задавать вопросы и выдавать информацию по порядку, в соответствии с тем, что будет записано в полях «Фразы»,

- случайная фраза — вы получите любую фразу из имеющегося списка.

- из внутреннего источника — в этом случае выполняется консультация из [[QAS. UPS руководство по работе с интерфейсом|QAS]] (системы ответов на вопросы) после настройки ''условий присвоения категорий''. Так же требуется настроить условия вывода ответа: использование кэша ответов, генерация и требуется ли кэширование формулировки (подробнее об этих настройках см. инструкцию по [[QAS. UPS руководство по работе с интерфейсом#Поиск ответа|QAS.Поиск ответа]]) и [[QAS. UPS руководство по работе с интерфейсом#Функционал вкладки «Шаблоны запросов»|выбрать шаблон запроса]]. <blockquote>'''Обратите внимание:''' если вам нужно изменить шаблон запроса для определенной категории, это делается путем добавления отдельного действия. Настройка этого действия аналогична основному, но с выбором нужного шаблона. В Условиях запуска указываете данные, которые запустят это действие с шаблоном-исключением. </blockquote>Второй вариант — QAS-чат. В этом случае ответы на вопросы будут поступать не из базы данных, а от встроенной модели LLM по умолчанию или из любой другой модели, которую [[QAS. Руководство администратора|добавит]] администратор.

- из внешнего источника — в этом случае можно подключить скрипты-интеграций для выполнения необходимых действий, если они есть,<blockquote>По клику правой клавишей мыши на поле «Фраза» появляется меню, где можно выбрать одно из действий:
# Добавить кнопку (подробнее см. раздел [[SES. UPS руководство по работе с интерфейсом#Добавление кнопок в действия|«Добавление кнопок в действия»]]).
# Перефразировать. Если нужно добавить вариации фразы. Предложенные фразы можно отредактировать или удалить, кликнув по иконке корзинки напротив нужной фразы.
# Удалить лишнюю фразу можно, кликнув на поле с этой фразой правой клавишей мыши и в появившемся меню выбрать «Удалить фразу». Можно кликнуть на иконку корзины, которая появится справа от фразы при наведении на нее курсора.</blockquote>

Для действий предусмотрены три опции: «Копировать», «Переместить» и «Удалить действие», соответственно порядку на картинке [[Файл:Для действий.png|безрамки|80x80пкс]]. Чтобы скопировать действие в другой канал, нажмите соответствующую кнопку и в открывшемся окне выберите нужный канал из списка. Если вы хотите переместить действие, выполните те же действия. Обратите внимание, что при перемещении действие будет удалено из исходного канала. Чтобы удалить действие, нажмите на кнопку в виде корзинки.

У всех действий, кроме Завершения диалога, есть две опции:

* Считать действие успешным прохождением точки — этот флаг устанавливается на действия, которые означают, что сервис выполнился.
* Прерываемое — этот флаг активируется для голосового канала и говорит о том, что допускается прерывание (перебивание) робота в момент синтеза ответа. Если он активен, робот будет реагировать на стоп-слова, в противном случае — нет.

[[Файл:2025-07-07 12-42-57.png|мини|''Рис. 18 Вкладка Действия и Условия присвоения категорий'']]
'''''Условия присвоения категорий'''.'' По клику на эту кнопку раскрывается меню (рис. 18), в котором есть выпадающий список со всеми категориями из [[QAS. UPS руководство по работе с интерфейсом|QAS]], а ниже область для настройки условий. Условие может включать в себя как один элемент данных, так и несколько, которые связаны между собой логическим выражением «И». Также возможно наличие нескольких условий, которые соединены логическим выражением «ИЛИ». ''Окно с условиями категорий или условиями запуска можно двигать как удобно, достаточно просто зажать левую клавишу мыши и перетащить как нужно.''<blockquote>На примере категории «Паспорт РФ» можно увидеть, что эту категорию мы присваиваем, если получаем элементы данных «Паспорт» и «Тип паспорта — РФ» (значение «РФ») или только элемент данных «Паспорт РФ». </blockquote>Флажок '''«Запрос в QAS с учетом прошлого контекста»''' указывает системе, что перед отправкой запроса в QAS необходимо проанализировать предыдущие сообщения пользователя. Это позволяет сохранять логику диалога и избегать необоснованной смены тематики.<blockquote>'''Пример работы'''

# Без включенной функции
#* Пользователь спрашивает: ''"Какие документы нужны для оформления СНИЛС?"'' → система направляет запрос в категорию СНИЛС.
#* Затем пользователь уточняет: ''"А сколько это стоит?"'' → система определяет метку Госпошлина и перенаправляет запрос в соответствующую категорию, теряя контекст СНИЛС.
# С включенной функцией
#* Если флажок активен (например, для категории ''Госпошлина''), система:
#** Проверяет предыдущие сообщения.
#** Если диалог начался в другой категории (например, СНИЛС), запросы объединяются (''"склеиваются"'').
#** Если контекст отсутствует, тематика меняется, но поиск ответа ведется сразу по обеим категориям (СНИЛС + Госпошлина).

'''Когда использовать'''

Активируйте эту настройку для категорий, которые могут:

* Быть частью более широкого запроса (например, ''Госпошлина'' как дополнение к ''СНИЛС'').
* Требовать сохранения контекста диалога.

</blockquote>В меню условий присвоения категорий есть повторяющиеся кнопки ''«Сохранить»'' и ''«Закрыть»'' (рис.18). '''Обратите внимание:''' при нажатии на кнопку «Сохранить» '''сохраняются''' не только текущие условия запуска, но и '''все настройки КТ'''. При нажатии на кнопку «Закрыть» '''без сохранения изменения теряются'''.

'''''Условия запуска'''.'' Для каждого действия есть возможность настроить свои условия запуска. Если нажать на кнопку «Условия запуска», откроется меню, в котором можно задать условия для выполнения действия. Этих условий может не быть, либо они могут быть представлены одним элементом данных, либо сочетанием нескольких элементов, связанных логическим оператором «И». Также можно указать несколько условий, объединённых логическим оператором «ИЛИ». Каждый элемент условия имеет один из типов:

''Переменные'' — служат для хранения данных, полученных из API или по каналам, запущенным извне. Например, это может быть ID пользователя в Telegram или CID из телефонного канала, то есть определившийся номер телефона.<blockquote>'''Переменные, как и данные, можно выбирать из выпадающего списка.''' Доступны все названия и значения, которые использовались ранее. Если вам нужно создать новую переменную и значение, просто введите их с клавиатуры. После этого они также будут предлагаться вам в дальнейшем.</blockquote>''Данные'' — элемент данных, полученный от моделей SMC или SEE.

[[Файл:Уведомление дублей.png|мини|''Рис. 18.1. Уведомление об одинаковых блоках ИЛИ в условиях запуска действий'']]
В меню условий запуска есть повторяющиеся кнопки ''«Сохранить»'' и ''«Закрыть»'' (рис.18)''.'' '''Обратите внимание:''' при нажатии на кнопку «Сохранить» '''сохраняются''' не только текущие условия запуска, но и '''все настройки КТ'''. При нажатии на кнопку «Закрыть» '''без сохранения изменения теряются'''.

Также при сохранении настроек в окне "Условий запуска" если были обнаружены одинаковые блоки условий "ИЛИ", то будет соответствующее оповещение с выделением повторяющихся блоков ''(Рис. 18.1)''.<blockquote>
'''Ситуация 1.'''

Например, если абонент хочет узнать статус своего заявления, робот может спросить: «Назовите код вашего заявления?». В ответ абонент может сказать, что не знает, где найти этот код.

Чтобы отработать такую ситуацию, в раздел «Действия» необходимо добавить справочную информацию о том, где можно найти код. Также следует добавить элемент данных, например «Не знаю код» (модель SEE). В таком случае, если получаем от модели «Не знаю код» тег, абоненту будет отдана информация о том, где он может посмотреть код и назвать его.

'''Ситуация 2.'''

Код для проверки статуса должен состоять из семи символов. Если абонент вводит или произносит меньшее или большее количество символов, можно настроить систему так, чтобы она выдавала ему соответствующее сообщение, например: «Обратите внимание, код должен включать семь цифр». Для этого необходимо настроить следующее условие:

1. Определить элемент данных, который отвечает за отслеживание цифр (код). В нашем случае это модель SEE number и элемент данных «Код заявления».

2. Настроить условие, согласно которому при ответе пользователя будет сравниваться длина ответа с заданными параметрами: больше или меньше нужного вам значения, например, 7.

В этом случае, если абонент введёт код, содержащий меньше или больше 7 символов, ему будет выдано сообщение о том, что код заявления введён неправильно.</blockquote>

'''При необходимости вы можете менять порядок действий, просто удерживая левую кнопку мыши и перемещая их в нужное место.'''

[[Файл:2025-03-28 15-05-06.png|мини|''Рис. 19 Настройка условий входа по бездействию'']]

===== Вход в конечную точку «по бездействию». =====
Чтобы настроить вход в конечную точку по бездействию нужно выбрать в меню Вход опцию "по бездействию" (см. рис. 19). Интерфейс КТ по бездействию отличается от КТ, у которой вход по условиям. Тут присутствуют три вкладки:

# Вход
# Сбор информации
# Действия.

'''Вход.''' На этой вкладке необходимо заполнить:

* ''Название'' конечной точки,
* ''Тип КТ'': отчетный, сервисный, передача или завершение диалога.

<blockquote>'''«Отчетный»''' — эта та, которая участвует в статистике, т.е. несет какую-то полезную для анализа информационную нагрузку.

'''«Сервисный»''' — это такие конечные точки, как «приветствие» и другие, которые служат для поддержания диалога.

'''«Передача диалога»''' — точки, отвечающие за переключение звонка или передачу разговора операторам.

'''«Завершение диалога»''' — конечная точка, которая ставит точку в общении с пользователем.</blockquote>

* Выбрать ''канал связи'', по умолчанию default,
* А так же ''время'' бездействия пользователя, для вода в КТ.

Далее выбирается действие. Напоминаем, что '''действия''' для этого типа события могут быть 4 видов:

- сказать,

- завершить диалог,

- отправить файл,

- передача диалога.

Действие ''Сказать'' тоже разделяется на 4 типа:

- последовательно — это означает, что робот будет задавать вопросы и выдавать информацию по порядку, в соответствии с тем, что будет записано в полях «Фразы»,

- случайная фраза — вы получите любую фразу из имеющегося списка.

- из внутреннего источника — в этом случае выполняется консультация из [[QAS. UPS руководство по работе с интерфейсом|QAS]] (системы ответов на вопросы) после настройки ''условий присвоения категорий''. Так же требуется настроить условия вывода ответа: использование кэша ответов, генерация и требуется ли кэширование формулировки (подробнее об этих настройках см. инструкцию по [[QAS. UPS руководство по работе с интерфейсом#%D0%9F%D0%BE%D0%B8%D1%81%D0%BA %D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0|QAS.Поиск ответа]]) и [[QAS. UPS руководство по работе с интерфейсом#%D0%A4%D1%83%D0%BD%D0%BA%D1%86%D0%B8%D0%BE%D0%BD%D0%B0%D0%BB%20%D0%B2%D0%BA%D0%BB%D0%B0%D0%B4%D0%BA%D0%B8%20%C2%AB%D0%A8%D0%B0%D0%B1%D0%BB%D0%BE%D0%BD%D1%8B%20%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%BE%D0%B2%C2%BB|выбрать шаблон запроса]].<blockquote>'''Обратите внимание:''' если вам нужно изменить шаблон запроса для определенной категории, это делается путем добавления отдельного действия. Настройка этого действия аналогична основному, но с выбором нужного шаблона. В Условиях запуска указываете данные, которые запустят это действие с шаблоном-исключением. </blockquote>Второй вариант — QAS-чат. В этом случае ответы на вопросы будут поступать не из базы данных, а от встроенной модели LLM по умолчанию или из любой другой модели, которую [[QAS. Руководство администратора|добавит]] администратор.

- из внешнего источника — в этом случае можно подключить скрипты-интеграций для выполнения необходимых действий, если они есть,<blockquote>По клику правой клавишей мыши на поле «Фраза» появляется меню, где можно выбрать одно из действий:
# Добавить кнопку (подробнее см. раздел [[SES. UPS руководство по работе с интерфейсом#Добавление кнопок в действия|«Добавление кнопок в действия»]]).
# Перефразировать. Если нужно добавить вариации фразы. Предложенные фразы можно отредактировать или удалить, кликнув по иконке корзинки напротив нужной фразы.
# Удалить лишнюю фразу можно, кликнув на поле с этой фразой правой клавишей мыши и в появившемся меню выбрать «Удалить фразу». Можно кликнуть на иконку корзины, которая появится справа от фразы при наведении на нее курсора.</blockquote>
Для действий предусмотрены три опции: «Копировать», «Переместить» и «Удалить действие», соответственно порядку на картинке [[Файл:Для действий.png|безрамки|80x80пкс]]. Чтобы скопировать действие в другой канал, нажмите соответствующую кнопку и в открывшемся окне выберите нужный канал из списка. Если вы хотите переместить действие, выполните те же действия. Обратите внимание, что при перемещении действие будет удалено из исходного канала. Чтобы удалить действие, нажмите на кнопку в виде корзинки.

У всех действий, кроме Завершения диалога, есть две опции:

* Считать действие успешным прохождением точки — этот флаг устанавливается на действия, которые означают, что сервис выполнился.
* Прерываемое — этот флаг активируется для голосового канала и говорит о том, что допускается прерывание (перебивание) робота в момент синтеза ответа. Если он активен, робот будет реагировать на стоп-слова, в противном случае — нет.

[[Файл:2025-05-28 16-43-00.png|мини|''Рис. 20 Вкладка сбор информации'']]
'''Сбор информации.''' Нужно указать ''все'' случаи (данные и их комбинации), ''при которых точка сработает'' (рис. 20). В окне «Сбор информации» элементы данных и комбинации разделяются логическим оператором «ИЛИ». В случае с комбинациями условий ЭД отделяются друг от друга логическим «И». Условия можно редактировать: добавлять и удалять. Чтобы добавить новое условие «И», необходимо нажать на кнопку «Добавить условие» [[Файл:Добавить условие.png|безрамки|20x20пкс]]. Окно можно двигать как удобно, достаточно просто зажать левую клавишу мыши и перетащить как нужно.

В сборе информации параметр «Тип», принимающий два значения: данные или переменная.
Параметр ''«Искать»'' имеет три варианта:

* ''Во всем диалоге''. Если выбрали эту опцию, то система будет искать этот ЭД во всем диалоге. Например, если спрашиваем у абонента имя или номер телефона, то сохраняем эти данные навсегда и больше не переспрашиваем.
* ''В текущей точке''. Поиск данных (ЭД) будет происходить с момента входа в КТ и до выхода из этой КТ или повторного входа в нее, но уже с новыми условиями. Например, для случаев с КТ Консультация или любой другой КТ, множеством условий входа.
* ''В последнем сообщении''. Система будет учитывать только последнее сообщение абонента, игнорируя предыдущие.
Далее идет поле «Название», где из выпадающего списка требуется выбрать нужный элемент данных. Справа от поля «Название» из выпадающего списка можно выбрать один из операторов:

* Существует — это любое значение этого элемента данных, то есть важно просто наличие этого элемента данных,
* != — не равно,
* = — равно,
* < — меньше,
* > — больше,
* <= — меньше или равно,
* => — больше или равно,
* Длина равна — длина ответа абонента равна определенному значению, которое указывается в поле «Значение». Например, когда абонент вводит код для проверки статуса заявления, который должен быть равен 7 знакам,
* Длина меньше — длина ответа абонента меньше определенного значения, указанного в поле «Значение»,
* Длина больше — длина ответа абонента больше определенного значения, указанного в поле «Значение».[[Файл:2025-05-28 16-44-11.png|мини|''Рис. 21 Интерфейс вкладки Действия'']]

'''Действия.''' Далее необходимо выбрать конечное действие на выходе из КТ. Напоминаем, что действия могут быть 4 видов:

- сказать,

- завершить диалог,

- отправить файл,

- передача диалога.

Действие ''Сказать'' тоже разделяется на 4 типа:

- последовательно — это означает, что робот будет задавать вопросы и выдавать информацию по порядку, в соответствии с тем, что будет записано в полях «Фразы»,

- случайная фраза — вы получите любую фразу из имеющегося списка.<blockquote>По клику правой клавишей мыши на поле «Фраза» появляется меню, где можно выбрать одно из действий:
# Добавить кнопку (подробнее см. раздел [[SES. UPS руководство по работе с интерфейсом#Добавление кнопок в действия|«Добавление кнопок в действия»]]).
# Перефразировать. Если нужно добавить вариации фразы. Предложенные фразы можно отредактировать или удалить, кликнув по иконке корзинки напротив нужной фразы.
# Удалить лишнюю фразу можно, кликнув на поле с этой фразой правой клавишей мыши и в появившемся меню выбрать «Удалить фразу». Можно кликнуть на иконку корзины, которая появится справа от фразы при наведении на нее курсора.</blockquote>

- из внутреннего источника — в этом случае выполняется консультация из [[QAS. UPS руководство по работе с интерфейсом|QAS]] (системы ответов на вопросы) после настройки ''условий присвоения категорий''. Так же требуется настроить условия вывода ответа: использование кэша ответов, генерация и требуется ли кэширование формулировки (подробнее об этих настройках см. инструкцию по [[QAS. UPS руководство по работе с интерфейсом#Поиск ответа|QAS.Поиск ответа]]). Второй вариант — QAS-чат. В этом случае ответы на вопросы будут поступать не из базы данных, а от встроенной модели LLM по умолчанию или из любой другой модели, которую [[QAS. Руководство администратора|добавит]] администратор.

- из внешнего источника — в этом случае можно подключить скрипты-интеграций для выполнения необходимых действий, если они есть,

Удалить лишнюю фразу можно, кликнув на поле с этой фразой правой клавишей мыши и в появившемся меню выбрать «Удалить фразу».

У всех действий, кроме Завершения диалога, есть две опции:

* Считать действие успешным прохождением точки — этот флаг устанавливается на действия, которые означают, что сервис выполнился.
* Прерываемое — этот флаг активируется для голосового канала и говорит о том, что допускается прерывание (перебивание) робота в момент синтеза ответа. Если он активен, робот будет реагировать на стоп-слова, в противном случае — нет.

'''''Условия присвоения категорий'''.'' По клику на эту кнопку раскрывается меню, в котором есть выпадающий список со всеми категориями из [[QAS. UPS руководство по работе с интерфейсом|QAS]], а ниже область для настройки условий. Условие может включать в себя как один элемент данных, так и несколько, которые связаны между собой логическим выражением «И». Также возможно наличие нескольких условий, которые соединены логическим выражением «ИЛИ». ''Окно с условиями категорий или условиями запуска можно двигать как удобно, достаточно просто зажать левую клавишу мыши и перетащить как нужно.''<blockquote>На примере категории «Паспорт РФ» можно увидеть, что эту категорию мы присваиваем, если получаем элементы данных «Паспорт» и «Тип паспорта — РФ» (значение «РФ») или только элемент данных «Паспорт РФ». </blockquote>
Флажок '''«Запрос в QAS с учетом прошлого контекста»''' указывает системе, что перед отправкой запроса в QAS необходимо проанализировать предыдущие сообщения пользователя. Это позволяет сохранять логику диалога и избегать необоснованной смены тематики.<blockquote>'''Пример работы'''

# Без включенной функции
#* Пользователь спрашивает: ''"Какие документы нужны для оформления СНИЛС?"'' → система направляет запрос в категорию СНИЛС.
#* Затем пользователь уточняет: ''"А сколько это стоит?"'' → система определяет метку Госпошлина и перенаправляет запрос в соответствующую категорию, теряя контекст СНИЛС.
# С включенной функцией
#* Если флажок активен (например, для категории ''Госпошлина''), система:
#** Проверяет предыдущие сообщения.
#** Если диалог начался в другой категории (например, СНИЛС), запросы объединяются (''"склеиваются"'').
#** Если контекст отсутствует, тематика меняется, но поиск ответа ведется сразу по обеим категориям (СНИЛС + Госпошлина).

'''Когда использовать'''

Активируйте эту настройку для категорий, которые могут:

* Быть частью более широкого запроса (например, ''Госпошлина'' как дополнение к ''СНИЛС'').
* Требовать сохранения контекста диалога.
</blockquote>

В меню условий присвоения категорий есть повторяющиеся кнопки ''«Сохранить»'' и ''«Закрыть»''. '''Обратите внимание:''' при нажатии на кнопку «Сохранить» '''сохраняются''' не только текущие условия запуска, но и '''все настройки КТ'''. При нажатии на кнопку «Закрыть» '''без сохранения изменения теряются'''.

Для действий предусмотрены три опции: «Копировать», «Переместить» и «Удалить действие», соответственно порядку на картинке [[Файл:Для действий.png|безрамки|80x80пкс]]. Чтобы скопировать действие в другой канал, нажмите соответствующую кнопку и в открывшемся окне выберите нужный канал из списка. Если вы хотите переместить действие, выполните те же действия. Обратите внимание, что при перемещении действие будет удалено из исходного канала. Чтобы удалить действие, нажмите на кнопку в виде корзинки.

Также можно настроить '''условия запуска''' для действий (рис. 21). Это условия, при которых действие будет выполняться (этих условий может не быть). Такой подход удобен, когда к одной и той же конечной точке есть разные действия в зависимости от поступающих данных или переменных.
<blockquote>Например, в зависимости от номера телефона, пользователи могут попадать в разные контактные центры. Или, как в случае с оценкой качества на рисунке 19, в зависимости от полученной оценки, они могут слышать разные благодарственные фразы.</blockquote>В меню условий запуска есть повторяющиеся кнопки ''«Сохранить»'' и ''«Закрыть»'' (рис.18). '''Обратите внимание:''' при нажатии на кнопку «Сохранить» '''сохраняются''' не только текущие условия запуска, но и '''все настройки КТ'''. При нажатии на кнопку «Закрыть» '''без сохранения изменения теряются'''.
'''При необходимости вы можете менять порядок действий, просто удерживая левую кнопку мыши и перемещая их в нужное место.'''

===== Вход в конечную точку «По ручному запуску». =====
Чтобы настроить вход в конечную точку нужно выбрать в меню Вход опцию "По ручному запуску" (см. рис. 19). Интерфейс КТ по ручному запуску идентичен КТ со входом "По бездействию", за исключением поля "Время".

Если в карточку КТ были внесены изменения, закрыть её можно только после того, как вы сохраните эти изменения и кликните на любую область за пределами карточки, или принудительно закрыть её, нажав на кнопку «Закрыть» (без сохранения внесенных изменений). Если открыли карточку просто для просмотра, то закрывается по клику вне карточки или по кнопке «Закрыть»

=== Тестирование робота ===
[[Файл:Окно чата.png|мини|293x293пкс|''Рис. 22 Окно чата для тестирования робота'']]
В интерфейсе SES есть чат с отладчиком (рис. 22), где вы можете протестировать работу сценарной машины. Чтобы открыть чат-отладчик, нажмите на значок [[Файл:Чат.png|безрамки|20x20px]] в правом нижнем углу рабочей области. В самом верху располагается выпадающий список с каналами связи. Справа от списка — кнопка '''«Перезапустить сессию»''' [[Файл:Обновить данные вопроса.png|безрамки|20x20px]], которая сбрасывает всю переписку и данные отладчика. А слева — кнопка '''«Данные сессии»''' [[Файл:Кнопка отладчик без полей.png|безрамки|20x20px]], предоставляет возможность в режиме отладки увидеть все данные, полученные от моделей. В окне отладчика есть параметр qas, где отображается запрос, который отправился в QAS и не только, подробнее см. раздел [[SES. UPS руководство по работе с интерфейсом#Данные сессии|Данные сессии]]. И кнопка '''«Тестирование скрипта»''' [[Файл:Пробирки.png|безрамки|20x20пкс]], подробнее [[SES. UPS руководство по работе с интерфейсом#Тестирование скрипта|тут]]. Есть возможность отправлять в чат файлы нажав на [[Файл:Скрепка.png|безрамки|20x20пкс]] и выбрав файл (в любом формате).

==== Тестирование в текстовых каналах ====

===== Данные сессии =====
Раскрыв данные сессии можете увидеть, все данные о текущем диалоге с роботом. Разберем по порядку, ниже представлены некоторые данные из ключа root, они нужны не все, разберем только нужные:<blockquote>
"started":"2025-06-10 09:46:05" — ''время начала сессии''

"modified":"2025-06-10 09:49:08" — ''когда произошли изменения последние (пришел запрос/изменилась тематика)''
"robot":"ffeaa99a-13d2-4bff-b458-1231c884f8ee" — ''id робота, у продовой версии будет приписка _prod''

"session":"beefb6a2-dc08-47d4-9e02-2495329173ec" — ''id сессии''

"channel":"default" — ''активный канал, в котором происходит тестирование''

"connector":"web"

"unknown":false.
</blockquote>[[Файл:2025-06-10 12-46-08.png|мини|''Рис. 23.1 Пример работы с отладчиком'']]Далее идет самая интересная для аналитиков часть - <code>"current"</code> . Раскрыв этот ключ можно посмотреть в какую конечную точку привёл сценарий, и была ли запросу присвоена какая-либо категория. А так же параметр ''data'', раскрыв который можно увидеть все классы (рис. 23.1 и 23.2), которые пришли от модели [[SMC. UPS руководство по работе с интерфейсом|SMC]] и/или модели [[SEE. UPS руководство по работе с интерфейсом|SEE]] и их достоверность и вес. Раскрыв в ''data'' параметр ''reply -'' увидеть данные ответа от робота. Имея все эти данные можно отладить работу сценария. [[Файл:2025-06-10 12-47-07.png|мини|''Рис. 23.2 Работа с отладчиком. Просмотр параметра data'']]<blockquote>"current":{

"id":"Консультация ЧаВО" — конечная точка, в которую привел сценарий,

"qas":"оформить снилс" — запрос, который отправился в QAS.

}<blockquote>'''Обратите внимание:''' если параметр QAS в отладчике пустой, это значит, что ваш запрос не был передан в QAS. Если же в этом параметре отображается ваш запрос, но робот просит вас перефразировать его, то, вероятно, в базе данных не хватает формулировки с ответом или на ответе отсутствует пометка «проверено». Это может происходить, когда в настройках КТ, отвечающей за консультирование из базы данных QAS, установлен параметр «Использовать кэш ответов» в режиме «Только проверенные ответы». </blockquote>'''Отработка склеек и удержания контекста''': в QAS летит вообще вся история сообщений в рамках одного контекста общения '''через разделитель «|»'''. Модель генерации будет отвечать на последний вопрос в цепочке с учетом ранее написанных сообщений в этом контексте.

"answered":true — был ли ответ true/false
"category":[0:"МФЦ НСО СНИЛС"] — отображается список категорий, в которые попал вопрос (их может быть больше одной).

"nearest":NULL

''Следующий кусок ключа current проще объяснить на примере запроса "оформить паспорт":''

"entry":"entry":[0:"Паспорт, вес 3" ] — зашли в КТ по метке «Паспорт», запросили тип паспорта (загран), старый/новый образец и дошли до возраста получателя:

"missingRunData":[

0:"Возраст заявителя для заграна, вес 3"] — тут отображаются ЭД, которые нужны для «пропуска» дальше в действия.

"passedRunData":[ ] — этот параметр определяет, какие данные использовать для подмены сообщения на тэг от модели. Подробнее [[SES. UPS руководство по работе с интерфейсом#Добавление и настройка элементов данных|тут]], описание флага «Подставлять ответ модели в сообщение».

"waitingRunData":

"Возраст заявителя для заграна, вес 3" — отображается ЭД, который запросили и ждем получения.

"border":0 — отражает границу, от которой система смотрит на данные. Например, при border:1 - система будет смотреть от 2-го ЭД в списке data и ниже. При border:0 - с первого.

"preborder":0

}</blockquote><blockquote>"models":[...] — раскрыв список, можно посмотреть все модели, которые отработали за сессию.

"scripts":[] — отображает список скриптов, которые отработали за сессию.

"data":[...] — раскрыв data, можно увидеть параметр "message" — фраза-сообщение пользователя. И под каждым message, есть своя data, где находятся все метки и все тэги, пришедшие от моделей SMC и SEE на эту фразу.

"timers":[...]

"variables":{} — тут отображаются пришедшие переменные, если есть.

"error":"" — выводит ошибку при отработке скрипта.

"events":{ — параметр отображает счетчики событий за сессию (не найдено/нет данных/тишина).

"not found":{...}

"no data":{...}

"silence":{...}

}</blockquote>

[[Файл:2025-06-10 16-15-43.png|мини|''Рис. 24 Окно автотестирования скриптов'']]

===== Тестирование скриптом =====
[[Файл:2025-06-10 16-22-59.png|мини|''Рис. 25 Добавление скрипта для тестирования'']]
[[Файл:Тестирование скриптов.png|мини|''Рис. 26 Интерфейс окна «Тестирование скриптов»'']]
Теперь вы можете автоматически тестировать робота с помощью скриптов. Например, если у вас возникли сложности с маршрутизацией и нет желания каждый раз вручную воспроизводить весь диалог при отладке сценария, вы можете сохранить его для последующего тестирования. Для этого кликните на кнопку [[Файл:Пробирки.png|безрамки|20x20пкс]] справа от чата появится окно. Добавить скрипт можно путем '''''импорта из файла''''' [[Файл:Импорт нов.png|безрамки|20x20пкс]], если есть данные '''в формате txt''' или '''''импортировать диалог''''' из текущей сессии. Нажмите на иконку импорта или выберите ''«Скрипт»'' в выпадающем меню и нажмите '''''«Добавить скрипт»''''' (рис. 25). Появится диалоговое окно «''Добавление скрипта»''. Введите название скрипта, выберите файл и нажмите ''«Добавить»''. Если у вас уже открыта сессия, отметьте в окне добавления скрипта опцию '''''«Импорт из чата»'''.'' Если у вас несколько скриптов, переключаться между ними можно через выпадающий список ''«Скрипт».''

Правее него находятся иконки ''импорт'' [[Файл:Импорт нов.png|безрамки|20x20пкс]], ''экспорт'' [[Файл:Экспорт нов.png|безрамки|20x20пкс]] и ''удалить'' [[Файл:Удаление документа.png|безрамки|20x20пкс]]. Импорт был описан ранее. '''''Экспорт''''' позволяет выгрузить скрипт в формате txt. Кнопка '''''удалить''''' - удаляет весь скрипт.

Файл для импорта и экспорта - это простой текстовый файл, в котором все запросы к роботу, каждый с новой строки.

Галочки обозначают точки останова (рис. 26). Когда они стоят, автотест останавливается и ждет, пока вы нажмете кнопку «Дальше». параллельно можно открыть отладчик и смотреть, что происходит на каждом этапе теста.

У тестирования есть два основных режима:

# Полный тест:
#* Все галочки сняты
#* Тест выполняется автоматически от начала до конца, без остановок
# Пошаговый режим:
#* Тест останавливается на каждом шаге
#* Для продолжения нужно нажимать "Дальше"

Если вы не поставили ни одной галочки (режим «полный тест»), а затем поставили хотя бы одну, тест переключится в пошаговый режим. При этом переключатель автоматически переключится в «пошаговый режим», но все галочки он не поставит. Это просто оповещение о том, что тест неполный.

Чтобы начать тестирование, сначала сбросьте текущую сессию, если она активна, и нажмите кнопку «Тест». Если выбран «Полный тест», он запустится автоматически. Для «Пошагового» теста нужно будет последовательно нажимать «Дальше». После того как тест завершится или вам нужно прервать его в любой момент (это относится к «пошаговым тестам»), нажмите кнопку «Остановить». После этого тестирование можно запустить еще раз. Внутри одной сессии нельзя запустить тестирование, скрипт тестирования ограницен сохраненными формулировками. Но можно продолжать диалог, в этой же сессии, с роботом после тестирования.

Последняя отправленная фраза будет выделена голубым цветом.

==== Тестирование голосовыми сообщениями и в голосовом канале ====
[[Файл:2025-06-10 12-44-58.png|мини|''Рис. 27 Тестирование робота с помощью микрофона.'']]
Робота можно протестировать, задавая вопросы голосом и/или вводя переменные. Например, можно проверить, как робот отправляет в разные конечные точки, получая одинаковые метки от SMC и номера телефонов различных ведомств. Например, метка «Мобилизация» от SMC в сочетании с номером телефона МФЦ приводит в КТ Консультация ЧаВО, а «Мобилизация» и номер единого контактного центра (ЕКЦ) — в КТ Перевод на оператора. Чтобы провести тестирование робота с переменными раскройте меню, кликнув на стрелочку над полем «Напишите вопрос» (рис. 22) и заполните поля:

- Переменная: введите название переменной.

- Значение: укажите значение этой переменной..
[[Файл:Photo 2025-03-07 15-40-57.jpg|мини|''Рис. 28 Иллюстрация тестирования канала voice.'']]
В этом же меню вы можете настроить параметры аудиоответов и автовоспроизведения.

Если вы активируете опцию «Аудиоответы», то будете получать от робота голосовые ответы. В противном случае ответы будут в текстовом формате.

Отметка «Автовоспроизведение» позволит автоматически воспроизводить голосовой ответ робота.

Чтобы протестировать робота '''с помощью голосовых сообщений''', нужно нажать и удерживать кнопку [[Файл:Микрофон 1.png|безрамки|20x20пкс]]. Для работы этой кнопки необходим доступ к UPS через протокол HTTPS. Вы можете настроить такой доступ, используя любой веб-сервер, например, nginx или apache. В случае, если нет галочки «Аудиоответы», то бот будет отвечать текстом (рис. 27).

В дебаггере есть функция, позволяющая протестировать '''голосовой канал - voice''' (рис. 27), то есть ''имитировать звонок''. Чтобы запустить процесс, достаточно нажать на кнопку «Начать разговор» [[Файл:Начать разговор.png|безрамки|20x20пкс]] . Пока разговор активен, кнопка изменится на «Закончить разговор» [[Файл:Закончить разговор.png|безрамки|20x20пкс]] . Переменные задаются в меню, как и в текстовом канале. Для этого нажмите на стрелочку над полем ввода запроса (рис. 22).

=== Архив диалогов ===
[[Файл:Архив диалогов нов.png|мини|''Рис. 29 Интерфейс архива диалогов'']]
После тестирования робота в любом канале можно заглянуть в Архив диалогов (рис. 27), чтобы изучить данные сессии. Для этого необходимо кликнуть на одноименную кнопку на панели инструментов рядом с кнопками версий робота [[Файл:Архив диалогов.png|безрамки|20x20пкс]]. Интерфейс архива содержит:

* Список доступных роботов слева на экране.
* Блок с фильтрацией диалогов.
* До момента пока вы не выберете диалог из списка справа будет пустой блок с текстом «Выберете диалог». После того как диалог выбран вы увидите отображение аналогичное рисунку 29.
* Информационные вкладки (см. в разделе [[SES. UPS руководство по работе с интерфейсом#Настройка робота|«Настройка робота»]]).

==== Работа с архивом диалога ====
Архив диалогов поддерживает версионность робота, то есть можно просмотреть диалоги одной из трех версий: черновик, прод или архивной. Для этого кликните по кнопке с нужной версией находясь уже в Архиве либо предварительно выбрав ее и перейдя в архив. Диалоги в архиве фильтруются по дате и времени, для этого кликните на иконку календаря [[Файл:Календарик с фоном.jpg|безрамки|20x20пкс]] в поле «Начало» и «Конец», чтобы выбрать дату. И время, кликнув на иконку часов ''(по умолчанию дата и время выставляются за текущие сутки)''. Выберите нужную дату и время, добавьте необходимые фильтры. Также можно отфильтровать звонки по:

# каналам связи:
* default,
* telegram,
* web,
* voice,
* vkontakte.
2. элементам данных — при нажатии на это поле открывается перечень всех элементов данных из сценария текущего робота.

3. номеру телефона,

4. ID диалога, берется из отладчика - значение атрибута session,

5. по названию и значению переменной,

3. либо тексту, либо ключевым словам, которые могут быть в искомом диалоге.

После настройки система, по нажатию кнопки «Поиск», отобразит все диалоги с роботом, учитывая выбранные фильтры (рис. 29). На самом верху над диалогом можно просмотреть его ID. В архиве диалоги сгруппированы по принципу «запрос от пользователя — ответ робота». При выборе каждой пары открывается отладчик, где можно увидеть метки и теги, полученные от моделей, копия [[SES. UPS руководство по работе с интерфейсом#Тестирование робота|отладчика]] из тестирования робота. Этот отладчик аналогичен тому, что используется в сценарной машине. Для голосового канала есть возможность прослушивания аудио диалога помимо текстового просмотра. Также есть возможность импортировать запросы диалога в скрипт тестирования в чат-отладчик по кнопке '''"Добавить в скрипт тестирования"''' снизу диалога.

Чтобы '''выйти из Архива диалогов''' в сценарий нужно снова кликнуть на иконку [[Файл:Архив диалогов.png|безрамки|20x20пкс]].

=== Пользовательские справочники ===
[[Файл:Photo 2025-05-14 17-30-31.jpg|мини|''Рис. 30 Добавление пользовательского справочника'']]

Для доступа к справочнику нажмите на значок «Пользовательский справочник» [[Файл:Справочник (1).png|безрамки|20x20пкс]] на панели инструментов справа от архива диалогов. Чтобы создать новый справочник, нажмите кнопку '''«Добавить справочник»''' (рис. 26). В открывшемся окне заполните обязательные поля: название справочника и его структуру — наименования колонок. При необходимости задайте значения по умолчанию для каждой колонки. Эти значения будут автоматически заполнять новые строки. Затем нажмите '''«Добавить»'''.

Если значения по умолчанию не указаны, справочник будет пустым. Заполнять таблицу можно вручную.

Справочники можно переименовывать и удалять. Чтобы переименовать или удалить справочник, наведите курсор на его название. Появится две иконки: карандаш для переименования и корзинка для удаления. <blockquote>'''Перед переименованием справочника ''обязательно'' сохраните внесенные изменения, иначе они будут удалены.'''</blockquote>[[Файл:2025-05-20 14-45-35.png|мини|''Рис. 31 Удаление записей из пользовательского словаря'']]
При нажатии на карандаш откроется окно '''«Редактирование структуры».''' Важно помнить: изменения можно внести только в название справочника или в значения по умолчанию (если предыдущие значения были, они будут автоматически обновлены). ''Переименовать столбцы нельзя.'' После сохранения изменений нажмите кнопку '''«Сохранить»''', расположенную внизу под таблицей (рис. 31). <blockquote>'''Внимание! Справочники зависят от версии робота.''' Если вы вносите изменения в структуру справочника в черновой версии [[Файл:Черновик.png|безрамки|20x20пкс]], то для применения этих изменений в продовой версии нужно применить робота в прод.

'''Важно:''' переносится '''только структура справочника'''. Данные не дублируются. Их можно перенести вручную, экспортировав [[Файл:Экспорт нов.png|безрамки|20x20пкс]] из черновика и импортировав [[Файл:Импорт нов.png|безрамки|20x20пкс]] в прод. </blockquote>Вы можете фильтровать записи по содержанию любой колонки. Выделите галочками несколько записей сразу и удалите их. В правом нижнем углу появится иконка корзины, как только вы выберете хотя бы одну запись (рис. 27).

Справочники можно ''экспортировать'' и ''импортировать''. Экспорт и импорт осуществляются в формате JSON.
[[Файл:Снимок экрана 2025-07-16 175752.png|мини|''Рис. 32 Импорт пользовательского словаря'']]

''При импорте структуры импортируемого файла и справочника в интерфейсе должны совпадать''. Если они не совпадают, то заполнятся только совпадающие поля. Есть возможность ''импорта'' с дополнением новых данных, либо полной заменой (''Рис. 32''). Структура экспорта:<blockquote>
[

{"колонка1":"значение 1","колонка2":"значение 2","колонка3":"значение 3","id":"58845671-1150-4ae2-9c46-e8aeb2553c57"},

{"колонка1":"значение 2","колонка2":"значение 2","колонка3":"значение 3","id":"2e0a7f8e-6d64-4df9-a3ce-5862f8eb441c"}

]
</blockquote>Структура json-файла для импорта:<blockquote>[

{"колонка1":"значение 4","колонка2":"значение 5","колонка3":"значение 6"},

{"колонка1":"значение 2","колонка2":"значение 3","колонка3":""}

]

При импорте не обязательно указывать id.</blockquote>Чтобы '''выйти из Пользовательских справочников''' в сценарий нужно снова кликнуть на иконку [[Файл:Справочник (1).png|безрамки|20x20пкс]].

=== Панель управления SES ===
Панель управления SES включает в себя 8 кнопок: импорт, экспорт, обнуление черновика рабочей версией, применение робота, восстановление робота, применение настроек робота, массовая замена моделей в элементах данных и меню пользователя.

{| class="wikitable"
|+''Табл. 2 Описание функционала панели управления.''
!'''Иконка кнопки'''
!'''Название иконки'''
!'''Описание'''
|-
|[[Файл:Export.png|центр|безрамки|40x40пкс]]
|Экспорт
|Экспорт робота в .zip архив со всеми настройками, включая элементы данных, конечные точки, скрипты и структуры пользовательских справочников ''(но не включая сам справочник)''.
|-
|[[Файл:ImportRobot.png|центр|безрамки|40x40пкс]]
|Импорт
|Импорт .zip архива робота в систему ''(кнопка активна только в версии черновика)''.|Импорт .zip архива робота в систему ''(кнопка активна только в версии черновика)''.
|-
|[[Файл:Стрелка.png|безрамки|40x40px|центр]]
|Обнулить черновик рабочей версией
|Эта функция позволяет заменить черновик рабочей версией. Она копирует текущую рабочую версию и сохраняет её как черновик, при этом сама рабочая версия остаётся без изменений ''(кнопка активна только в версии черновика)''.
|-
|[[Файл:Применить.png|безрамки|40x40px|центр]]
|Применить
|По нажатию на эту кнопку черновая версия робота становится рабочей ''(кнопка активна только в версии черновика)''.
|-
|[[Файл:Откат.png|центр|безрамки|40x40px]]
|Восстановить
|С помощью этой функции можно восстановить версию из архивной. При этом текущая рабочая версия становится архивной ''(кнопка активна только в архивной версии)''.
|-
|[[Файл:Разетка.png|центр|безрамки|40x40px]]
|Применить настройки робота
|Применяет сохранённые настройки робота и начинает работать в соответствии с ними, что аналогично перезагрузке программного обеспечения, но без необходимости самой перезагрузки.
После нажатия на кнопку система переносит эти настройки в настройки прода, но НЕ ПРИМЕНЯЕТ, на случай, если ошиблись.

Робот в любой версии начинает работать с новыми настройками только после нажатия на кнопку. Если вы нажали на кнопку, находясь в черновике, будут применены настройки черновика. Если же вы нажали на кнопку, работая в рабочей версии, то будут применены настройки рабочей версии, которые вы только что перенесли из черновика. <blockquote>Обратите внимание: после внесения каких-либо изменений кнопка будет красной [[Файл:Красная вилка (1).png|безрамки|20x20пкс]] и пульсировать, напоминая о необходимости применить настройки. </blockquote>
|-
|[[Файл:Смена моделей.png|центр|безрамки|40x40пкс]]
|Массовая замена моделей в элементах данных
|[[Файл:Замена моделей в ЭД.png|мини|''Рис. 33. Массовая замена моделей в элементах данных'']]Эта функция позволяет массово менять модели в элементах данных. После нажатия на кнопку появляется форма ''(Рис. 33)'', в которой необходимо указать тип элемента данных ''(Класс / Сущность)''. Затем в поле '''"Заменяемая модель"''' выбрать модель из списка моделей, используемых в уже существующих элементах данных ''(снизу будет указано количество элементов данных, использующих выбранную модель)'', и в поле '''"Заменяющая модель"''' выбрать доступную модель для замены. После нажатия на кнопку '''"Заменить"''' будет произведена замена выбранной модели в тех элементах данных, в которых она используется.
|-
|[[Файл:Меню пользователя new.png|безрамки|40x40px|центр]]
|Меню пользователя
|Отображает меню пользователя (имя, версия системы, смена пароля, убрать/показать фон, выход из системы), а также возможность переключить ''отображение рабочей области с табличного на облачный вид и наоборот''.
|}

=== Совместное использование ===
В Сценарной машине может работать несколько пользователей одновременно, но только если они работают с разными элементами данных и конечными точками. В противном случае будут сохранены только последние изменения, внесённые одним из пользователей.

UPS. Описание API

2025-07-18T10:22:13Z

Ka.shapovalov:

===== '''Описание часто используемых параметров''' =====
{| 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''' =====

{| 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, автоматическое определение количества
* '''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''' =====
{| class="wikitable" style="width: 110%"
|+
!style="color:blue;width: 15%" |'''GETsmc/classify/{model}'''
! colspan="3" style="width: 85%" |Классификация текстовой фразы. В случае если модель была создана из меток, в ответе groups и nearest будут пустыми, а ответ будет построен без учета confidenceThreshold из запроса.
В ответе:

* classes — список, для каждого класса которого отображается название класса, к которому был отнесен текст, и вероятность его принадлежности к этому классу.
* groups — название группы и число совпавших классов. Если метки совпадают с несколькими группами, они отображаются в порядке убывания числа совпавших классов (т. е. чем полнее группа, тем выше ее позиция в списке).
* nearest — отображаются группы, до которых не хватает всего одной метки, с указанием процента заполненности и сортировкой по убыванию этого процента.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
*'''text''' - текст, подлежащий классификации
*'''correction''' - уровень коррекции ошибок, от 0 до 3, по умолчанию 0
*'''confidenceThreshold''', % - минимальный порог доверия.
| colspan="2" style="width: 50%" |{ "corrected": "исправленный текст", # при наличии флага коррекции "classes": [

 { "class": "название класса",

 "confidence": 1 },

 { "class": "название класса 2",

 "confidence": 1 } ],

 "groups": [

 { "group": "название группы 1",

 "intersection": 2,

 "classes": [ "название класса", "название класса 2" ] } ],

 "nearest": [

 { "group": "название группы 2",

 "percent": 0.67,

 "need": "название класса которого не хватило 1" },

 { "group": ""название группы 3",

 "percent": 0.67,

 "need": "название класса которого не хватило 2" } ] }
|-
!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''' — процент совпадения
*'''text''' — текст для сравнения с распознанным текстом из wav, необязательный параметр. Если указан, то поиск не будет осуществлен, если распознанный текст будет сильно отличаться от text.
| 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.
| 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.
| 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.'''
| 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'''"
| 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''' - генерирует кэш через разные ответы на каждый вопрос по документации

*'''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:blue;width: 15%" |'''GET/qas/chat'''
! colspan="2" | Поиск ответа за пределами документов. Аналогичен методу "POST/qas/chat". Не поддерживает большие тексты.На стадии разработки, не используется.
|-
| colspan="2" |
*'''text -''' текст вопроса
*'''history''' - история вопросов, будет склеена с text при запросе
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''useInternalTemplate''' - использовать ли шаблон запроса. '''no''' - не использовать, либо код шаблона запроса к LLM. Необязательный параметр. Если не указан, используется шаблон по умолчанию.
*'''params''' - необязательный параметр. JSON с произвольными параметрами запроса к LLM. Описание параметров см. в [[QAS. Руководство администратора|руководстве администратора]].
|Аналогично методу "POST/qas/chat".
|-
! style="color:green;width: 15%" |'''POST/qas/cleandoc'''
! colspan="2" |Очистка документа от лишней информации
|-
| colspan="2" |
*'''text -''' текст документа
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|{"error": 0, "message": "success", "text": "измененный текст"}
|-
! 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''' — фильтр вопросов, ограничение списка по вопросам

*'''answer''' — фильтр ответов, ограничение списка по ответам
| 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:blue;width: 15%" |'''GET/qas/mismatchsearcher/answers'''
! colspan="2" |Отображает лог найденных несоответствий
|-
| colspan="2" |Входные параметры отсутствуют
|на выходе :массив из объектов {

 'question_id'

'category'

'answer_id'

'answer'

'description'

'error'

}
|-
! style="color:green;width: 15%" |'''POST/qas/mismatchsearcher/start'''
! colspan="2" |Старт поиска несоответствий
|-
| colspan="2" |
*'''category''' — id категории документа. Если не указать категорию, метод вернет ответ на основе всех документов в базе данных. Допускается указание нескольких категорий через разделитель "|".
*'''model''' - имя модели GPT, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|<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/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''' — категория (раздел) знаний. Допускается указание нескольких категорий через разделитель "|".
| 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)
|[ "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 - замена информации в тексте

*'''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 ] }
|}

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

2025-07-18T10:20:56Z

Ka.shapovalov:

====='''Общее описание'''=====
Сервис предназначен для поиска ответа на заданный вопрос. Входным значением для сервиса являются данные в текстовом формате. В ответ на входящий запрос сервис возвращает данные в формате 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 осуществляется скриптом <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 - для работы с документами

Расположение моделей 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.gpu_layers
|12
|Количество слоёв встроенной нейросети.
|-
|gpt.context
|32768
|Размер контекста встроенной нейросети.
|-
|logs.path
|logs/
|Папка для хранения логов. Примеры абсолютного пути: "/var/log/qas/".
|-
|logs.backups
|10
|Количество файлов ротации.
|-
|logs.maxSize
|5242880
|Максимальный размер файла в байтах, триггер для ротации.
|-
|fragments.context
|8192
|Максимальная длина текста, которая будет подана в генератор для поиска ответа на вопрос.
|-
|fragments.threshold
|0.6
|Уровень достоверности при векторном поиске фрагментов в загруженных документах.
|-
|fragments.limit
|1
|Максимальное количество фрагментов, которые должны быть найдены в документах в порядке убывания доверия.
|-
|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. Руководство пользователя

2025-07-18T10:18:59Z

Ka.shapovalov:

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

==== '''Термины и определения''' ====
Question Answering System (QAS) – сервис ответов на вопросы.

==== '''Описание методов API''' ====
Сервис QAS доступен по протоколу HTTP 1.1 через порт 6187/tcp. Авторизация не требуется, но все запросы должны содержать заголовок «accept: application/json». Ответ сервиса возвращается в формате JSON. Если произошла ошибка, возвращается переменная «error=1» и описание ошибки в переменной «message». Для удобства тестирования и использования методов сервиса по адресу <nowiki>http://АДРЕС:6187</nowiki> доступен интерфейс Swagger, который позволяет просматривать и тестировать все доступные методы из таблицы ниже.

{| class="wikitable" style="width: 110%"
|+''Методы API''
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов qas</big>'''
|-
! 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'''"
| style="width: 50%" |{
"error": 0,

"text": "Здесь будет текст ответа"

}
|-
! style="color:green;width: 15%" |'''POST/qas/autocache'''
! colspan="2" style="width: 85%" |Добавление вопросно-ответной пары в кэш.
В случае указания id answer будет принудительно добавлен в вопрос с указанным id. Если же указан question, то система сначала попытается найти похожий вопрос и добавить ответ в него, если же вопрос не будет найден, то система создаст новый с указанной формулировкой. При установке флага emptyQuestion будет добавлен только вопрос (без ответа).
|-
| colspan="2" style="width: 50%" |
*'''question''' — текст вопроса
*'''category''' — категория
* '''channel''' — канал
*'''answer''' — ответ
*'''emptyQuestion''' — yes или no, флаг добавления вопроса без указания ответа
*'''id''' — код существующего вопроса
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/qas/cachemaker/start'''
! colspan="2" style="width: 85%" |Генерация ответов на вопросы в кэше.
|-
| colspan="2" style="width: 50%" |
*'''category''' - категория для которой генерируются ответы

*'''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/chat'''
! colspan="2" style="width: 85%" |Произвольный запрос в LLM.
|-
| colspan="2" style="width: 50%" |
*'''text -''' текст вопроса
*'''history''' - история вопросов, будет склеена с text при запросе
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''useInternalTemplate''' - использовать ли шаблон запроса. '''no''' - не использовать, либо код шаблона запроса к LLM. Необязательный параметр. Если не указан, используется шаблон по умолчанию.
*'''params''' - необязательный параметр. JSON с произвольными параметрами запроса к LLM. Описание параметров см. в [[QAS. Руководство администратора|руководстве администратора]].
| style="width: 50%" |Пример ответа на вопрос "как пройти в библиотеку"

{"error": 0,

"text": "1. Проверить время работы библиотеки (обычно от 9 до 20)\n2. Проверить местоположение библиотеки на карте или с помощью сервиса Google Maps\n3. Убедиться, что у вас есть необходимые документы для входа (паспорт, карта члена библиотеки и т.д.)\n4. Посетить библиотеку по адресу: [адрес библиотеки]\n5. Проверить правила поведения в библиотеке перед входом" }
|-
! style="color:blue;width: 15%" |'''GET/qas/chat'''
! colspan="2" style="width: 85%" |Поиск ответа за пределами документов. Аналогичен методу "POST/qas/chat". Не поддерживает большие тексты.На стадии разработки, не используется.
|-
| colspan="2" style="width: 50%" |
*'''text -''' текст вопроса
*'''history''' - история вопросов, будет склеена с text при запросе
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''useInternalTemplate''' - использовать ли шаблон запроса. '''no''' - не использовать, либо код шаблона запроса к LLM. Необязательный параметр. Если не указан, используется шаблон по умолчанию.
*'''params''' - необязательный параметр. JSON с произвольными параметрами запроса к LLM. Описание параметров см. в [[QAS. Руководство администратора|руководстве администратора]].
| style="width: 50%" |Аналогично методу "POST/qas/chat".
|-
! style="color:green;width: 15%" |'''POST/qas/cleandoc'''
! colspan="2" |Очистка документа от лишней информации
|-
| colspan="2" |
*'''text -''' текст документа
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|{"error": 0, "message": "success", "text": "измененный текст"}
|-
! 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/gpt/list'''
| colspan="2" |Получение списка доступных(установленных) GPT моделей
|-
| colspan="2" |Входные параметры отсутствуют
|{ "error": 0, "message": "success",
 "models": ["default" ]}
|-
! 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:blue;width: 15%" |'''GET/qas/mismatchsearcher/answers'''
! colspan="2" |Отображает лог найденных несоответствий
|-
| colspan="2" |Входные параметры отсутствуют
|на выходе :

массив из объектов {

 'question_id'

'category'

'answer_id'

'answer'

'description'

'error'

}
|-
! style="color:green;width: 15%" |'''POST/qas/mismatchsearcher/start'''
! colspan="2" |Старт поиска несоответствий
|-
| colspan="2" |
*'''category''' — id категории документа. Если не указать категорию, метод вернет ответ на основе всех документов в базе данных. Допускается указание нескольких категорий через разделитель "|".
*'''model''' - имя модели GPT, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|<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;

 status: 'started' | 'stopped';

 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/questionmaker/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/search'''
! colspan="2" style="width: 85%" |Поиск фрагментов содержащих ответ
|-
| colspan="2" style="width: 50%" |
*'''text''' — текст запроса

*'''category''' — категория (раздел) знаний. Допускается указание нескольких категорий через разделитель "|".
| 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/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)
|[ "error": 0,
"message": "success",
"docs": [],
"answers": []
]
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов channel</big>'''
|-
! 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" }
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов category</big>'''
|-
! 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" }
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов doc</big>'''
|-
! 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="3" 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="3" |Массовая замена текста в указанных фразах.
|-
| colspan="2" |
*'''phrases''' - JSON массив с изменяемым фразами следующего вида:
[

{

'doc_id': 'ad895085-2e48-439a-831e-b5f699b6a54a',

'phrase_id': 5,

'text': 'новый текст'

}

]
|{"error": 0,"message": "success"}
|
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов question</big>'''
|-
! 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''' — фильтр вопросов

*'''answer''' — фильтр ответов
| style="width: 50%" |{ "error": 0,
 "questions": [

 { "id": "77b42c9b-2075-4a5f-b6d9-a284bba7cf43",

 "question": "вопрос",

 "category": "9580b3b7-34cb-4d0e-ba75-d17313ead16d" },

 { "id": "d1836e5e-010e-4f3a-b306-813c3acb7efb",

 "question": "n-й второй вопрос",

 "category": "7d8a3415-cb09-4dad-a169-478ba15ade47" }

 ] }
|-
! 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="3" 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/question/modifyanswers'''
! colspan="3" |Массовая замена текста в указанных ответах.
|-
| colspan="2" |
*'''phrases''' - JSON массив с изменяемым ответами следующего вида:
[

{

'question_id': 'ad895085-2e48-439a-831e-b5f699b6a54a',

'answer_id': 5,

'text': 'новый текст'

}

]
|{"error": 0,"message": "success"}
|
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов summarization_template</big>'''
|-
! 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%" |'''DELETE/qas/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}
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов prompt</big>'''
|-
! 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 - замена информации в тексте

*'''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}
|}

UPS. Описание API

2025-07-16T11:05:44Z

Ka.shapovalov:

===== '''Описание часто используемых параметров''' =====
{| 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''' =====

{| 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, автоматическое определение количества
* '''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''' =====
{| class="wikitable" style="width: 110%"
|+
!style="color:blue;width: 15%" |'''GETsmc/classify/{model}'''
! colspan="3" style="width: 85%" |Классификация текстовой фразы. В случае если модель была создана из меток, в ответе groups и nearest будут пустыми, а ответ будет построен без учета confidenceThreshold из запроса.
В ответе:

* classes — список, для каждого класса которого отображается название класса, к которому был отнесен текст, и вероятность его принадлежности к этому классу.
* groups — название группы и число совпавших классов. Если метки совпадают с несколькими группами, они отображаются в порядке убывания числа совпавших классов (т. е. чем полнее группа, тем выше ее позиция в списке).
* nearest — отображаются группы, до которых не хватает всего одной метки, с указанием процента заполненности и сортировкой по убыванию этого процента.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
*'''text''' - текст, подлежащий классификации
*'''correction''' - уровень коррекции ошибок, от 0 до 3, по умолчанию 0
*'''confidenceThreshold''', % - минимальный порог доверия.
| colspan="2" style="width: 50%" |{ "corrected": "исправленный текст", # при наличии флага коррекции "classes": [

 { "class": "название класса",

 "confidence": 1 },

 { "class": "название класса 2",

 "confidence": 1 } ],

 "groups": [

 { "group": "название группы 1",

 "intersection": 2,

 "classes": [ "название класса", "название класса 2" ] } ],

 "nearest": [

 { "group": "название группы 2",

 "percent": 0.67,

 "need": "название класса которого не хватило 1" },

 { "group": ""название группы 3",

 "percent": 0.67,

 "need": "название класса которого не хватило 2" } ] }
|-
!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''' — процент совпадения
*'''text''' — текст для сравнения с распознанным текстом из wav, необязательный параметр. Если указан, то поиск не будет осуществлен, если распознанный текст будет сильно отличаться от text.
| 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.
| 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.
| 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.'''
| 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'''"
| 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''' - генерирует кэш через разные ответы на каждый вопрос по документации

*'''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:blue;width: 15%" |'''GET/qas/chat'''
! colspan="2" | Поиск ответа за пределами документов. Аналогичен методу "POST/qas/chat". Не поддерживает большие тексты.На стадии разработки, не используется.
|-
| colspan="2" |
*'''text -''' текст вопроса
*'''history''' - история вопросов, будет склеена с text при запросе
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''useInternalTemplate''' - использовать ли шаблон запроса. '''no''' - не использовать, либо код шаблона запроса к LLM. Необязательный параметр. Если не указан, используется шаблон по умолчанию.
*'''params''' - необязательный параметр. JSON с произвольными параметрами запроса к LLM. Описание параметров см. в [[QAS. Руководство администратора|руководстве администратора]].
|Аналогично методу "POST/qas/chat".
|-
! style="color:green;width: 15%" |'''POST/qas/cleandoc'''
! colspan="2" |Очистка документа от лишней информации
|-
| colspan="2" |
*'''text -''' текст документа
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|{"error": 0, "message": "success", "text": "измененный текст"}
|-
! 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''' — фильтр вопросов, ограничение списка по вопросам

*'''answer''' — фильтр ответов, ограничение списка по ответам
| 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:blue;width: 15%" |'''GET/qas/mismatchsearcher/answers'''
! colspan="2" |Отображает лог найденных несоответствий
|-
| colspan="2" |Входные параметры отсутствуют
|на выходе :массив из объектов {

 'question_id'

'category'

'answer_id'

'answer'

'description'

'error'

}
|-
! style="color:green;width: 15%" |'''POST/qas/mismatchsearcher/start'''
! colspan="2" |Старт поиска несоответствий
|-
| colspan="2" |
*'''category''' — id категории документа. Если не указать категорию, метод вернет ответ на основе всех документов в базе данных. Допускается указание нескольких категорий через разделитель "|".
*'''model''' - имя модели GPT, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|<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/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''' — категория (раздел) знаний. Допускается указание нескольких категорий через разделитель "|".
| 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)
|[ "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 - замена информации в тексте

*'''name''' — название шаблона

*'''prompt''' — текст шаблона

*'''postprompt''' - текст шаблона постобработки результатов (нужен только для summarize)
|{ "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 ] }
|}

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

2025-07-16T11:05:02Z

Ka.shapovalov:

===== '''Общее описание''' =====
Сервис предназначен для создания сценарных машин и обеспечения их работы.

===== '''Термины и определения''' =====
Script engine service (SES) - сервис обеспечения работы и создания сценарных машин. Swagger UI – интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису SES в реальном времени

===== '''Скрипты интеграции''' =====
Для взаимодействия со сторонними сервисами используются скрипты интеграции на языке python. Скрипт интеграции должен содержать функцию '''handler'''(data={}, session_id=None, channel='default').

Пример данных на входе можно посмотреть в методе ses GET/ses/session/{robot_id}/{session_id}

Функция должна исходя из полученных данных запросить ответ у стороннего сервиса. Запрос необходимо выполнить в блоке try/except. Скрипт не должен выдавать ошибку в основное приложение, все исключения должны быть обработаны внутри скрипта.

-------

====== '''''Функция apiRequest''''' ======
'''''Для отправки запроса рекомендуется использовать функцию apiRequest.''''' Функция сделает все необходимые записи в лог интеграции. Пример:

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

<code>status, reply = apiRequest(name="наименование скрипта",method='get',sessiondata=data,url=url,timeout=(1,10))</code>

* '''status, reply''' - http код ответа (например 200) и ответ без изменений и сериализации.

* '''name''' = название вызываемого метода, для отчетности

* '''sessiondata''' - это data в handler, которая туда прилетает

* '''method''' - метод запроса-ответа

после этих параметров в функцию '''apiRequest''' отправить все нужные параметры, как при вызове requests, они будут переданы один к одному.

Из функции '''handler''' можно передать или изменить переменную (в рамках текущей сессии): <code>data['variables']={'new_var': 'новое_значение'}</code>

Функция '''handler''' должна возвращать ответ в виде <code>return { "text": "Текст ответа.", 'answered': True}, {}</code>

* '''text''' - текст ответа

* '''answered''' - получен ли ответ (True или False)
Если в скрипте интеграции не используются запросы к api стороннего сервиса через http, необходимо предусмотреть запись в лог (запись в лог встроена в функцию '''apiRequest''' и при ее использовании отдельно писать в лог не надо). Для этого необходимо импортировать библиотеку:

from app.tools import apiLog

-------

====== '''''Функция apiLog''''' ======
'''''Если в скрипте интеграции не используются запросы к api, по окончании работы функции handler вызвать функцию записи лога:'''''

'''apiLog'''(data=data,name="",url="",request={},reply_code=200,reply=None,request_datetime=None,reply_datetime=None)

* '''data''' - тот же массив который был на входе

* '''name''' - наименование или короткое описание скрипта

* '''url''' - адрес запроса к стороннему сервису (если есть)

* '''request''' - текст запроса

* '''reply_code''' - код ответа (стандартный код http)

* '''reply''' - необработанный ответ стороннего сервиса

* '''request_datetime''' - время перед запросом, без учета таймзоны, получить лучше так request_datetime=datetime.now(timezone.utc)

* '''reply_datetime''' - время сразу по получению ответа, также без учета таймзоны. Внимание - не используйте '''apiRequest или apiLog''' для данных содержащих пароли в открытом виде, чтобы они не попали в лог

-------

====== '''''Функция getData''''' ======
'''''Для упрощения поиска информации можно использовать функцию getData''''' (''from app.tools import getData''), нужна для извлечения конкретных данных из сессии, можно отправить либо всю переменную сессии, либо 'data' из сессии. Пример поиска цифрового кода заявления, выявленного моделью see 'number', поиск только в последнем сообщении диалога:

<code>for j in getData(data=data,filter={'type':'see','model':'number'},depth=1):</code>

<code>kod_zayavl=str(int(j['param']))</code>

<code>break</code>

Параметры функции

* '''data''' - или 'data' из сессии или переменная сессии

* '''filter''' - словарь ключевых полей и их значений - поиск сработает если все данные совпадут

* '''depth''' - отвечает за глубину поиска в истории, по умолчанию 1, т.е. искать только в последнем сообщении. Возвращает список всех найденных данных, добавляя в каждый элемент depth, т.е. где именно он нашелся

-------

====== '''''Выполнение длительных процедур''''' ======
Код, который будет выполняться дольше нескольких секунд лучше запускать отдельным потоком. В этом случает есть возможность сообщить результат в канал даже после завершения основного диалога. Пример ожидания и отправки файла после паузы:
 from app.interactions import connectors

def do_sleep(params, session_id, channel):
time.sleep(params['sleep_time'])
message="выполнено"
connectors.sendMessage(channel=channel,session=session_id,answers=[{'messages':[message]}],files={'document':(filetame, open(file_path,'rb'))})
def handler(data={}, session_id=None, channel='default'):
params={} #чтото передадим в функцию
params['sleep_time']= 100
Thread(target=do_sleep,name='do_sleep'+str(uuid.uuid4()),args=(params, session_id, channel) ).start()
return { 'text': "запустил задание, ждем результат", 'answered': False }, {}
-------

======'''''Отложенные задания'''''======
Для выполнения отложенных заданий необходимо

#получить ссылку на базу данных текущего робота
#в таблицу "crons" внести внести время и python код который должен выполниться в указанное время.

Пример отложенного сообщения в телеграм: # Формируем задачу в крон

 error, db = get_db(data['robot'])

 if error:

 return { 'text': 'А я тебе ошибку базы данных привез: '+str(db), 'answered': False }, {}

 dt = int(datetime.strptime(date['date']+' '+date['time'],'%Y-%m-%d %H:%M').timestamp())

 

 # А вот тут создадим код для выполнения задачи

 url = f'<nowiki>https://api.telegram.org/bot{token}/sendMessage'</nowiki>

 data = json.dumps({'chat_id': chat_id, 'text': message})

 data = base64.b64encode(data.encode("utf-8")).decode("utf-8")

 code = """

 import requests, json, base64

 try:

 data=\"{1}\"

 data=base64.b64decode(data.encode('utf-8')).decode('utf-8')

 requests.post(\"{0}\", data=json.loads(data), timeout = (5, 10))

 except Exception as error:

 logging.error(traceback.format_exc())

 

 """.format(url,data).replace(" ","")

 error, result = db.create(table='crons',data={

 'id': str(uuid.uuid4()),

 'name':'Задача-напоминание для '+username,

 'datetime': dt,

 'code': code })

-------

======'''''Пользовательские таблицы базы данных'''''======
В составе большинства продуктов используется служебная файловая [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%92%D0%BD%D1%83%D1%82%D1%80%D0%B5%D0%BD%D0%BD%D1%8F%D1%8F_%D0%B1%D0%B0%D0%B7%D0%B0_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D1%85 база данных]. В SES возможно использование служебной базы в скриптах интеграции. Для этого нужно:

'''Импортировать функцию''' получения объекта БД (<code>from app.db import get_db</code>)

'''Получить объект БД''' error, db = get_db(data['robot'])

if error: 
return { 'text': 'ошибка базы данных: '+str(db), 'answered': False }, {}

'''Объявить структуру''' пользовательской таблицы, создав запись в таблице структур (если еще не объявляли) search_data={
"id":"new_table_name"
}
try:
error, search_result = db.select('structures',data=search_data,sort=None,md5clean=True)
if not search_result:
struct_data = {
"id":"new_table_name",
"name": "new_table_name",
"fields": {
"string":"",
"integer":0,
"float":0.0,
"именованный массив":{},
"неименованный массив":[],
"bool":True
}
}
error, str_id = db.create(table='structures', data=struct_data)
'''Сделать запись''' в базе new_data={
"string":"пример строки\n",
"integer":100500,
"float":20.0004,
"именованный массив":{'ключ1':'значение1'},
"неименованный массив":['запись1','запись2',],
"bool":True
}
error, id = db.create(table="new_table_name", data=new_data)

if error:
return { 'text': 'ошибка создания: '+str(db), 'answered': False }, {}
Если при создании структуры не указывать в структуре id то база сама создаст id, вернет его в ответ. В дальнейшем тогда имя новой таблицы будет в id и запись/поиск в базе только по нему. Пример поиска в 'structures' подходит для поиска в пользовательской таблице.

Создание, редактирование и просмотр пользовательской таблицы в базе возможно и с интерфейса UPS.

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

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

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

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

======'''''Методы API'''''======

{| class="wikitable" style="width: 110%"
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses</big>'''
|-
! colspan="3" |для некоторых путей, где используется {robot_id} - это обращение к версии черновика, чтобы обращаться r продовой версии - нужен постфикс "_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: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/log'''
! colspan="2" style="width: 85%" |Получение лога всех сессий начиная с date. В логе '''error,''' '''message''' и массив сессий '''log''' (log содержит информацию о каждой сессии и запросы с ответами)
|-
| colspan="2" style="width: 50%" |
*'''date''' - начальная дата в формате %Y-%m-%d
| style="width: 50%" |{ "error": 0, "message": "success",

 "log": [

 {"id": ",.....", "session": "......", "robot": ".....", "channel": "......", 

"unknown": true/false, "closed": true/false, "endpoint": ".....",

 "answered": true/false, "models": [....], "variables": {}, "current": {.......},

 "request": {.......}, "reply": { ..... }, "robot_id": "", "endpointName": "", "endpointType": "" },

 ..... ] }
|-
! 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="2" style="width: 85%" |Отдает конфигурацию виджета скрипту виджета
|-
| colspan="2" style="width: 50%" |
*'''token''' - ключ виджета
| style="width: 50%" |На выходе содержимое настроек web канала из конфигурационного файла
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/robot/<big>'''
|-
! 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:blue;width: 15%" |'''GET/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:blue;width: 15%" |'''GET/ses/robot/cleardraft/{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/ses/robot/commit/{id}'''
! colspan="2" style="width: 85%" |Применение текущих изменений настроек робота. Применимо ко всем версиям (черновик, рабочая, резервная копия)
|-
| colspan="2" style="width: 50%" |
*'''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: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/get/{id}'''
! colspan="2" style="width: 85%" |Выгрузка основных настроек робота
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор робота
| style="width: 50%" |{ "error": 0,

 "data": { "id": ".....", "name": ".....","description": "",

 "voice": "", "session": { "lifetime": 600 },

 "models": {},"servicedata": {},"exceptions": {},"actions": {},

 "holidays": [],

 "timeintervals": {

 "name": {"weekdays": [ ..... ], "dates": [ ..... ], "months": [.....],

<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:blue;width: 15%" |'''GET/ses/robot/restore/{id}'''
! colspan="2" style="width: 85%" |Откат рабочей версии из бэкапа. Резервная копия становится рабочей, и удаляется, а черновик остается без изменений
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор робота
| style="width: 50%" |{ "error": 0,

 "message": "success"}
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/robot/data<big>'''
|-
! 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": ".....", "name": ".....", "comment": "", "type": "smc",

 "rtype": "report", "model": ".....", "param": ".....",

 "script": "", "weight": int, "slaveData": [],

 "getOnlyAsNearest": true/false, "injectToMessage": true/false,

 "longWaiting": true/false, "dataWaiting": [],

<nowiki> "actions": {}, "exceptions": {}}}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/data/list/{robot}'''
! colspan="2" style="width: 85%" |Получение списка элементов данных
|-
| colspan="2" style="width: 50%" |
* '''robot''' - идентификатор робота (id)
| 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"}
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/robot/endpoint<big>'''
|-
! 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": "...", "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"}
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/archive<big>'''
|-
|-
! 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]
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/robot/script<big>'''
|-
! 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%" |
*'''robot''' - идентификатор робота
| 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>
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/robot/files<big>'''
|-
! 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 файла"}
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/testapi''' ''[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#:~:text=%D0%B2%D1%80%D0%B5%D0%BC%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%20%D0%BF%D0%B0%D0%BF%D0%BA%D0%B0-,%D0%AD%D0%BC%D1%83%D0%BB%D1%8F%D1%86%D0%B8%D1%8F%20%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%BE%D0%B2%20%D0%B8%D0%BD%D1%82%D0%B5%D0%B3%D1%80%D0%B0%D1%86%D0%B8%D0%B8,-%5B%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C%20%7C для отладки скриптов интеграции]''
|-
! style="color:blue;width: 15%" |'''GET/ses/testapi/list'''
! colspan="2" style="width: 85%" |Получение списка эмуляторов сервисов интеграции
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |[ "service1",

 "service2",

 "serviceN"]
|-
! style="color:green;width: 15%" |'''POST/ses/testapi/{request}'''
! colspan="2" style="width: 85%" |Получение ответа эмулятора сервиса интеграции
|-
| colspan="2" style="width: 50%" |
*'''request''' - запрос вида <service1>
| style="width: 50%" | "ответ эмулятора"
|-
! style="color:blue;width: 15%" |'''GET/ses/testapi/{request}'''
! colspan="2" style="width: 85%" |Получение ответа эмулятора сервиса интеграции
|-
| colspan="2" style="width: 50%" |
*'''request''' - запрос вида <service1>
| style="width: 50%" | "ответ эмулятора"
|
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/robot/userdata<big>'''
|-
! 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"}
|-

|}

======'''''Постобработка методов api'''''======
Для метода '''POST/ses/ask/{robot_id}''' можно изменить формат данных ответа.

Для этого необходимо подготовить скрипт на python в папке /opt/ses/handlers/api/ask/ . Скрипт должен содержать функцию handler(reply={}), Функция должна вернуть переформатированный ответ. Чтобы воспользоваться скриптом необходимо его имя без разрешения указать в поле "'''handler'''" при запросе метода.

Аналогично и для метода ask websocket протокола - файл положить в /opt/ses/handlers/websockets/ask/ . Далее в любом запросе указать обработчик <code><nowiki>{тут всё, что ты и так отправляешь, 'handlers': { 'ask': '__telegram' }} }</nowiki></code> . начиная с этого запроса обработчик будет действовать в течение сессии пока не отправишь 'handlers': {} . Для других полей запросов в канале websocket аналогично.

В составе поставки ses есть файл примера <code>__telegram.py</code> (префикс 2 подчеркивания - такой файл будет переписан при обновлении, любой другой, останется после обновления)

===== '''Websockets сервер''' =====
Работа с программным продуктом возможна с использованием встроенного websockets сервера. Подключение производится по порту 6191, без SSL. При необходимости работать по SSL перед SES ставится nginx в режиме прокси, и SSL поднимается на nginx. Подробнее см. документацию по nginx.

В таблице ниже приведены форматы сообщений для работы с сервером. В каждом сообщении (за исключением бинарных), присутствует переменная path (формат сообщений - JSON), которая определяет алгоритм обработки сообщения. Подключение к серверу возможно в следующих вариантах:

# ws://адрес:6191
# ws://адрес:6191/session[/chunk]

Первый вариант подходит только для текстовых сообщений, в данном случае передача переменной session (uuid текущей сессии) должна производиться в теле сообщения.

Второй вариант подходит и для текстового и для голосового общения с роботом. В данном случае session передается в пути подключения к websockets-серверу. Для каждой новой сессии нужно открывать новое соединение, chunk в пути подключения нужен в том случае, если передаются не готовые части аудио, предварительно сформированные, а сплошной поток аудио, кусками по 20 мс.

{| class="wikitable" style="width: 110%"
|-
! colspan="3" style="text-align: center" |'''<big>Входящие сообщения'''
|-
! style="color:green;width: 15%" |'''path:ask'''
! colspan="2" style="width: 85%" |Вопрос роботу
|-
| colspan="2" style="width: 50%" |{

 "path": "ask",

 "robot": "f296a3a9-593c-4ed5-a1d3-5d4d46d331bf",

 "session": "77f1af87-6da7-487b-96d2-4e2684704ad5", ''# Необязательный параметр, если не будет отправлен, будет создана новая сессия и в ответе придет сгенерированный session''

 "channel": "default",

 "link": 1, ''# Необязательный параметр, отдает ссылки на аудио, если 1.''

 "format": "wav", ''# Необязательный параметр, формат возвращаемого аудио, если channel=voice''

"document": {"name":"название","base64":"тело документа в base64"}, ''# необязательный параметр''

"handlers": {"ask": "название хэндлера"}, ''# Необязательный параметр, см. [[SES. Руководство администратора|описание обработчиков]]''

 "text": "привет", 

или

"audio": "base64 строка",

}

| style="width: 50%" |Для текстовых ответов (канал не voice)
{ "error": 0,

 "question": "привет",

 "answer": [

 {

 "messages": [

 "Здравствуйте! Как я могу вам помочь сегодня?"

 ],

 "voice": "Валера",

 "interruptible": false,

 "file": null

 }

 ],

 "session": "77f1af87-6da7-487b-96d2-4e2684704ad5",

 "uuid": "83722305-645d-4674-8c5d-952e02f595f9",

 "path": "ask"

}

Для голосовых ответов, канал voice, дополнительно идет отправка N сообщений с аудио

{ "audio": "ссылка или base64 закодированное аудио",

 "session": "77f1af87-6da7-487b-96d2-4e2684704ad5",

 "uuid": "83722305-645d-4674-8c5d-952e02f595f9",

 "status": "listening | asking" ''# Требование к клиенту выставить статус.''

}
|-
!'''path:session'''
! colspan="2" |Статус сессии
|-
| colspan="2" |{

 "path": "session",

 "robot": "f296a3a9-593c-4ed5-a1d3-5d4d46d331bf",

 "session": "548cd1ca-a24a-4a9a-ab4f-8363aa32c3c2"

}

|{ "started": "2025-07-08 07:39:24",

 "modified": "2025-07-08 07:39:26",

 "robot": "f296a3a9-593c-4ed5-a1d3-5d4d46d331bf",

 "session": "548cd1ca-a24a-4a9a-ab4f-8363aa32c3c2",

 "channel": "default",

 "connector": "web",

 "unknown": false,

 "current": {

 "id": null,

 "qas": "",

 "category": null,

 "entry": [],

 "nearest": null,

 "missingRunData": [],

 "waitingRunData": null,

 "answered": false,

 "lastreply": "Здравствуйте! Как я могу вам помочь сегодня?"

 },

 "models": [

 "smc:Рыжик",

 "see:Серверы",

 "see:fio"

 ],

 "scripts": [],

 "data": [

 {

 "request": {

 "datetime": "2025-07-08T07:39:24.706771",

 "message": "привет",

 "data": []

 },

 "reply": {

 "answers": [

 {

 "messages": [

 "Здравствуйте! Как я могу вам помочь сегодня?"

 ],

 "voice": "Валера",

 "interruptible": false,

 "file": null

 }

 ],

 "datetime": "2025-07-08T07:39:26.269201",

 "answered": false

 }

 }

 ],

 "timers": [],

 "variables": {},

 "error": "",

 "events": {

 "not found": {

 "counter": 1

 },

 "no data": {

 "id": null,

 "counter": 0

 },

 "silence": {

 "id": null,

 "counter": 0

 }

 },

 "path": "session"

}
|-
!'''path:status'''
! colspan="2" |Установка статуса клиентской части. Используется в голосовом канале, для установки текущего статуса клиентской части. В случае использования режима активного слушания в момент речи робота, необходимо выставлять на клиентской части статус asking.
|-
| colspan="2" |{

 "path": "status",

 "value": "listening | asking",

 "session": "77f1af87-6da7-487b-96d2-4e2684704ad5"

}

|<nowiki>{ "error": 0, "message": "success", "value": "listening | asking", "session": "77f1af87-6da7-487b-96d2-4e2684704ad5" }</nowiki>
|-
!'''path:interrupted'''
! colspan="2" |Уведомление о прерывании текущего сообщения робота пользователем.
|-
| colspan="2" |{

 "path": "interrupted",

 "session": "77f1af87-6da7-487b-96d2-4e2684704ad5"

}
|
|-
!'''path:hangup'''
! colspan="2" |Завершение сессии с роботом.
|-
| colspan="2" |{

 "path": "hangup",

 "value": "user | robot",

 "session": "77f1af87-6da7-487b-96d2-4e2684704ad5"

}
|<nowiki>{ "error": 0, "message": "success", "value": "user | robot", "session": "77f1af87-6da7-487b-96d2-4e2684704ad5" }</nowiki>
|}
Со стороны сервера возможны самостоятельные сообщения типов ask и hangup в формате, аналогичном приведенному в таблице выше.

Работа с сервером возможна с поточной передачей аудио в сторону сервера. В данном режиме ответы от сервера будут со ссылками на аудио, которое должно быть воспроизведено на стороне клиента (см. таблицу выше). Формат принимаемого потока аудио: pcm, 8кГц, 16 бит, размер куска аудио - 20 мс.

Аудио отправляется бинарным сообщением по ссылке ws://адрес/код сессии/chunk.

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

2025-07-16T10:39:55Z

Ka.shapovalov:

===== '''Общее описание''' =====
Сервис предназначен для сценарных машин.

===== '''Термины и определения''' =====
Script Engine Service (SES) – сервис, обеспечивающий работу сценарных машин.

===== '''Требования к окружению''' =====
В процессе работы сервис взаимодействует со следующими сервисами:

* UPS – настройка осуществляется через файл /opt/ups/config.json
* SMC, SEE, SPR, TTS, SBS, QAS – настройка осуществляется через файл /opt/ses/config.json.

===== '''Установка ses''' =====

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

==='''Настройка сервиса'''===

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

Описание параметров приведено в таблице
{| class="wikitable"
|+
!style="width: 20%"|Параметр
!style="width: 20%"|По умолчанию
!style="width: 60%"|Назначение
|-
|port
|6190
|Порт API интерфейса используется в UPS — настройка servers.ses в конфиге UPS.
|-
|logs.path
|logs/
|Путь к папке логов.
|-
|logs.debug
|false
|Режим расширенного логирования.
|-
|logs.backups
|10
|Количество старых сохраняемых логов.
|-
|logs.maxSize
|5242880
|Максимальный размер текущего лог-файла в байтах.
|-
|storage.audio.web
|/opt/ses/storage/web
|Путь для временного хранения фрагментов аудио веб сессий
|-
|storage.audio.hot
|/opt/ses/storage/hot
|Путь к "горячему" хранилищу аудиоданных
|-
|storage.audio.cold
|null
|Путь к "холодному" хранилищу аудиоданных, куда переливаются данные из "горячего" хранилища.
|-
|servers.{service}.url
|"<nowiki>http://127.0.0.1:PORT/{service}</nowiki>"
|Адрес сервера. Возможные варианты значения service (с портами по умолчанию) следующие: smc(6181), see(6184), spr(6183), tts(6186), sbs(6185), qas(6187).
|-
|servers.{service}.timers.connect
|2
|Таймаут подключения к серверу.
|-
|servers.{service}.timers.read
|10
|Таймаут получения данных с сервера.
|-
|connectors.vk
|{}
|Параметры подключения к ботам VK
{ "имя_подключения":{

 "token":"Ключ доступа",

 "robot":"id робота",

 "group_id":"id сообщества ВКонтакте",

 "whitelist":[],

 "activators":[]

 },

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

}
|-
|connectors.telegram
|{}
|Параметры подключения к telegram ботам
{ "имя_подключения":{

 "token":"Ключ доступа",

"botName": "название бота (после символа @)",

 "robot":"id робота",

 "variables":{

 "phone": "1234567890"

 },

 "timers": { "getUpdates": 3 },

 "whitelist":[],

 "activators":[]

 },

...........

}
|-
|connectors.freeswitch
|{}
|Номера внутренних телефонов внутри freeswitch с привязкой к роботам
"5000": {

 "robot": "ffeaa99a-13d2-4bff-b458-1231c884f8ee"

 }
|-
|vad.listening.maxLength
|10000
|Максимальная длина звукового фрагмента
|-
|vad.listening.minSpeech
|120
|Минимальный отрезок речи, который считать значимым
|-
|vad.listening.skipSilence
|60
|Не считать тишиной отрезки, короче данного значения
|-
|vad.listening.maxSilence
|1200
|Максимальная длительность тишины перед отправкой фрагмента
|-
|vad.listening.speechWaiting
|4000
|Длительность ожидания начала речи
|-
|vad.playing.maxLength
|2000
|Максимальная длина звукового фрагмента в режиме активного слушания
|-
|vad.playing.minSpeech
|60
|Минимальный отрезок речи, который считать значимым в режиме активного слушания
|-
|vad.playing.skipSilence
|60
|Не считать тишиной отрезки, короче данного значения в режиме активного слушания
|-
|vad.playing.maxSilence
|200
|Максимальная длительность тишины перед отправкой фрагмента в режиме активного слушания
|-
|cluster.logfile
|logs/sync.log
|Файл логов синхронизации есть только на главном сервере кластера
|-
|cluster.statusFile
|logs/sync.status
|Статус задачи синхронизации есть только на главном сервере кластера
|-
|cluster.nodes
|[ ]
|Перечень подчиненных нод для синхронизации изменений заполняется только на главном сервере кластера
|-
|tmp
|"/tmp/ses"
|Временная папка.
|}

==== '''Работа в составе кластера''' ====
Для высоконагруженных систем сервис можно расположить на нескольких нодах (виртуальных машинах). В этом случае, чтобы не потерять документы и изменения, полученные на одной из нод, выделяется один основной сервис и вспомогательные сервисы:
*База файловая, в папке robots.
*lsync настроен через конфиг SES для репликации базы на все указанные серверы в списке cluster.nodes: [], указываем все слейв-сервера.
*UPS при изменении данных работает только с мастером SES, а при запросе данных — со всеми серверами cluster, распределяя нагрузку.
*В конфигурации UPS: в servers.ses.trainer указываем маcтер-сервер, в servers.ses.cluster перечисляем все сервера кластера SES, в том числе и мастер.

===='''Эмуляция сервисов интеграции'''====

В каталоге '''/opt/ses/testapi''' могут располагаться эмуляторы сервисов интеграции. Эмулятор будет доступен по адресу ''htttp://<адрес ses>/testapi/<название_сервиса>. Для создания эмулятора поместите в папку /opt/ses/testapi/ файл <название_сервиса>.reply. Содержимое файла будет отдано без изменений, как есть по адресу "http://<адрес_ses>:<порт_ses>/ses/testapi/<название_сервиса>".''

==='''Настройка каналов и виджетов'''===

===='''Настройка виджета для сайта'''====

# '''Размещаете на сайте''', например <nowiki>http://сайт.рф</nowiki> '''ссылку на виджет''' <nowiki><script src="http://адрес_ups/ses/widget/js" key="xxxxxxxx"></script></nowiki> (ключ придумайте сами)
# '''Делаете конфиг''' канала в файле /opt/ses/config.json в разделе connectors.web. В конфиге следующее:
<blockquote>"web": {

"<nowiki>http://сайт.рф~xxxxxxxx"</nowiki>: { #сайт_с_виджетом~ключ

 "robot": "28013d0a-...", # id робота

 "color": "#4d3e33", #акцентный цвет виджета"

 "host": "адрес_ses:6191", #адрес который прослушивает ws(wss) запросы

 "microphone": false, #возможность отправлять/принимать аудио

 "transcription": false, #возможность расшифровки аудио клиента

 "variables": {

 "var_1": "1234567890"

 } } }</blockquote>Если на сайте SSL, то дополнительно поднимаете реверс-прокси для UPS (<nowiki>http://адрес_ups</nowiki>) и для websocket (адрес_ses:6191). Особенности реализации на nginx:

'''Основной конфиг''' должен включать директиву <code>proxy_set_header Host $host;</code> а также заголовки CORS и обработку OPTIONS запросов. Дополнительно в нем? возможно? придется обработать путь "/lang" с переводом.

Конфиг для websocket должен обеспечивать обработку upgrade запросов (<nowiki>https://nginx.org/en/docs/http/websocket.html</nowiki>) для перенаправления websocket трафика, а также прослушивание отдельного порта, например 8091.

Тогда в ссылку на виджет (адрес_ups) и в конфиг канала (адрес_ses:6191) нужно будет вносить адреса, которые поддерживают SSL. Пример конфига nginx для wss: <blockquote>server {

 server_name ups_сервер.ru;

 listen 6191 ssl;

 include snippets/ssl-params.conf;

 ssl_certificate /etc/letsencrypt/live/ups_сервер.ru/fullchain.pem;

 ssl_certificate_key /etc/letsencrypt/live/ups_сервер.ru/privkey.pem;

 ssl_trusted_certificate /etc/letsencrypt/live/ups_сервер.ru/chain.pem;

 client_max_body_size 1000M;

 proxy_read_timeout 6000;

 proxy_connect_timeout 6000;

 proxy_send_timeout 6000;

 send_timeout 6000;

 large_client_header_buffers 8 256k;

 location / {

 proxy_pass <nowiki>http://локальныq_адрес_ses:6191</nowiki>;

 proxy_http_version 1.1;

 proxy_set_header Upgrade $http_upgrade;

 proxy_set_header Connection "upgrade";

 proxy_set_header Host $host;

 proxy_cache_bypass $http_upgrade; } }</blockquote>

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

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

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

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

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

==='''Удаление и обновление ses'''===
Для удаления выполните команду:

<code>/opt/ses/uninstall</code>

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

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

2025-07-08T09:41:48Z

Ka.shapovalov:

===== '''Общее описание''' =====
Сервис предназначен для создания сценарных машин и обеспечения их работы.

===== '''Термины и определения''' =====
Script engine service (SES) - сервис обеспечения работы и создания сценарных машин. Swagger UI – интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису SES в реальном времени

===== '''Скрипты интеграции''' =====
Для взаимодействия со сторонними сервисами используются скрипты интеграции на языке python. Скрипт интеграции должен содержать функцию '''handler'''(data={}, session_id=None, channel='default').

Пример данных на входе можно посмотреть в методе ses GET/ses/session/{robot_id}/{session_id}

Функция должна исходя из полученных данных запросить ответ у стороннего сервиса. Запрос необходимо выполнить в блоке try/except. Скрипт не должен выдавать ошибку в основное приложение, все исключения должны быть обработаны внутри скрипта.

-------

====== '''''Функция apiRequest''''' ======
'''''Для отправки запроса рекомендуется использовать функцию apiRequest.''''' Функция сделает все необходимые записи в лог интеграции. Пример:

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

<code>status, reply = apiRequest(name="наименование скрипта",method='get',sessiondata=data,url=url,timeout=(1,10))</code>

* '''status, reply''' - http код ответа (например 200) и ответ без изменений и сериализации.

* '''name''' = название вызываемого метода, для отчетности

* '''sessiondata''' - это data в handler, которая туда прилетает

* '''method''' - метод запроса-ответа

после этих параметров в функцию '''apiRequest''' отправить все нужные параметры, как при вызове requests, они будут переданы один к одному.

Из функции '''handler''' можно передать или изменить переменную (в рамках текущей сессии): <code>data['variables']={'new_var': 'новое_значение'}</code>

Функция '''handler''' должна возвращать ответ в виде <code>return { "text": "Текст ответа.", 'answered': True}, {}</code>

* '''text''' - текст ответа

* '''answered''' - получен ли ответ (True или False)
Если в скрипте интеграции не используются запросы к api стороннего сервиса через http, необходимо предусмотреть запись в лог (запись в лог встроена в функцию '''apiRequest''' и при ее использовании отдельно писать в лог не надо). Для этого необходимо импортировать библиотеку:

from app.tools import apiLog

-------

====== '''''Функция apiLog''''' ======
'''''Если в скрипте интеграции не используются запросы к api, по окончании работы функции handler вызвать функцию записи лога:'''''

'''apiLog'''(data=data,name="",url="",request={},reply_code=200,reply=None,request_datetime=None,reply_datetime=None)

* '''data''' - тот же массив который был на входе

* '''name''' - наименование или короткое описание скрипта

* '''url''' - адрес запроса к стороннему сервису (если есть)

* '''request''' - текст запроса

* '''reply_code''' - код ответа (стандартный код http)

* '''reply''' - необработанный ответ стороннего сервиса

* '''request_datetime''' - время перед запросом, без учета таймзоны, получить лучше так request_datetime=datetime.now(timezone.utc)

* '''reply_datetime''' - время сразу по получению ответа, также без учета таймзоны. Внимание - не используйте '''apiRequest или apiLog''' для данных содержащих пароли в открытом виде, чтобы они не попали в лог

-------

====== '''''Функция getData''''' ======
'''''Для упрощения поиска информации можно использовать функцию getData''''' (''from app.tools import getData''), нужна для извлечения конкретных данных из сессии, можно отправить либо всю переменную сессии, либо 'data' из сессии. Пример поиска цифрового кода заявления, выявленного моделью see 'number', поиск только в последнем сообщении диалога:

<code>for j in getData(data=data,filter={'type':'see','model':'number'},depth=1):</code>

<code>kod_zayavl=str(int(j['param']))</code>

<code>break</code>

Параметры функции

* '''data''' - или 'data' из сессии или переменная сессии

* '''filter''' - словарь ключевых полей и их значений - поиск сработает если все данные совпадут

* '''depth''' - отвечает за глубину поиска в истории, по умолчанию 1, т.е. искать только в последнем сообщении. Возвращает список всех найденных данных, добавляя в каждый элемент depth, т.е. где именно он нашелся

-------

====== '''''Выполнение длительных процедур''''' ======
Код, который будет выполняться дольше нескольких секунд лучше запускать отдельным потоком. В этом случает есть возможность сообщить результат в канал даже после завершения основного диалога. Пример ожидания и отправки файла после паузы:
 from app.interactions import connectors

def do_sleep(params, session_id, channel):
time.sleep(params['sleep_time'])
message="выполнено"
connectors.sendMessage(channel=channel,session=session_id,answers=[{'messages':[message]}],files={'document':(filetame, open(file_path,'rb'))})
def handler(data={}, session_id=None, channel='default'):
params={} #чтото передадим в функцию
params['sleep_time']= 100
Thread(target=do_sleep,name='do_sleep'+str(uuid.uuid4()),args=(params, session_id, channel) ).start()
return { 'text': "запустил задание, ждем результат", 'answered': False }, {}
-------

======'''''Отложенные задания'''''======
Для выполнения отложенных заданий необходимо

#получить ссылку на базу данных текущего робота
#в таблицу "crons" внести внести время и python код который должен выполниться в указанное время.

Пример отложенного сообщения в телеграм: # Формируем задачу в крон

 error, db = get_db(data['robot'])

 if error:

 return { 'text': 'А я тебе ошибку базы данных привез: '+str(db), 'answered': False }, {}

 dt = int(datetime.strptime(date['date']+' '+date['time'],'%Y-%m-%d %H:%M').timestamp())

 

 # А вот тут создадим код для выполнения задачи

 url = f'<nowiki>https://api.telegram.org/bot{token}/sendMessage'</nowiki>

 data = json.dumps({'chat_id': chat_id, 'text': message})

 data = base64.b64encode(data.encode("utf-8")).decode("utf-8")

 code = """

 import requests, json, base64

 try:

 data=\"{1}\"

 data=base64.b64decode(data.encode('utf-8')).decode('utf-8')

 requests.post(\"{0}\", data=json.loads(data), timeout = (5, 10))

 except Exception as error:

 logging.error(traceback.format_exc())

 

 """.format(url,data).replace(" ","")

 error, result = db.create(table='crons',data={

 'id': str(uuid.uuid4()),

 'name':'Задача-напоминание для '+username,

 'datetime': dt,

 'code': code })

-------

======'''''Пользовательские таблицы базы данных'''''======
В составе большинства продуктов используется служебная файловая [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%92%D0%BD%D1%83%D1%82%D1%80%D0%B5%D0%BD%D0%BD%D1%8F%D1%8F_%D0%B1%D0%B0%D0%B7%D0%B0_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D1%85 база данных]. В SES возможно использование служебной базы в скриптах интеграции. Для этого нужно:

'''Импортировать функцию''' получения объекта БД (<code>from app.db import get_db</code>)

'''Получить объект БД''' error, db = get_db(data['robot'])

if error: 
return { 'text': 'ошибка базы данных: '+str(db), 'answered': False }, {}

'''Объявить структуру''' пользовательской таблицы, создав запись в таблице структур (если еще не объявляли) search_data={
"id":"new_table_name"
}
try:
error, search_result = db.select('structures',data=search_data,sort=None,md5clean=True)
if not search_result:
struct_data = {
"id":"new_table_name",
"name": "new_table_name",
"fields": {
"string":"",
"integer":0,
"float":0.0,
"именованный массив":{},
"неименованный массив":[],
"bool":True
}
}
error, str_id = db.create(table='structures', data=struct_data)
'''Сделать запись''' в базе new_data={
"string":"пример строки\n",
"integer":100500,
"float":20.0004,
"именованный массив":{'ключ1':'значение1'},
"неименованный массив":['запись1','запись2',],
"bool":True
}
error, id = db.create(table="new_table_name", data=new_data)

if error:
return { 'text': 'ошибка создания: '+str(db), 'answered': False }, {}
Если при создании структуры не указывать в структуре id то база сама создаст id, вернет его в ответ. В дальнейшем тогда имя новой таблицы будет в id и запись/поиск в базе только по нему. Пример поиска в 'structures' подходит для поиска в пользовательской таблице.

Создание, редактирование и просмотр пользовательской таблицы в базе возможно и с интерфейса UPS.

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

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

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

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

======'''''Методы API'''''======

{| class="wikitable" style="width: 110%"
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses</big>'''
|-
! colspan="3" |для некоторых путей, где используется {robot_id} - это обращение к версии черновика, чтобы обращаться r продовой версии - нужен постфикс "_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: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 робота
| style="width: 50%" |{ "error": 0,

 "question": "Вопрос",

 "answer": [

 { "messages": [

 "ответ" ],

 "voice": "",

 "interruptible": true/false,

"file": "" } ],

 "session": "",

"uuid": "" }
|-
! style="color:green;width: 15%" |'''POST/ses/log'''
! colspan="2" style="width: 85%" |Получение лога всех сессий начиная с date. В логе '''error,''' '''message''' и массив сессий '''log''' (log содержит информацию о каждой сессии и запросы с ответами)
|-
| colspan="2" style="width: 50%" |
*'''date''' - начальная дата в формате %Y-%m-%d
| style="width: 50%" |{ "error": 0, "message": "success",

 "log": [

 {"id": ",.....", "session": "......", "robot": ".....", "channel": "......", 

"unknown": true/false, "closed": true/false, "endpoint": ".....",

 "answered": true/false, "models": [....], "variables": {}, "current": {.......},

 "request": {.......}, "reply": { ..... }, "robot_id": "", "endpointName": "", "endpointType": "" },

 ..... ] }
|-
! 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="2" style="width: 85%" |Отдает конфигурацию виджета скрипту виджета
|-
| colspan="2" style="width: 50%" |
*'''token''' - ключ виджета
| style="width: 50%" |На выходе содержимое настроек web канала из конфигурационного файла
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/robot/<big>'''
|-
! 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:blue;width: 15%" |'''GET/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:blue;width: 15%" |'''GET/ses/robot/cleardraft/{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/ses/robot/commit/{id}'''
! colspan="2" style="width: 85%" |Применение текущих изменений настроек робота. Применимо ко всем версиям (черновик, рабочая, резервная копия)
|-
| colspan="2" style="width: 50%" |
*'''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: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/get/{id}'''
! colspan="2" style="width: 85%" |Выгрузка основных настроек робота
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор робота
| style="width: 50%" |{ "error": 0,

 "data": { "id": ".....", "name": ".....","description": "",

 "voice": "", "session": { "lifetime": 600 },

 "models": {},"servicedata": {},"exceptions": {},"actions": {},

 "holidays": [],

 "timeintervals": {

 "name": {"weekdays": [ ..... ], "dates": [ ..... ], "months": [.....],

<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:blue;width: 15%" |'''GET/ses/robot/restore/{id}'''
! colspan="2" style="width: 85%" |Откат рабочей версии из бэкапа. Резервная копия становится рабочей, и удаляется, а черновик остается без изменений
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор робота
| style="width: 50%" |{ "error": 0,

 "message": "success"}
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/robot/data<big>'''
|-
! 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": ".....", "name": ".....", "comment": "", "type": "smc",

 "rtype": "report", "model": ".....", "param": ".....",

 "script": "", "weight": int, "slaveData": [],

 "getOnlyAsNearest": true/false, "injectToMessage": true/false,

 "longWaiting": true/false, "dataWaiting": [],

<nowiki> "actions": {}, "exceptions": {}}}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/data/list/{robot}'''
! colspan="2" style="width: 85%" |Получение списка элементов данных
|-
| colspan="2" style="width: 50%" |
* '''robot''' - идентификатор робота (id)
| 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"}
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/robot/endpoint<big>'''
|-
! 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": "...", "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"}
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/archive<big>'''
|-
|-
! 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]
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/robot/script<big>'''
|-
! 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%" |
*'''robot''' - идентификатор робота
| 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>
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/robot/files<big>'''
|-
! 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 файла"}
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/testapi''' ''[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#:~:text=%D0%B2%D1%80%D0%B5%D0%BC%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%20%D0%BF%D0%B0%D0%BF%D0%BA%D0%B0-,%D0%AD%D0%BC%D1%83%D0%BB%D1%8F%D1%86%D0%B8%D1%8F%20%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%BE%D0%B2%20%D0%B8%D0%BD%D1%82%D0%B5%D0%B3%D1%80%D0%B0%D1%86%D0%B8%D0%B8,-%5B%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C%20%7C для отладки скриптов интеграции]''
|-
! style="color:blue;width: 15%" |'''GET/ses/testapi/list'''
! colspan="2" style="width: 85%" |Получение списка эмуляторов сервисов интеграции
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |[ "service1",

 "service2",

 "serviceN"]
|-
! style="color:green;width: 15%" |'''POST/ses/testapi/{request}'''
! colspan="2" style="width: 85%" |Получение ответа эмулятора сервиса интеграции
|-
| colspan="2" style="width: 50%" |
*'''request''' - запрос вида <service1>
| style="width: 50%" | "ответ эмулятора"
|-
! style="color:blue;width: 15%" |'''GET/ses/testapi/{request}'''
! colspan="2" style="width: 85%" |Получение ответа эмулятора сервиса интеграции
|-
| colspan="2" style="width: 50%" |
*'''request''' - запрос вида <service1>
| style="width: 50%" | "ответ эмулятора"
|
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/robot/userdata<big>'''
|-
! 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"}
|-

|}

======'''''Постобработка методов api'''''======
Для метода '''POST/ses/ask/{robot_id}''' можно изменить формат данных ответа.

Для этого необходимо подготовить скрипт на python в папке /opt/ses/handlers/api/ask/ . Скрипт должен содержать функцию handler(reply={}), Функция должна вернуть переформатированный ответ. Чтобы воспользоваться скриптом необходимо его имя без разрешения указать в поле "'''handler'''" при запросе метода.

Аналогично и для метода ask websocket протокола - файл положить в /opt/ses/handlers/websockets/ask/ . Далее в любом запросе указать обработчик <code><nowiki>{тут всё, что ты и так отправляешь, 'handlers': { 'ask': '__telegram' }} }</nowiki></code> . начиная с этого запроса обработчик будет действовать в течение сессии пока не отправишь 'handlers': {} . Для других полей запросов в канале websocket аналогично.

В составе поставки ses есть файл примера <code>__telegram.py</code> (префикс 2 подчеркивания - такой файл будет переписан при обновлении, любой другой, останется после обновления)

===== '''Websockets сервер''' =====
Работа с программным продуктом возможна с использованием встроенного websockets сервера. Подключение производится по порту 6191, без SSL. При необходимости работать по SSL перед SES ставится nginx в режиме прокси, и SSL поднимается на nginx. Подробнее см. документацию по nginx.

В таблице ниже приведены форматы сообщений для работы с сервером. В каждом сообщении (за исключением бинарных), присутствует переменная path (формат сообщений - JSON), которая определяет алгоритм обработки сообщения. Подключение к серверу возможно в следующих вариантах:

# ws://адрес:6191
# ws://адрес:6191/session[/chunk]

Первый вариант подходит только для текстовых сообщений, в данном случае передача переменной session (uuid текущей сессии) должна производиться в теле сообщения.

Второй вариант подходит и для текстового и для голосового общения с роботом. В данном случае session передается в пути подключения к websockets-серверу. Для каждой новой сессии нужно открывать новое соединение, chunk в пути подключения нужен в том случае, если передаются не готовые части аудио, предварительно сформированные, а сплошной поток аудио, кусками по 20 мс.

{| class="wikitable" style="width: 110%"
|-
! colspan="3" style="text-align: center" |'''<big>Входящие сообщения'''
|-
! style="color:green;width: 15%" |'''path:ask'''
! colspan="2" style="width: 85%" |Вопрос роботу
|-
| colspan="2" style="width: 50%" |{

 "path": "ask",

 "robot": "f296a3a9-593c-4ed5-a1d3-5d4d46d331bf",

 "session": "77f1af87-6da7-487b-96d2-4e2684704ad5", ''# Необязательный параметр, если не будет отправлен, будет создана новая сессия и в ответе придет сгенерированный session''

 "channel": "default",

 "link": 1, ''# Необязательный параметр, отдает ссылки на аудио, если 1.''

 "format": "wav", ''# Необязательный параметр, формат возвращаемого аудио, если channel=voice''

"document": {"name":"название","base64":"тело документа в base64"}, ''# необязательный параметр''

"handlers": {"ask": "название хэндлера"}, ''# Необязательный параметр, см. [[SES. Руководство администратора|описание обработчиков]]''

 "text": "привет", 

или

"audio": "base64 строка",

}

| style="width: 50%" |Для текстовых ответов (канал не voice)
{ "error": 0,

 "question": "привет",

 "answer": [

 {

 "messages": [

 "Здравствуйте! Как я могу вам помочь сегодня?"

 ],

 "voice": "Валера",

 "interruptible": false,

 "file": null

 }

 ],

 "session": "77f1af87-6da7-487b-96d2-4e2684704ad5",

 "uuid": "83722305-645d-4674-8c5d-952e02f595f9",

 "path": "ask"

}

Для голосовых ответов, канал voice, дополнительно идет отправка N сообщений с аудио

{ "audio": "ссылка или base64 закодированное аудио",

 "session": "77f1af87-6da7-487b-96d2-4e2684704ad5",

 "uuid": "83722305-645d-4674-8c5d-952e02f595f9",

 "status": "listening | asking" ''# Требование к клиенту выставить статус.''

}
|-
!'''path:session'''
! colspan="2" |Статус сессии
|-
| colspan="2" |{

 "path": "session",

 "robot": "f296a3a9-593c-4ed5-a1d3-5d4d46d331bf",

 "session": "548cd1ca-a24a-4a9a-ab4f-8363aa32c3c2"

}

|{ "started": "2025-07-08 07:39:24",

 "modified": "2025-07-08 07:39:26",

 "robot": "f296a3a9-593c-4ed5-a1d3-5d4d46d331bf",

 "session": "548cd1ca-a24a-4a9a-ab4f-8363aa32c3c2",

 "channel": "default",

 "connector": "web",

 "unknown": false,

 "current": {

 "id": null,

 "qas": "",

 "category": null,

 "entry": [],

 "nearest": null,

 "missingRunData": [],

 "waitingRunData": null,

 "answered": false,

 "lastreply": "Здравствуйте! Как я могу вам помочь сегодня?"

 },

 "models": [

 "smc:Рыжик",

 "see:Серверы",

 "see:fio"

 ],

 "scripts": [],

 "data": [

 {

 "request": {

 "datetime": "2025-07-08T07:39:24.706771",

 "message": "привет",

 "data": []

 },

 "reply": {

 "answers": [

 {

 "messages": [

 "Здравствуйте! Как я могу вам помочь сегодня?"

 ],

 "voice": "Валера",

 "interruptible": false,

 "file": null

 }

 ],

 "datetime": "2025-07-08T07:39:26.269201",

 "answered": false

 }

 }

 ],

 "timers": [],

 "variables": {},

 "error": "",

 "events": {

 "not found": {

 "counter": 1

 },

 "no data": {

 "id": null,

 "counter": 0

 },

 "silence": {

 "id": null,

 "counter": 0

 }

 },

 "path": "session"

}
|-
!'''path:status'''
! colspan="2" |Установка статуса клиентской части. Используется в голосовом канале, для установки текущего статуса клиентской части. В случае использования режима активного слушания в момент речи робота, необходимо выставлять на клиентской части статус asking.
|-
| colspan="2" |{

 "path": "status",

 "value": "listening | asking",

 "session": "77f1af87-6da7-487b-96d2-4e2684704ad5"

}

|<nowiki>{ "error": 0, "message": "success", "value": "listening | asking", "session": "77f1af87-6da7-487b-96d2-4e2684704ad5" }</nowiki>
|-
!'''path:interrupted'''
! colspan="2" |Уведомление о прерывании текущего сообщения робота пользователем.
|-
| colspan="2" |{

 "path": "interrupted",

 "session": "77f1af87-6da7-487b-96d2-4e2684704ad5"

}
|
|-
!'''path:hangup'''
! colspan="2" |Завершение сессии с роботом.
|-
| colspan="2" |{

 "path": "hangup",

 "value": "user | robot",

 "session": "77f1af87-6da7-487b-96d2-4e2684704ad5"

}
|<nowiki>{ "error": 0, "message": "success", "value": "user | robot", "session": "77f1af87-6da7-487b-96d2-4e2684704ad5" }</nowiki>
|}
Со стороны сервера возможны самостоятельные сообщения типов ask и hangup в формате, аналогичном приведенному в таблице выше.

Работа с сервером возможна с поточной передачей аудио в сторону сервера. В данном режиме ответы от сервера будут со ссылками на аудио, которое должно быть воспроизведено на стороне клиента (см. таблицу выше). Формат принимаемого потока аудио: pcm, 8кГц, 16 бит, размер куска аудио - 20 мс.

Аудио отправляется бинарным сообщением по ссылке ws://адрес/код сессии/chunk.

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

2025-07-08T09:18:41Z

Ka.shapovalov: /* Websockets сервер */

===== '''Общее описание''' =====
Сервис предназначен для создания сценарных машин и обеспечения их работы.

===== '''Термины и определения''' =====
Script engine service (SES) - сервис обеспечения работы и создания сценарных машин. Swagger UI – интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису SES в реальном времени

===== '''Скрипты интеграции''' =====
Для взаимодействия со сторонними сервисами используются скрипты интеграции на языке python. Скрипт интеграции должен содержать функцию '''handler'''(data={}, session_id=None, channel='default').

Пример данных на входе можно посмотреть в методе ses GET/ses/session/{robot_id}/{session_id}

Функция должна исходя из полученных данных запросить ответ у стороннего сервиса. Запрос необходимо выполнить в блоке try/except. Скрипт не должен выдавать ошибку в основное приложение, все исключения должны быть обработаны внутри скрипта.

-------

====== '''''Функция apiRequest''''' ======
'''''Для отправки запроса рекомендуется использовать функцию apiRequest.''''' Функция сделает все необходимые записи в лог интеграции. Пример:

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

<code>status, reply = apiRequest(name="наименование скрипта",method='get',sessiondata=data,url=url,timeout=(1,10))</code>

* '''status, reply''' - http код ответа (например 200) и ответ без изменений и сериализации.

* '''name''' = название вызываемого метода, для отчетности

* '''sessiondata''' - это data в handler, которая туда прилетает

* '''method''' - метод запроса-ответа

после этих параметров в функцию '''apiRequest''' отправить все нужные параметры, как при вызове requests, они будут переданы один к одному.

Из функции '''handler''' можно передать или изменить переменную (в рамках текущей сессии): <code>data['variables']={'new_var': 'новое_значение'}</code>

Функция '''handler''' должна возвращать ответ в виде <code>return { "text": "Текст ответа.", 'answered': True}, {}</code>

* '''text''' - текст ответа

* '''answered''' - получен ли ответ (True или False)
Если в скрипте интеграции не используются запросы к api стороннего сервиса через http, необходимо предусмотреть запись в лог (запись в лог встроена в функцию '''apiRequest''' и при ее использовании отдельно писать в лог не надо). Для этого необходимо импортировать библиотеку:

from app.tools import apiLog

-------

====== '''''Функция apiLog''''' ======
'''''Если в скрипте интеграции не используются запросы к api, по окончании работы функции handler вызвать функцию записи лога:'''''

'''apiLog'''(data=data,name="",url="",request={},reply_code=200,reply=None,request_datetime=None,reply_datetime=None)

* '''data''' - тот же массив который был на входе

* '''name''' - наименование или короткое описание скрипта

* '''url''' - адрес запроса к стороннему сервису (если есть)

* '''request''' - текст запроса

* '''reply_code''' - код ответа (стандартный код http)

* '''reply''' - необработанный ответ стороннего сервиса

* '''request_datetime''' - время перед запросом, без учета таймзоны, получить лучше так request_datetime=datetime.now(timezone.utc)

* '''reply_datetime''' - время сразу по получению ответа, также без учета таймзоны. Внимание - не используйте '''apiRequest или apiLog''' для данных содержащих пароли в открытом виде, чтобы они не попали в лог

-------

====== '''''Функция getData''''' ======
'''''Для упрощения поиска информации можно использовать функцию getData''''' (''from app.tools import getData''), нужна для извлечения конкретных данных из сессии, можно отправить либо всю переменную сессии, либо 'data' из сессии. Пример поиска цифрового кода заявления, выявленного моделью see 'number', поиск только в последнем сообщении диалога:

<code>for j in getData(data=data,filter={'type':'see','model':'number'},depth=1):</code>

<code>kod_zayavl=str(int(j['param']))</code>

<code>break</code>

Параметры функции

* '''data''' - или 'data' из сессии или переменная сессии

* '''filter''' - словарь ключевых полей и их значений - поиск сработает если все данные совпадут

* '''depth''' - отвечает за глубину поиска в истории, по умолчанию 1, т.е. искать только в последнем сообщении. Возвращает список всех найденных данных, добавляя в каждый элемент depth, т.е. где именно он нашелся

-------

====== '''''Выполнение длительных процедур''''' ======
Код, который будет выполняться дольше нескольких секунд лучше запускать отдельным потоком. В этом случает есть возможность сообщить результат в канал даже после завершения основного диалога. Пример ожидания и отправки файла после паузы:
 from app.interactions import connectors

def do_sleep(params, session_id, channel):
time.sleep(params['sleep_time'])
message="выполнено"
connectors.sendMessage(channel=channel,session=session_id,answers=[{'messages':[message]}],files={'document':(filetame, open(file_path,'rb'))})
def handler(data={}, session_id=None, channel='default'):
params={} #чтото передадим в функцию
params['sleep_time']= 100
Thread(target=do_sleep,name='do_sleep'+str(uuid.uuid4()),args=(params, session_id, channel) ).start()
return { 'text': "запустил задание, ждем результат", 'answered': False }, {}
-------

======'''''Отложенные задания'''''======
Для выполнения отложенных заданий необходимо

#получить ссылку на базу данных текущего робота
#в таблицу "crons" внести внести время и python код который должен выполниться в указанное время.

Пример отложенного сообщения в телеграм: # Формируем задачу в крон

 error, db = get_db(data['robot'])

 if error:

 return { 'text': 'А я тебе ошибку базы данных привез: '+str(db), 'answered': False }, {}

 dt = int(datetime.strptime(date['date']+' '+date['time'],'%Y-%m-%d %H:%M').timestamp())

 

 # А вот тут создадим код для выполнения задачи

 url = f'<nowiki>https://api.telegram.org/bot{token}/sendMessage'</nowiki>

 data = json.dumps({'chat_id': chat_id, 'text': message})

 data = base64.b64encode(data.encode("utf-8")).decode("utf-8")

 code = """

 import requests, json, base64

 try:

 data=\"{1}\"

 data=base64.b64decode(data.encode('utf-8')).decode('utf-8')

 requests.post(\"{0}\", data=json.loads(data), timeout = (5, 10))

 except Exception as error:

 logging.error(traceback.format_exc())

 

 """.format(url,data).replace(" ","")

 error, result = db.create(table='crons',data={

 'id': str(uuid.uuid4()),

 'name':'Задача-напоминание для '+username,

 'datetime': dt,

 'code': code })

-------

======'''''Пользовательские таблицы базы данных'''''======
В составе большинства продуктов используется служебная файловая [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%92%D0%BD%D1%83%D1%82%D1%80%D0%B5%D0%BD%D0%BD%D1%8F%D1%8F_%D0%B1%D0%B0%D0%B7%D0%B0_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D1%85 база данных]. В SES возможно использование служебной базы в скриптах интеграции. Для этого нужно:

'''Импортировать функцию''' получения объекта БД (<code>from app.db import get_db</code>)

'''Получить объект БД''' error, db = get_db(data['robot'])

if error: 
return { 'text': 'ошибка базы данных: '+str(db), 'answered': False }, {}

'''Объявить структуру''' пользовательской таблицы, создав запись в таблице структур (если еще не объявляли) search_data={
"id":"new_table_name"
}
try:
error, search_result = db.select('structures',data=search_data,sort=None,md5clean=True)
if not search_result:
struct_data = {
"id":"new_table_name",
"name": "new_table_name",
"fields": {
"string":"",
"integer":0,
"float":0.0,
"именованный массив":{},
"неименованный массив":[],
"bool":True
}
}
error, str_id = db.create(table='structures', data=struct_data)
'''Сделать запись''' в базе new_data={
"string":"пример строки\n",
"integer":100500,
"float":20.0004,
"именованный массив":{'ключ1':'значение1'},
"неименованный массив":['запись1','запись2',],
"bool":True
}
error, id = db.create(table="new_table_name", data=new_data)

if error:
return { 'text': 'ошибка создания: '+str(db), 'answered': False }, {}
Если при создании структуры не указывать в структуре id то база сама создаст id, вернет его в ответ. В дальнейшем тогда имя новой таблицы будет в id и запись/поиск в базе только по нему. Пример поиска в 'structures' подходит для поиска в пользовательской таблице.

Создание, редактирование и просмотр пользовательской таблицы в базе возможно и с интерфейса UPS.

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

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

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

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

======'''''Методы API'''''======

{| class="wikitable" style="width: 110%"
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses</big>'''
|-
! colspan="3" |для некоторых путей, где используется {robot_id} - это обращение к версии черновика, чтобы обращаться r продовой версии - нужен постфикс "_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: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 робота
| style="width: 50%" |{ "error": 0,

 "question": "Вопрос",

 "answer": [

 { "messages": [

 "ответ" ],

 "voice": "",

 "interruptible": true/false,

"file": "" } ],

 "session": "",

"uuid": "" }
|-
! style="color:green;width: 15%" |'''POST/ses/log'''
! colspan="2" style="width: 85%" |Получение лога всех сессий начиная с date. В логе '''error,''' '''message''' и массив сессий '''log''' (log содержит информацию о каждой сессии и запросы с ответами)
|-
| colspan="2" style="width: 50%" |
*'''date''' - начальная дата в формате %Y-%m-%d
| style="width: 50%" |{ "error": 0, "message": "success",

 "log": [

 {"id": ",.....", "session": "......", "robot": ".....", "channel": "......", 

"unknown": true/false, "closed": true/false, "endpoint": ".....",

 "answered": true/false, "models": [....], "variables": {}, "current": {.......},

 "request": {.......}, "reply": { ..... }, "robot_id": "", "endpointName": "", "endpointType": "" },

 ..... ] }
|-
! 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="2" style="width: 85%" |Отдает конфигурацию виджета скрипту виджета
|-
| colspan="2" style="width: 50%" |
*'''token''' - ключ виджета
| style="width: 50%" |На выходе содержимое настроек web канала из конфигурационного файла
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/robot/<big>'''
|-
! 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:blue;width: 15%" |'''GET/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:blue;width: 15%" |'''GET/ses/robot/cleardraft/{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/ses/robot/commit/{id}'''
! colspan="2" style="width: 85%" |Применение текущих изменений настроек робота. Применимо ко всем версиям (черновик, рабочая, резервная копия)
|-
| colspan="2" style="width: 50%" |
*'''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: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/get/{id}'''
! colspan="2" style="width: 85%" |Выгрузка основных настроек робота
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор робота
| style="width: 50%" |{ "error": 0,

 "data": { "id": ".....", "name": ".....","description": "",

 "voice": "", "session": { "lifetime": 600 },

 "models": {},"servicedata": {},"exceptions": {},"actions": {},

 "holidays": [],

 "timeintervals": {

 "name": {"weekdays": [ ..... ], "dates": [ ..... ], "months": [.....],

<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:blue;width: 15%" |'''GET/ses/robot/restore/{id}'''
! colspan="2" style="width: 85%" |Откат рабочей версии из бэкапа. Резервная копия становится рабочей, и удаляется, а черновик остается без изменений
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор робота
| style="width: 50%" |{ "error": 0,

 "message": "success"}
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/robot/data<big>'''
|-
! 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": ".....", "name": ".....", "comment": "", "type": "smc",

 "rtype": "report", "model": ".....", "param": ".....",

 "script": "", "weight": int, "slaveData": [],

 "getOnlyAsNearest": true/false, "injectToMessage": true/false,

 "longWaiting": true/false, "dataWaiting": [],

<nowiki> "actions": {}, "exceptions": {}}}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/data/list/{robot}'''
! colspan="2" style="width: 85%" |Получение списка элементов данных
|-
| colspan="2" style="width: 50%" |
* '''robot''' - идентификатор робота (id)
| 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"}
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/robot/endpoint<big>'''
|-
! 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": "...", "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"}
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/archive<big>'''
|-
|-
! 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]
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/robot/script<big>'''
|-
! 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%" |
*'''robot''' - идентификатор робота
| 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>
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/robot/files<big>'''
|-
! 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 файла"}
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/testapi''' ''[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#:~:text=%D0%B2%D1%80%D0%B5%D0%BC%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%20%D0%BF%D0%B0%D0%BF%D0%BA%D0%B0-,%D0%AD%D0%BC%D1%83%D0%BB%D1%8F%D1%86%D0%B8%D1%8F%20%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%BE%D0%B2%20%D0%B8%D0%BD%D1%82%D0%B5%D0%B3%D1%80%D0%B0%D1%86%D0%B8%D0%B8,-%5B%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C%20%7C для отладки скриптов интеграции]''
|-
! style="color:blue;width: 15%" |'''GET/ses/testapi/list'''
! colspan="2" style="width: 85%" |Получение списка эмуляторов сервисов интеграции
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |[ "service1",

 "service2",

 "serviceN"]
|-
! style="color:green;width: 15%" |'''POST/ses/testapi/{request}'''
! colspan="2" style="width: 85%" |Получение ответа эмулятора сервиса интеграции
|-
| colspan="2" style="width: 50%" |
*'''request''' - запрос вида <service1>
| style="width: 50%" | "ответ эмулятора"
|-
! style="color:blue;width: 15%" |'''GET/ses/testapi/{request}'''
! colspan="2" style="width: 85%" |Получение ответа эмулятора сервиса интеграции
|-
| colspan="2" style="width: 50%" |
*'''request''' - запрос вида <service1>
| style="width: 50%" | "ответ эмулятора"
|
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/robot/userdata<big>'''
|-
! 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"}
|-

|}

======'''''Постобработка методов api'''''======
Для метода '''POST/ses/ask/{robot_id}''' можно изменить формат данных ответа.

Для этого необходимо подготовить скрипт на python в папке /opt/ses/handlers/api/ask/ . Скрипт должен содержать функцию handler(reply={}), Функция должна вернуть переформатированный ответ. Чтобы воспользоваться скриптом необходимо его имя без разрешения указать в поле "'''handler'''" при запросе метода.

Аналогично и для метода ask websocket протокола - файл положить в /opt/ses/handlers/websockets/ask/ . Далее в любом запросе указать обработчик <code><nowiki>{тут всё, что ты и так отправляешь, 'handlers': { 'ask': '__telegram' }} }</nowiki></code> . начиная с этого запроса обработчик будет действовать в течение сессии пока не отправишь 'handlers': {} . Для других полей запросов в канале websocket аналогично.

В составе поставки ses есть файл примера <code>__telegram.py</code> (префикс 2 подчеркивания - такой файл будет переписан при обновлении, любой другой, останется после обновления)

===== '''Websockets сервер''' =====
Работа с программным продуктом возможна с использованием встроенного websockets сервера. Подключение производится по порту 6191, без SSL. При необходимости работать по SSL перед SES ставится nginx в режиме прокси, и SSL поднимается на nginx. Подробнее см. документацию по nginx.

В таблице ниже приведены форматы сообщений для работы с сервером. В каждом сообщении (за исключением бинарных), присутствует переменная path (формат сообщений - JSON), которая определяет алгоритм обработки сообщения. Подключение к серверу возможно в следующих вариантах:

# ws://адрес:6191
# ws://адрес:6191/session[/chunk]

Первый вариант подходит только для текстовых сообщений, в данном случае передача переменной session (uuid текущей сессии) должна производиться в теле сообщения.

Второй вариант подходит и для текстового и для голосового общения с роботом. В данном случае session передается в пути подключения к websockets-серверу. Для каждой новой сессии нужно открывать новое соединение, chunk в пути подключения нужен в том случае, если передаются не готовые части аудио, предварительно сформированные, а сплошной поток аудио, кусками по 20 мс.

{| class="wikitable" style="width: 110%"
|-
! colspan="3" style="text-align: center" |'''<big>Входящие сообщения'''
|-
! style="color:green;width: 15%" |'''path:ask'''
! colspan="2" style="width: 85%" |Вопрос роботу
|-
| colspan="2" style="width: 50%" |{

 "path": "ask",

 "robot": "f296a3a9-593c-4ed5-a1d3-5d4d46d331bf",

 "session": "77f1af87-6da7-487b-96d2-4e2684704ad5",

 "channel": "default",

 "link": 1, ''# Необязательный параметр, отдает ссылки на аудио, если 1.''

 "format": "wav", ''# Необязательный параметр, формат возвращаемого аудио, если channel=voice''

"document": {"name":"название","base64":"тело документа в base64"}, ''# необязательный параметр''

"handlers": {"ask": "название хэндлера"}, ''# Необязательный параметр, см. [[SES. Руководство администратора|описание обработчиков]]''

 "text": "привет", 

или

"audio": "base64 строка",

}

| style="width: 50%" |Для текстовых ответов (канал не voice)
{ "error": 0,

 "question": "привет",

 "answer": [

 {

 "messages": [

 "Здравствуйте! Как я могу вам помочь сегодня?"

 ],

 "voice": "Валера",

 "interruptible": false,

 "file": null

 }

 ],

 "session": "77f1af87-6da7-487b-96d2-4e2684704ad5",

 "uuid": "83722305-645d-4674-8c5d-952e02f595f9",

 "path": "ask"

}

Для голосовых ответов, канал voice, дополнительно идет отправка N сообщений с аудио

{ "audio": "ссылка или base64 закодированное аудио",

 "session": "77f1af87-6da7-487b-96d2-4e2684704ad5",

 "uuid": "83722305-645d-4674-8c5d-952e02f595f9",

 "status": "listening | asking" ''# Требование к клиенту выставить статус.''

}
|-
!'''path:session'''
! colspan="2" |Статус сессии
|-
| colspan="2" |{

 "path": "session",

 "robot": "f296a3a9-593c-4ed5-a1d3-5d4d46d331bf",

 "session": "548cd1ca-a24a-4a9a-ab4f-8363aa32c3c2"

}

|{ "started": "2025-07-08 07:39:24",

 "modified": "2025-07-08 07:39:26",

 "robot": "f296a3a9-593c-4ed5-a1d3-5d4d46d331bf",

 "session": "548cd1ca-a24a-4a9a-ab4f-8363aa32c3c2",

 "channel": "default",

 "connector": "web",

 "unknown": false,

 "current": {

 "id": null,

 "qas": "",

 "category": null,

 "entry": [],

 "nearest": null,

 "missingRunData": [],

 "waitingRunData": null,

 "answered": false,

 "lastreply": "Здравствуйте! Как я могу вам помочь сегодня?"

 },

 "models": [

 "smc:Рыжик",

 "see:Серверы",

 "see:fio"

 ],

 "scripts": [],

 "data": [

 {

 "request": {

 "datetime": "2025-07-08T07:39:24.706771",

 "message": "привет",

 "data": []

 },

 "reply": {

 "answers": [

 {

 "messages": [

 "Здравствуйте! Как я могу вам помочь сегодня?"

 ],

 "voice": "Валера",

 "interruptible": false,

 "file": null

 }

 ],

 "datetime": "2025-07-08T07:39:26.269201",

 "answered": false

 }

 }

 ],

 "timers": [],

 "variables": {},

 "error": "",

 "events": {

 "not found": {

 "counter": 1

 },

 "no data": {

 "id": null,

 "counter": 0

 },

 "silence": {

 "id": null,

 "counter": 0

 }

 },

 "path": "session"

}
|-
!'''path:status'''
! colspan="2" |Установка статуса клиентской части. Используется в голосовом канале, для установки текущего статуса клиентской части. В случае использования режима активного слушания в момент речи робота, необходимо выставлять на клиентской части статус asking.
|-
| colspan="2" |{

 "path": "status",

 "value": "listening | asking",

 "session": "77f1af87-6da7-487b-96d2-4e2684704ad5"

}

|<nowiki>{ "error": 0, "message": "success", "value": "listening | asking", "session": "77f1af87-6da7-487b-96d2-4e2684704ad5" }</nowiki>
|-
!'''path:interrupted'''
! colspan="2" |Уведомление о прерывании текущего сообщения робота пользователем.
|-
| colspan="2" |{

 "path": "interrupted",

 "session": "77f1af87-6da7-487b-96d2-4e2684704ad5"

}
|
|-
!'''path:hangup'''
! colspan="2" |Завершение сессии с роботом.
|-
| colspan="2" |{

 "path": "hangup",

 "value": "user | robot",

 "session": "77f1af87-6da7-487b-96d2-4e2684704ad5"

}
|<nowiki>{ "error": 0, "message": "success", "value": "user | robot", "session": "77f1af87-6da7-487b-96d2-4e2684704ad5" }</nowiki>
|}
Со стороны сервера возможны самостоятельные сообщения типов ask и hangup в формате, аналогичном приведенному в таблице выше.

Работа с сервером возможна с поточной передачей аудио в сторону сервера. В данном режиме ответы от сервера будут со ссылками на аудио, которое должно быть воспроизведено на стороне клиента (см. таблицу выше). Формат принимаемого потока аудио: pcm, 8кГц, 16 бит, размер куска аудио - 20 мс.

Аудио отправляется бинарным сообщением по ссылке ws://адрес/код сессии/chunk.

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

2025-07-08T07:44:58Z

Ka.shapovalov: /* Описание методов API */

===== '''Общее описание''' =====
Сервис предназначен для создания сценарных машин и обеспечения их работы.

===== '''Термины и определения''' =====
Script engine service (SES) - сервис обеспечения работы и создания сценарных машин. Swagger UI – интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису SES в реальном времени

===== '''Скрипты интеграции''' =====
Для взаимодействия со сторонними сервисами используются скрипты интеграции на языке python. Скрипт интеграции должен содержать функцию '''handler'''(data={}, session_id=None, channel='default').

Пример данных на входе можно посмотреть в методе ses GET/ses/session/{robot_id}/{session_id}

Функция должна исходя из полученных данных запросить ответ у стороннего сервиса. Запрос необходимо выполнить в блоке try/except. Скрипт не должен выдавать ошибку в основное приложение, все исключения должны быть обработаны внутри скрипта.

-------

====== '''''Функция apiRequest''''' ======
'''''Для отправки запроса рекомендуется использовать функцию apiRequest.''''' Функция сделает все необходимые записи в лог интеграции. Пример:

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

<code>status, reply = apiRequest(name="наименование скрипта",method='get',sessiondata=data,url=url,timeout=(1,10))</code>

* '''status, reply''' - http код ответа (например 200) и ответ без изменений и сериализации.

* '''name''' = название вызываемого метода, для отчетности

* '''sessiondata''' - это data в handler, которая туда прилетает

* '''method''' - метод запроса-ответа

после этих параметров в функцию '''apiRequest''' отправить все нужные параметры, как при вызове requests, они будут переданы один к одному.

Из функции '''handler''' можно передать или изменить переменную (в рамках текущей сессии): <code>data['variables']={'new_var': 'новое_значение'}</code>

Функция '''handler''' должна возвращать ответ в виде <code>return { "text": "Текст ответа.", 'answered': True}, {}</code>

* '''text''' - текст ответа

* '''answered''' - получен ли ответ (True или False)
Если в скрипте интеграции не используются запросы к api стороннего сервиса через http, необходимо предусмотреть запись в лог (запись в лог встроена в функцию '''apiRequest''' и при ее использовании отдельно писать в лог не надо). Для этого необходимо импортировать библиотеку:

from app.tools import apiLog

-------

====== '''''Функция apiLog''''' ======
'''''Если в скрипте интеграции не используются запросы к api, по окончании работы функции handler вызвать функцию записи лога:'''''

'''apiLog'''(data=data,name="",url="",request={},reply_code=200,reply=None,request_datetime=None,reply_datetime=None)

* '''data''' - тот же массив который был на входе

* '''name''' - наименование или короткое описание скрипта

* '''url''' - адрес запроса к стороннему сервису (если есть)

* '''request''' - текст запроса

* '''reply_code''' - код ответа (стандартный код http)

* '''reply''' - необработанный ответ стороннего сервиса

* '''request_datetime''' - время перед запросом, без учета таймзоны, получить лучше так request_datetime=datetime.now(timezone.utc)

* '''reply_datetime''' - время сразу по получению ответа, также без учета таймзоны. Внимание - не используйте '''apiRequest или apiLog''' для данных содержащих пароли в открытом виде, чтобы они не попали в лог

-------

====== '''''Функция getData''''' ======
'''''Для упрощения поиска информации можно использовать функцию getData''''' (''from app.tools import getData''), нужна для извлечения конкретных данных из сессии, можно отправить либо всю переменную сессии, либо 'data' из сессии. Пример поиска цифрового кода заявления, выявленного моделью see 'number', поиск только в последнем сообщении диалога:

<code>for j in getData(data=data,filter={'type':'see','model':'number'},depth=1):</code>

<code>kod_zayavl=str(int(j['param']))</code>

<code>break</code>

Параметры функции

* '''data''' - или 'data' из сессии или переменная сессии

* '''filter''' - словарь ключевых полей и их значений - поиск сработает если все данные совпадут

* '''depth''' - отвечает за глубину поиска в истории, по умолчанию 1, т.е. искать только в последнем сообщении. Возвращает список всех найденных данных, добавляя в каждый элемент depth, т.е. где именно он нашелся

-------

====== '''''Выполнение длительных процедур''''' ======
Код, который будет выполняться дольше нескольких секунд лучше запускать отдельным потоком. В этом случает есть возможность сообщить результат в канал даже после завершения основного диалога. Пример ожидания и отправки файла после паузы:
 from app.interactions import connectors

def do_sleep(params, session_id, channel):
time.sleep(params['sleep_time'])
message="выполнено"
connectors.sendMessage(channel=channel,session=session_id,answers=[{'messages':[message]}],files={'document':(filetame, open(file_path,'rb'))})
def handler(data={}, session_id=None, channel='default'):
params={} #чтото передадим в функцию
params['sleep_time']= 100
Thread(target=do_sleep,name='do_sleep'+str(uuid.uuid4()),args=(params, session_id, channel) ).start()
return { 'text': "запустил задание, ждем результат", 'answered': False }, {}
-------

======'''''Отложенные задания'''''======
Для выполнения отложенных заданий необходимо

#получить ссылку на базу данных текущего робота
#в таблицу "crons" внести внести время и python код который должен выполниться в указанное время.

Пример отложенного сообщения в телеграм: # Формируем задачу в крон

 error, db = get_db(data['robot'])

 if error:

 return { 'text': 'А я тебе ошибку базы данных привез: '+str(db), 'answered': False }, {}

 dt = int(datetime.strptime(date['date']+' '+date['time'],'%Y-%m-%d %H:%M').timestamp())

 

 # А вот тут создадим код для выполнения задачи

 url = f'<nowiki>https://api.telegram.org/bot{token}/sendMessage'</nowiki>

 data = json.dumps({'chat_id': chat_id, 'text': message})

 data = base64.b64encode(data.encode("utf-8")).decode("utf-8")

 code = """

 import requests, json, base64

 try:

 data=\"{1}\"

 data=base64.b64decode(data.encode('utf-8')).decode('utf-8')

 requests.post(\"{0}\", data=json.loads(data), timeout = (5, 10))

 except Exception as error:

 logging.error(traceback.format_exc())

 

 """.format(url,data).replace(" ","")

 error, result = db.create(table='crons',data={

 'id': str(uuid.uuid4()),

 'name':'Задача-напоминание для '+username,

 'datetime': dt,

 'code': code })

-------

======'''''Пользовательские таблицы базы данных'''''======
В составе большинства продуктов используется служебная файловая [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%92%D0%BD%D1%83%D1%82%D1%80%D0%B5%D0%BD%D0%BD%D1%8F%D1%8F_%D0%B1%D0%B0%D0%B7%D0%B0_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D1%85 база данных]. В SES возможно использование служебной базы в скриптах интеграции. Для этого нужно:

'''Импортировать функцию''' получения объекта БД (<code>from app.db import get_db</code>)

'''Получить объект БД''' error, db = get_db(data['robot'])

if error: 
return { 'text': 'ошибка базы данных: '+str(db), 'answered': False }, {}

'''Объявить структуру''' пользовательской таблицы, создав запись в таблице структур (если еще не объявляли) search_data={
"id":"new_table_name"
}
try:
error, search_result = db.select('structures',data=search_data,sort=None,md5clean=True)
if not search_result:
struct_data = {
"id":"new_table_name",
"name": "new_table_name",
"fields": {
"string":"",
"integer":0,
"float":0.0,
"именованный массив":{},
"неименованный массив":[],
"bool":True
}
}
error, str_id = db.create(table='structures', data=struct_data)
'''Сделать запись''' в базе new_data={
"string":"пример строки\n",
"integer":100500,
"float":20.0004,
"именованный массив":{'ключ1':'значение1'},
"неименованный массив":['запись1','запись2',],
"bool":True
}
error, id = db.create(table="new_table_name", data=new_data)

if error:
return { 'text': 'ошибка создания: '+str(db), 'answered': False }, {}
Если при создании структуры не указывать в структуре id то база сама создаст id, вернет его в ответ. В дальнейшем тогда имя новой таблицы будет в id и запись/поиск в базе только по нему. Пример поиска в 'structures' подходит для поиска в пользовательской таблице.

Создание, редактирование и просмотр пользовательской таблицы в базе возможно и с интерфейса UPS.

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

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

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

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

======'''''Методы API'''''======

{| class="wikitable" style="width: 110%"
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses</big>'''
|-
! colspan="3" |для некоторых путей, где используется {robot_id} - это обращение к версии черновика, чтобы обращаться r продовой версии - нужен постфикс "_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: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 робота
| style="width: 50%" |{ "error": 0,

 "question": "Вопрос",

 "answer": [

 { "messages": [

 "ответ" ],

 "voice": "",

 "interruptible": true/false,

"file": "" } ],

 "session": "",

"uuid": "" }
|-
! style="color:green;width: 15%" |'''POST/ses/log'''
! colspan="2" style="width: 85%" |Получение лога всех сессий начиная с date. В логе '''error,''' '''message''' и массив сессий '''log''' (log содержит информацию о каждой сессии и запросы с ответами)
|-
| colspan="2" style="width: 50%" |
*'''date''' - начальная дата в формате %Y-%m-%d
| style="width: 50%" |{ "error": 0, "message": "success",

 "log": [

 {"id": ",.....", "session": "......", "robot": ".....", "channel": "......", 

"unknown": true/false, "closed": true/false, "endpoint": ".....",

 "answered": true/false, "models": [....], "variables": {}, "current": {.......},

 "request": {.......}, "reply": { ..... }, "robot_id": "", "endpointName": "", "endpointType": "" },

 ..... ] }
|-
! 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="2" style="width: 85%" |Отдает конфигурацию виджета скрипту виджета
|-
| colspan="2" style="width: 50%" |
*'''token''' - ключ виджета
| style="width: 50%" |На выходе содержимое настроек web канала из конфигурационного файла
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/robot/<big>'''
|-
! 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:blue;width: 15%" |'''GET/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:blue;width: 15%" |'''GET/ses/robot/cleardraft/{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/ses/robot/commit/{id}'''
! colspan="2" style="width: 85%" |Применение текущих изменений настроек робота. Применимо ко всем версиям (черновик, рабочая, резервная копия)
|-
| colspan="2" style="width: 50%" |
*'''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: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/get/{id}'''
! colspan="2" style="width: 85%" |Выгрузка основных настроек робота
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор робота
| style="width: 50%" |{ "error": 0,

 "data": { "id": ".....", "name": ".....","description": "",

 "voice": "", "session": { "lifetime": 600 },

 "models": {},"servicedata": {},"exceptions": {},"actions": {},

 "holidays": [],

 "timeintervals": {

 "name": {"weekdays": [ ..... ], "dates": [ ..... ], "months": [.....],

<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:blue;width: 15%" |'''GET/ses/robot/restore/{id}'''
! colspan="2" style="width: 85%" |Откат рабочей версии из бэкапа. Резервная копия становится рабочей, и удаляется, а черновик остается без изменений
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор робота
| style="width: 50%" |{ "error": 0,

 "message": "success"}
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/robot/data<big>'''
|-
! 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": ".....", "name": ".....", "comment": "", "type": "smc",

 "rtype": "report", "model": ".....", "param": ".....",

 "script": "", "weight": int, "slaveData": [],

 "getOnlyAsNearest": true/false, "injectToMessage": true/false,

 "longWaiting": true/false, "dataWaiting": [],

<nowiki> "actions": {}, "exceptions": {}}}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/data/list/{robot}'''
! colspan="2" style="width: 85%" |Получение списка элементов данных
|-
| colspan="2" style="width: 50%" |
* '''robot''' - идентификатор робота (id)
| 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"}
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/robot/endpoint<big>'''
|-
! 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": "...", "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"}
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/archive<big>'''
|-
|-
! 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]
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/robot/script<big>'''
|-
! 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%" |
*'''robot''' - идентификатор робота
| 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>
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/robot/files<big>'''
|-
! 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 файла"}
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/testapi''' ''[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#:~:text=%D0%B2%D1%80%D0%B5%D0%BC%D0%B5%D0%BD%D0%BD%D0%B0%D1%8F%20%D0%BF%D0%B0%D0%BF%D0%BA%D0%B0-,%D0%AD%D0%BC%D1%83%D0%BB%D1%8F%D1%86%D0%B8%D1%8F%20%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%BE%D0%B2%20%D0%B8%D0%BD%D1%82%D0%B5%D0%B3%D1%80%D0%B0%D1%86%D0%B8%D0%B8,-%5B%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C%20%7C для отладки скриптов интеграции]''
|-
! style="color:blue;width: 15%" |'''GET/ses/testapi/list'''
! colspan="2" style="width: 85%" |Получение списка эмуляторов сервисов интеграции
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |[ "service1",

 "service2",

 "serviceN"]
|-
! style="color:green;width: 15%" |'''POST/ses/testapi/{request}'''
! colspan="2" style="width: 85%" |Получение ответа эмулятора сервиса интеграции
|-
| colspan="2" style="width: 50%" |
*'''request''' - запрос вида <service1>
| style="width: 50%" | "ответ эмулятора"
|-
! style="color:blue;width: 15%" |'''GET/ses/testapi/{request}'''
! colspan="2" style="width: 85%" |Получение ответа эмулятора сервиса интеграции
|-
| colspan="2" style="width: 50%" |
*'''request''' - запрос вида <service1>
| style="width: 50%" | "ответ эмулятора"
|
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов ses/robot/userdata<big>'''
|-
! 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"}
|-

|}

======'''''Постобработка методов api'''''======
Для метода '''POST/ses/ask/{robot_id}''' можно изменить формат данных ответа.

Для этого необходимо подготовить скрипт на python в папке /opt/ses/handlers/api/ask/ . Скрипт должен содержать функцию handler(reply={}), Функция должна вернуть переформатированный ответ. Чтобы воспользоваться скриптом необходимо его имя без разрешения указать в поле "'''handler'''" при запросе метода.

Аналогично и для метода ask websocket протокола - файл положить в /opt/ses/handlers/websockets/ask/ . Далее в любом запросе указать обработчик <code><nowiki>{тут всё, что ты и так отправляешь, 'handlers': { 'ask': '__telegram' }} }</nowiki></code> . начиная с этого запроса обработчик будет действовать в течение сессии пока не отправишь 'handlers': {} . Для других полей запросов в канале websocket аналогично.

В составе поставки ses есть файл примера <code>__telegram.py</code> (префикс 2 подчеркивания - такой файл будет переписан при обновлении, любой другой, останется после обновления)

===== '''Websockets сервер''' =====
Работа с программным продуктом возможна с использованием встроенного websockets сервера. Подключение производится по порту 6191, без SSL. При необходимости работать по SSL перед SES ставится nginx в режиме прокси, и SSL поднимается на nginx. Подробнее см. документацию по nginx.

В таблице ниже приведены форматы сообщений для работы с сервером. В каждом сообщении (за исключением бинарных), присутствует переменная path (формат сообщений - JSON), которая определяет алгоритм обработки сообщения. Подключение к серверу возможно в следующих вариантах:

# ws://адрес:6191
# ws://адрес:6191/session[/chunk]

Первый вариант подходит только для текстовых сообщений, в данном случае передача переменной session (uuid текущей сессии) должна производиться в теле сообщения.

Второй вариант подходит и для текстового и для голосового общения с роботом. В данном случае session передается в пути подключения к websockets-серверу. Для каждой новой сессии нужно открывать новое соединение, chunk в пути подключения нужен в том случае, если передаются не готовые части аудио, предварительно сформированные, а сплошной поток аудио, кусками по 20 мс.

{| class="wikitable" style="width: 110%"
|-
! colspan="3" style="text-align: center" |'''<big>Входящие сообщения'''
|-
! style="color:green;width: 15%" |'''pat<big><big>h:ask'''
! colspan="2" style="width: 85%" |Вопрос роботу
|-
| colspan="2" style="width: 50%" |{

 "path": "ask",

 "robot": "f296a3a9-593c-4ed5-a1d3-5d4d46d331bf",

 "session": "77f1af87-6da7-487b-96d2-4e2684704ad5",

 "channel": "default",

 "text": "привет"

}

| style="width: 50%" |{ "error": 0,

 "question": "привет",

 "answer": [

 {

 "messages": [

 "Здравствуйте! Как я могу вам помочь сегодня?"

 ],

 "voice": "Валера",

 "interruptible": false,

 "file": null

 }

 ],

 "session": "77f1af87-6da7-487b-96d2-4e2684704ad5",

 "uuid": "83722305-645d-4674-8c5d-952e02f595f9",

 "path": "ask"

}
|-
!'''path:session'''
! colspan="2" |Статус сессии
|-
| colspan="2" |{

 "path": "session",

 "robot": "f296a3a9-593c-4ed5-a1d3-5d4d46d331bf",

 "session": "548cd1ca-a24a-4a9a-ab4f-8363aa32c3c2"

}

|{ "started": "2025-07-08 07:39:24",

 "modified": "2025-07-08 07:39:26",

 "robot": "f296a3a9-593c-4ed5-a1d3-5d4d46d331bf",

 "session": "548cd1ca-a24a-4a9a-ab4f-8363aa32c3c2",

 "channel": "default",

 "connector": "web",

 "unknown": false,

 "current": {

 "id": null,

 "qas": "",

 "category": null,

 "entry": [],

 "nearest": null,

 "missingRunData": [],

 "waitingRunData": null,

 "answered": false,

 "lastreply": "Здравствуйте! Как я могу вам помочь сегодня?"

 },

 "models": [

 "smc:Рыжик",

 "see:Серверы",

 "see:fio"

 ],

 "scripts": [],

 "data": [

 {

 "request": {

 "datetime": "2025-07-08T07:39:24.706771",

 "message": "привет",

 "data": []

 },

 "reply": {

 "answers": [

 {

 "messages": [

 "Здравствуйте! Как я могу вам помочь сегодня?"

 ],

 "voice": "Валера",

 "interruptible": false,

 "file": null

 }

 ],

 "datetime": "2025-07-08T07:39:26.269201",

 "answered": false

 }

 }

 ],

 "timers": [],

 "variables": {},

 "error": "",

 "events": {

 "not found": {

 "counter": 1

 },

 "no data": {

 "id": null,

 "counter": 0

 },

 "silence": {

 "id": null,

 "counter": 0

 }

 },

 "path": "session"

}
|-
!'''path:status'''
! colspan="2" |Установка статуса клиентской части. Используется в голосовом канале, для установки текущего статуса клиентской части. В случае использования режима активного слушания в момент речи робота, необходимо выставлять на клиентской части статус asking.
|-
| colspan="2" |{

 "path": "status",

 "value": "listening | asking",

 "session": "77f1af87-6da7-487b-96d2-4e2684704ad5"

}

|<nowiki>{ "error": 0, "message": "success", "value": "listening | asking" }</nowiki>
|}

UPS. Описание API

2025-07-07T09:45:48Z

Ka.shapovalov:

===== '''Описание часто используемых параметров''' =====
{| 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''' =====

{| 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, автоматическое определение количества
* '''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''' =====
{| class="wikitable" style="width: 110%"
|+
!style="color:blue;width: 15%" |'''GETsmc/classify/{model}'''
! colspan="3" style="width: 85%" |Классификация текстовой фразы. В случае если модель была создана из меток, в ответе groups и nearest будут пустыми, а ответ будет построен без учета confidenceThreshold из запроса.
В ответе:

* classes — список, для каждого класса которого отображается название класса, к которому был отнесен текст, и вероятность его принадлежности к этому классу.
* groups — название группы и число совпавших классов. Если метки совпадают с несколькими группами, они отображаются в порядке убывания числа совпавших классов (т. е. чем полнее группа, тем выше ее позиция в списке).
* nearest — отображаются группы, до которых не хватает всего одной метки, с указанием процента заполненности и сортировкой по убыванию этого процента.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
*'''text''' - текст, подлежащий классификации
*'''correction''' - уровень коррекции ошибок, от 0 до 3, по умолчанию 0
*'''confidenceThreshold''', % - минимальный порог доверия.
| colspan="2" style="width: 50%" |{ "corrected": "исправленный текст", # при наличии флага коррекции "classes": [

 { "class": "название класса",

 "confidence": 1 },

 { "class": "название класса 2",

 "confidence": 1 } ],

 "groups": [

 { "group": "название группы 1",

 "intersection": 2,

 "classes": [ "название класса", "название класса 2" ] } ],

 "nearest": [

 { "group": "название группы 2",

 "percent": 0.67,

 "need": "название класса которого не хватило 1" },

 { "group": ""название группы 3",

 "percent": 0.67,

 "need": "название класса которого не хватило 2" } ] }
|-
!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''' — процент совпадения
*'''text''' — текст для сравнения с распознанным текстом из wav, необязательный параметр. Если указан, то поиск не будет осуществлен, если распознанный текст будет сильно отличаться от text.
| 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.
| 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.
| 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.'''
| 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'''"
| 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''' - генерирует кэш через разные ответы на каждый вопрос по документации

*'''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:blue;width: 15%" |'''GET/qas/chat'''
! colspan="2" | Поиск ответа за пределами документов. Аналогичен методу "POST/qas/chat". Не поддерживает большие тексты.На стадии разработки, не используется.
|-
| colspan="2" |
*'''text -''' текст вопроса
*'''history''' - история вопросов, будет склеена с text при запросе
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''useInternalTemplate''' - использовать ли шаблон запроса. '''no''' - не использовать, либо код шаблона запроса к LLM. Необязательный параметр. Если не указан, используется шаблон по умолчанию.
*'''params''' - необязательный параметр. JSON с произвольными параметрами запроса к LLM. Описание параметров см. в [[QAS. Руководство администратора|руководстве администратора]].
|Аналогично методу "POST/qas/chat".
|-
! style="color:green;width: 15%" |'''POST/qas/cleandoc'''
! colspan="2" |Очистка документа от лишней информации
|-
| colspan="2" |
*'''text -''' текст документа
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|{"error": 0, "message": "success", "text": "измененный текст"}
|-
! 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''' — фильтр вопросов, ограничение списка по вопросам

*'''answer''' — фильтр ответов, ограничение списка по ответам
| 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:blue;width: 15%" |'''GET/qas/mismatchsearcher/answers'''
! colspan="2" |Отображает лог найденных несоответствий
|-
| colspan="2" |Входные параметры отсутствуют
|на выходе :массив из объектов {

 'question_id'

'category'

'answer_id'

'answer'

'description'

'error'

}
|-
! style="color:green;width: 15%" |'''POST/qas/mismatchsearcher/start'''
! colspan="2" |Старт поиска несоответствий
|-
| colspan="2" |
*'''category''' — id категории документа. Если не указать категорию, метод вернет ответ на основе всех документов в базе данных. Допускается указание нескольких категорий через разделитель "|".
*'''model''' - имя модели GPT, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|<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/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''' — категория (раздел) знаний. Допускается указание нескольких категорий через разделитель "|".
| 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)
|[ "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 - замена информации в тексте

*'''name''' — название шаблона

*'''prompt''' — текст шаблона

*'''postprompt''' - текст шаблона постобработки результатов (нужен только для summarize)
|{ "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 робота

*
| 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:blue;width: 15%" |'''GET/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:blue;width: 15%" |'''GET/ses/robot/cleardraft/{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/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": ".....", "name": ".....", "comment": "", "type": "smc",

 "rtype": "report", "model": ".....", "param": ".....",

 "script": "", "weight": int, "slaveData": [],

 "getOnlyAsNearest": true/false, "injectToMessage": true/false,

 "longWaiting": true/false, "dataWaiting": [],

<nowiki> "actions": {}, "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": "6500dd0f-4bd1-43b3-9fd4-145eb7210c45",

 "name": "pve",

 "entry": [ [ "bc1cb1a1-c64e-46a1-b422-1a48de9ddacb"]],

 "run": [],

 "actions": {

 "default": [

 {"action": "say",

 "type": "linear",

 "text": [ "текст сообщения"] },

 { "action": "следующее действие"} ] } } }
|-
! 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%" |[ { "id": "8576593b-b0d8-4b03-a623-74f3132356ea", "name": "точка 1",

 "entry": [] },

 { "id": "6500dd0f-4bd1-43b3-9fd4-145eb7210c45",

 "name": "точка 2",

 "entry": [ [ "bc1cb1a1-c64e-46a1-b422-1a48de9ddacb" ] ] }]
|-
! 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/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:blue;width: 15%" |'''GET/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",

 "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" },

 { "id": "48b508ba-a32b-4ada-bcc3-66ce26d81c6a",

 "name": "наименование2" }]
|-
! 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: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": "2024-11-05 15:03:14",
"modified": "2024-11-05 15:03:14",

"current": {.....},

"data": [

 { "request": { },

 "reply": { } } ],

"variables": {},

"history": [

 { "id": ".....", "session": ".....", "robot": ".....",

 "channel": ".....", "closed": false, "endpoint": ".....",

 "variables": {},

 "request": {.....},

 "reply": {.....} } ]}
|-
! 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 ] }
|}

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

2025-07-07T09:42:15Z

Ka.shapovalov:

====='''Общее описание'''=====
Сервис предназначен для поиска ответа на заданный вопрос. Входным значением для сервиса являются данные в текстовом формате. В ответ на входящий запрос сервис возвращает данные в формате 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 осуществляется скриптом <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 - для работы с документами

Расположение моделей 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='тут текст'), которая возвращает сгенерированный текст.

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

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

* База файловая, в папке 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.gpu_layers
|12
|Количество слоёв встроенной нейросети.
|-
|gpt.context
|32768
|Размер контекста встроенной нейросети.
|-
|gpt.'''{section}'''.max_tokens
|4096
|'''{section}''' - summarization, chat, ask
Определяет максимальное количество токенов (слов или частей слов), которые модель может сгенерировать в ответ.
|-
|gpt.'''{section}'''.top_k
|summarization 20, chat 30, ask 5
|Ограничивает количество наиболее вероятных следующих токенов, из которых модель выбирает при генерации текста.
|-
|gpt.'''{section}'''.top_p
|summarization 0.4, chat 0.5, ask 0.4
|Определяет кумулятивную вероятность, с которой модель выбирает следующий токен. Например, top_p = 0.9 означает, что модель выбирает из наименьшего набора токенов, сумма вероятностей которых составляет 0.9.
|-
|gpt.'''{section}'''.temperature
|summarization 0.5, chat 0.5, ask 0.1
|Контролирует «температуру» распределения вероятностей выходных токенов. Высокая температура делает распределение более равномерным, а низкая — более «остроконечным».
|-
|gpt.'''{section}'''.repeat_penalty
|summarization 1.1, chat 1.3, ask 1.3
|Накладывает штраф на повторяющиеся токены, уменьшая вероятность их повторного выбора.
|-
|logs.path
|logs/
|Папка для хранения логов. Примеры абсолютного пути: "/var/log/qas/".
|-
|logs.backups
|10
|Количество файлов ротации.
|-
|logs.maxSize
|5242880
|Максимальный размер файла в байтах, триггер для ротации.
|-
|fragments.context
|8192
|Максимальная длина текста, которая будет подана в генератор для поиска ответа на вопрос.
|-
|fragments.threshold
|0.6
|Уровень достоверности при векторном поиске фрагментов в загруженных документах.
|-
|fragments.limit
|1
|Максимальное количество фрагментов, которые должны быть найдены в документах в порядке убывания доверия.
|-
|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. Руководство пользователя

2025-07-07T09:38:27Z

Ka.shapovalov:

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

==== '''Термины и определения''' ====
Question Answering System (QAS) – сервис ответов на вопросы.

==== '''Описание методов API''' ====
Сервис QAS доступен по протоколу HTTP 1.1 через порт 6187/tcp. Авторизация не требуется, но все запросы должны содержать заголовок «accept: application/json». Ответ сервиса возвращается в формате JSON. Если произошла ошибка, возвращается переменная «error=1» и описание ошибки в переменной «message». Для удобства тестирования и использования методов сервиса по адресу <nowiki>http://АДРЕС:6187</nowiki> доступен интерфейс Swagger, который позволяет просматривать и тестировать все доступные методы из таблицы ниже.

{| class="wikitable" style="width: 110%"
|+''Методы API''
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов qas</big>'''
|-
! 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'''"
| style="width: 50%" |{
"error": 0,

"text": "Здесь будет текст ответа"

}
|-
! style="color:green;width: 15%" |'''POST/qas/autocache'''
! colspan="2" style="width: 85%" |Добавление вопросно-ответной пары в кэш.
В случае указания id answer будет принудительно добавлен в вопрос с указанным id. Если же указан question, то система сначала попытается найти похожий вопрос и добавить ответ в него, если же вопрос не будет найден, то система создаст новый с указанной формулировкой. При установке флага emptyQuestion будет добавлен только вопрос (без ответа).
|-
| colspan="2" style="width: 50%" |
*'''question''' — текст вопроса
*'''category''' — категория
* '''channel''' — канал
*'''answer''' — ответ
*'''emptyQuestion''' — yes или no, флаг добавления вопроса без указания ответа
*'''id''' — код существующего вопроса
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/qas/cachemaker/start'''
! colspan="2" style="width: 85%" |Генерация ответов на вопросы в кэше.
|-
| colspan="2" style="width: 50%" |
*'''category''' - категория для которой генерируются ответы

*'''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/chat'''
! colspan="2" style="width: 85%" |Произвольный запрос в LLM.
|-
| colspan="2" style="width: 50%" |
*'''text -''' текст вопроса
*'''history''' - история вопросов, будет склеена с text при запросе
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''useInternalTemplate''' - использовать ли шаблон запроса. '''no''' - не использовать, либо код шаблона запроса к LLM. Необязательный параметр. Если не указан, используется шаблон по умолчанию.
*'''params''' - необязательный параметр. JSON с произвольными параметрами запроса к LLM. Описание параметров см. в [[QAS. Руководство администратора|руководстве администратора]].
| style="width: 50%" |Пример ответа на вопрос "как пройти в библиотеку"

{"error": 0,

"text": "1. Проверить время работы библиотеки (обычно от 9 до 20)\n2. Проверить местоположение библиотеки на карте или с помощью сервиса Google Maps\n3. Убедиться, что у вас есть необходимые документы для входа (паспорт, карта члена библиотеки и т.д.)\n4. Посетить библиотеку по адресу: [адрес библиотеки]\n5. Проверить правила поведения в библиотеке перед входом" }
|-
! style="color:blue;width: 15%" |'''GET/qas/chat'''
! colspan="2" style="width: 85%" |Поиск ответа за пределами документов. Аналогичен методу "POST/qas/chat". Не поддерживает большие тексты.На стадии разработки, не используется.
|-
| colspan="2" style="width: 50%" |
*'''text -''' текст вопроса
*'''history''' - история вопросов, будет склеена с text при запросе
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''useInternalTemplate''' - использовать ли шаблон запроса. '''no''' - не использовать, либо код шаблона запроса к LLM. Необязательный параметр. Если не указан, используется шаблон по умолчанию.
*'''params''' - необязательный параметр. JSON с произвольными параметрами запроса к LLM. Описание параметров см. в [[QAS. Руководство администратора|руководстве администратора]].
| style="width: 50%" |Аналогично методу "POST/qas/chat".
|-
! style="color:green;width: 15%" |'''POST/qas/cleandoc'''
! colspan="2" |Очистка документа от лишней информации
|-
| colspan="2" |
*'''text -''' текст документа
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|{"error": 0, "message": "success", "text": "измененный текст"}
|-
! 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/gpt/list'''
| colspan="2" |Получение списка доступных(установленных) GPT моделей
|-
| colspan="2" |Входные параметры отсутствуют
|{ "error": 0, "message": "success",
 "models": ["default" ]}
|-
! 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:blue;width: 15%" |'''GET/qas/mismatchsearcher/answers'''
! colspan="2" |Отображает лог найденных несоответствий
|-
| colspan="2" |Входные параметры отсутствуют
|на выходе :

массив из объектов {

 'question_id'

'category'

'answer_id'

'answer'

'description'

'error'

}
|-
! style="color:green;width: 15%" |'''POST/qas/mismatchsearcher/start'''
! colspan="2" |Старт поиска несоответствий
|-
| colspan="2" |
*'''category''' — id категории документа. Если не указать категорию, метод вернет ответ на основе всех документов в базе данных. Допускается указание нескольких категорий через разделитель "|".
*'''model''' - имя модели GPT, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|<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;

 status: 'started' | 'stopped';

 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/questionmaker/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/search'''
! colspan="2" style="width: 85%" |Поиск фрагментов содержащих ответ
|-
| colspan="2" style="width: 50%" |
*'''text''' — текст запроса

*'''category''' — категория (раздел) знаний. Допускается указание нескольких категорий через разделитель "|".
| 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/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)
|[ "error": 0,
"message": "success",
"docs": [],
"answers": []
]
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов channel</big>'''
|-
! 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" }
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов category</big>'''
|-
! 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" }
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов doc</big>'''
|-
! 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="3" 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="3" |Массовая замена текста в указанных фразах.
|-
| colspan="2" |
*'''phrases''' - JSON массив с изменяемым фразами следующего вида:
[

{

'doc_id': 'ad895085-2e48-439a-831e-b5f699b6a54a',

'phrase_id': 5,

'text': 'новый текст'

}

]
|{"error": 0,"message": "success"}
|
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов question</big>'''
|-
! 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''' — фильтр вопросов

*'''answer''' — фильтр ответов
| style="width: 50%" |{ "error": 0,
 "questions": [

 { "id": "77b42c9b-2075-4a5f-b6d9-a284bba7cf43",

 "question": "вопрос",

 "category": "9580b3b7-34cb-4d0e-ba75-d17313ead16d" },

 { "id": "d1836e5e-010e-4f3a-b306-813c3acb7efb",

 "question": "n-й второй вопрос",

 "category": "7d8a3415-cb09-4dad-a169-478ba15ade47" }

 ] }
|-
! 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="3" 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/question/modifyanswers'''
! colspan="3" |Массовая замена текста в указанных ответах.
|-
| colspan="2" |
*'''phrases''' - JSON массив с изменяемым ответами следующего вида:
[

{

'question_id': 'ad895085-2e48-439a-831e-b5f699b6a54a',

'answer_id': 5,

'text': 'новый текст'

}

]
|{"error": 0,"message": "success"}
|
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов summarization_template</big>'''
|-
! 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%" |'''DELETE/qas/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}
|-
! colspan="3" style="text-align: center" |'''<big>Группа методов prompt</big>'''
|-
! 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 - замена информации в тексте

*'''name''' — название шаблона

*'''prompt''' — текст шаблона

*'''postprompt''' - текст шаблона постобработки результатов (нужен только для summarize)
|{
 "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}
|}

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

2025-07-03T12:54:39Z

Ka.shapovalov:

====='''Общее описание'''=====
Сервис предназначен для поиска ответа на заданный вопрос. Входным значением для сервиса являются данные в текстовом формате. В ответ на входящий запрос сервис возвращает данные в формате 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 осуществляется скриптом <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 - для работы с документами

Расположение моделей 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='тут текст'), которая возвращает сгенерированный текст.

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

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

* База файловая, в папке 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.gpu_layers
|12
|Количество слоёв встроенной нейросети.
|-
|gpt.context
|32768
|Размер контекста встроенной нейросети.
|-
|gpt.'''{section}'''.max_tokens
|4096
|'''{section}''' - summarization, chat, ask, creative
Определяет максимальное количество токенов (слов или частей слов), которые модель может сгенерировать в ответ.
|-
|gpt.'''{section}'''.top_k
|summarization 30, chat 40, ask 5, creative 40
|Ограничивает количество наиболее вероятных следующих токенов, из которых модель выбирает при генерации текста.
|-
|gpt.'''{section}'''.top_p
|summarization 0.9, chat 0.4, ask 0.8, creative 0.4
|Определяет кумулятивную вероятность, с которой модель выбирает следующий токен. Например, top_p = 0.9 означает, что модель выбирает из наименьшего набора токенов, сумма вероятностей которых составляет 0.9.
|-
|gpt.'''{section}'''.temperature
|summarization 0.4, chat 0.8, ask 0.1, creative 0.8
|Контролирует «температуру» распределения вероятностей выходных токенов. Высокая температура делает распределение более равномерным, а низкая — более «остроконечным».
|-
|gpt.'''{section}'''.repeat_penalty
|summarization 1.1, chat 1.3, ask 1.3, creative 1.3
|Накладывает штраф на повторяющиеся токены, уменьшая вероятность их повторного выбора.
|-
|logs.path
|logs/
|Папка для хранения логов. Примеры абсолютного пути: "/var/log/qas/".
|-
|logs.backups
|10
|Количество файлов ротации.
|-
|logs.maxSize
|5242880
|Максимальный размер файла в байтах, триггер для ротации.
|-
|fragments.context
|8192
|Максимальная длина текста, которая будет подана в генератор для поиска ответа на вопрос.
|-
|fragments.threshold
|0.6
|Уровень достоверности при векторном поиске фрагментов в загруженных документах.
|-
|fragments.limit
|1
|Максимальное количество фрагментов, которые должны быть найдены в документах в порядке убывания доверия.
|-
|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>. Команда деинсталлирует сервис и удалит рабочий каталог, включая все установленные модели.

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

2025-07-03T12:53:50Z

Ka.shapovalov:

===== '''Общее описание''' =====
Сервис предназначен для сценарных машин.

===== '''Термины и определения''' =====
Script Engine Service (SES) – сервис, обеспечивающий работу сценарных машин.

===== '''Требования к окружению''' =====
В процессе работы сервис взаимодействует со следующими сервисами:

* UPS – настройка осуществляется через файл /opt/ups/config.json
* SMC, SEE, SPR, TTS, SBS, QAS – настройка осуществляется через файл /opt/ses/config.json.

===== '''Установка ses''' =====

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

==='''Настройка сервиса'''===

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

Описание параметров приведено в таблице
{| class="wikitable"
|+
!style="width: 20%"|Параметр
!style="width: 20%"|По умолчанию
!style="width: 60%"|Назначение
|-
|port
|6190
|Порт API интерфейса используется в UPS — настройка servers.ses в конфиге UPS.
|-
|logs.path
|logs/
|Путь к папке логов.
|-
|logs.debug
|false
|Режим расширенного логирования.
|-
|logs.backups
|10
|Количество старых сохраняемых логов.
|-
|logs.maxSize
|5242880
|Максимальный размер текущего лог-файла в байтах.
|-
|storage.audio.web
|/opt/ses/storage/web
|Путь для временного хранения фрагментов аудио веб сессий
|-
|storage.audio.hot
|/opt/ses/storage/hot
|Путь к "горячему" хранилищу аудиоданных
|-
|storage.audio.cold
|null
|Путь к "холодному" хранилищу аудиоданных, куда переливаются данные из "горячего" хранилища.
|-
|servers.{service}.url
|"<nowiki>http://127.0.0.1:PORT/{service}</nowiki>"
|Адрес сервера. Возможные варианты значения service (с портами по умолчанию) следующие: smc(6181), see(6184), spr(6183), tts(6186), sbs(6185), qas(6187).
|-
|servers.{service}.timers.connect
|2
|Таймаут подключения к серверу.
|-
|servers.{service}.timers.read
|10
|Таймаут получения данных с сервера.
|-
|connectors.vk
|{}
|Параметры подключения к ботам VK
{ "имя_подключения":{

 "token":"Ключ доступа",

 "robot":"id робота",

 "group_id":"id сообщества ВКонтакте",

 "whitelist":[],

 "activators":[]

 },

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

}
|-
|connectors.telegram
|{}
|Параметры подключения к telegram ботам
{ "имя_подключения":{

 "token":"Ключ доступа",

 "robot":"id робота",

 "variables":{

 "phone": "1234567890"

 },

 "timers": { "getUpdates": 3 },

 "whitelist":[],

 "activators":[]

 },

...........

}
|-
|connectors.freeswitch
|{}
|Номера внутренних телефонов внутри freeswitch с привязкой к роботам
"5000": {

 "robot": "ffeaa99a-13d2-4bff-b458-1231c884f8ee"

 }
|-
|vad.listening.maxLength
|10000
|Максимальная длина звукового фрагмента
|-
|vad.listening.minSpeech
|120
|Минимальный отрезок речи, который считать значимым
|-
|vad.listening.skipSilence
|60
|Не считать тишиной отрезки, короче данного значения
|-
|vad.listening.maxSilence
|1200
|Максимальная длительность тишины перед отправкой фрагмента
|-
|vad.listening.speechWaiting
|4000
|Длительность ожидания начала речи
|-
|vad.playing.maxLength
|2000
|Максимальная длина звукового фрагмента в режиме активного слушания
|-
|vad.playing.minSpeech
|60
|Минимальный отрезок речи, который считать значимым в режиме активного слушания
|-
|vad.playing.skipSilence
|60
|Не считать тишиной отрезки, короче данного значения в режиме активного слушания
|-
|vad.playing.maxSilence
|200
|Максимальная длительность тишины перед отправкой фрагмента в режиме активного слушания
|-
|cluster.logfile
|logs/sync.log
|Файл логов синхронизации есть только на главном сервере кластера
|-
|cluster.statusFile
|logs/sync.status
|Статус задачи синхронизации есть только на главном сервере кластера
|-
|cluster.nodes
|[ ]
|Перечень подчиненных нод для синхронизации изменений заполняется только на главном сервере кластера
|-
|tmp
|"/tmp/ses"
|Временная папка.
|}

==== '''Работа в составе кластера''' ====
Для высоконагруженных систем сервис можно расположить на нескольких нодах (виртуальных машинах). В этом случае, чтобы не потерять документы и изменения, полученные на одной из нод, выделяется один основной сервис и вспомогательные сервисы:
*База файловая, в папке robots.
*lsync настроен через конфиг SES для репликации базы на все указанные серверы в списке cluster.nodes: [], указываем все слейв-сервера.
*UPS при изменении данных работает только с мастером SES, а при запросе данных — со всеми серверами cluster, распределяя нагрузку.
*В конфигурации UPS: в servers.ses.trainer указываем маcтер-сервер, в servers.ses.cluster перечисляем все сервера кластера SES, в том числе и мастер.

===='''Эмуляция сервисов интеграции'''====

В каталоге '''/opt/ses/testapi''' могут располагаться эмуляторы сервисов интеграции. Эмулятор будет доступен по адресу ''htttp://<адрес ses>/testapi/<название_сервиса>. Для создания эмулятора поместите в папку /opt/ses/testapi/ файл <название_сервиса>.reply. Содержимое файла будет отдано без изменений, как есть по адресу "http://<адрес_ses>:<порт_ses>/ses/testapi/<название_сервиса>".''

==='''Настройка каналов и виджетов'''===

===='''Настройка виджета для сайта'''====

# '''Размещаете на сайте''', например <nowiki>http://сайт.рф</nowiki> '''ссылку на виджет''' <nowiki><script src="http://адрес_ups/ses/widget/js" key="xxxxxxxx"></script></nowiki> (ключ придумайте сами)
# '''Делаете конфиг''' канала в файле /opt/ses/config.json в разделе connectors.web. В конфиге следующее:
<blockquote>"web": {

"<nowiki>http://сайт.рф~xxxxxxxx"</nowiki>: { #сайт_с_виджетом~ключ

 "robot": "28013d0a-...", # id робота

 "color": "#4d3e33", #акцентный цвет виджета"

 "host": "адрес_ses:6191", #адрес который прослушивает ws(wss) запросы

 "microphone": false, #возможность отправлять/принимать аудио

 "transcription": false, #возможность расшифровки аудио клиента

 "variables": {

 "var_1": "1234567890"

 } } }</blockquote>Если на сайте SSL, то дополнительно поднимаете реверс-прокси для UPS (<nowiki>http://адрес_ups</nowiki>) и для websocket (адрес_ses:6191). Особенности реализации на nginx:

'''Основной конфиг''' должен включать директиву <code>proxy_set_header Host $host;</code> а также заголовки CORS и обработку OPTIONS запросов. Дополнительно в нем? возможно? придется обработать путь "/lang" с переводом.

Конфиг для websocket должен обеспечивать обработку upgrade запросов (<nowiki>https://nginx.org/en/docs/http/websocket.html</nowiki>) для перенаправления websocket трафика, а также прослушивание отдельного порта, например 8091.

Тогда в ссылку на виджет (адрес_ups) и в конфиг канала (адрес_ses:6191) нужно будет вносить адреса, которые поддерживают SSL. Пример конфига nginx для wss: <blockquote>server {

 server_name ups_сервер.ru;

 listen 6191 ssl;

 include snippets/ssl-params.conf;

 ssl_certificate /etc/letsencrypt/live/ups_сервер.ru/fullchain.pem;

 ssl_certificate_key /etc/letsencrypt/live/ups_сервер.ru/privkey.pem;

 ssl_trusted_certificate /etc/letsencrypt/live/ups_сервер.ru/chain.pem;

 client_max_body_size 1000M;

 proxy_read_timeout 6000;

 proxy_connect_timeout 6000;

 proxy_send_timeout 6000;

 send_timeout 6000;

 large_client_header_buffers 8 256k;

 location / {

 proxy_pass <nowiki>http://локальныq_адрес_ses:6191</nowiki>;

 proxy_http_version 1.1;

 proxy_set_header Upgrade $http_upgrade;

 proxy_set_header Connection "upgrade";

 proxy_set_header Host $host;

 proxy_cache_bypass $http_upgrade; } }</blockquote>

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

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

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

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

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

==='''Удаление и обновление ses'''===
Для удаления выполните команду:

<code>/opt/ses/uninstall</code>

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

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

2025-07-03T12:50:59Z

Ka.shapovalov:

====='''Общее описание'''=====
Сервис предназначен для поиска ответа на заданный вопрос. Входным значением для сервиса являются данные в текстовом формате. В ответ на входящий запрос сервис возвращает данные в формате 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 осуществляется скриптом <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 - для работы с документами

Расположение моделей 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='тут текст'), которая возвращает сгенерированный текст.

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

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

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

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

Описание параметров приведено в таблице.
{| class="wikitable"
|+
!style="width: 20%"|Параметр
!По умолчанию
!Назначение
|-
|reloader.period
|60
|Период обновления векторов базы вопросов и документов.
|-
|gpt.gpu_layers
|12
|Количество слоёв встроенной нейросети.
|-
|gpt.context
|32768
|Размер контекста встроенной нейросети.
|-
|gpt.'''{section}'''.max_tokens
|4096
|'''{section}''' - summarization, chat, ask, creative
Определяет максимальное количество токенов (слов или частей слов), которые модель может сгенерировать в ответ.
|-
|gpt.'''{section}'''.top_k
|summarization 30, chat 40, ask 5, creative 40
|Ограничивает количество наиболее вероятных следующих токенов, из которых модель выбирает при генерации текста.
|-
|gpt.'''{section}'''.top_p
|summarization 0.9, chat 0.4, ask 0.8, creative 0.4
|Определяет кумулятивную вероятность, с которой модель выбирает следующий токен. Например, top_p = 0.9 означает, что модель выбирает из наименьшего набора токенов, сумма вероятностей которых составляет 0.9.
|-
|gpt.'''{section}'''.temperature
|summarization 0.4, chat 0.8, ask 0.1, creative 0.8
|Контролирует «температуру» распределения вероятностей выходных токенов. Высокая температура делает распределение более равномерным, а низкая — более «остроконечным».
|-
|gpt.'''{section}'''.repeat_penalty
|summarization 1.1, chat 1.3, ask 1.3, creative 1.3
|Накладывает штраф на повторяющиеся токены, уменьшая вероятность их повторного выбора.
|-
|logs.path
|logs/
|Папка для хранения логов. Примеры абсолютного пути: "/var/log/qas/".
|-
|logs.backups
|10
|Количество файлов ротации.
|-
|logs.maxSize
|5242880
|Максимальный размер файла в байтах, триггер для ротации.
|-
|fragments.context
|8192
|Максимальная длина текста, которая будет подана в генератор для поиска ответа на вопрос.
|-
|fragments.threshold
|0.6
|Уровень достоверности при векторном поиске фрагментов в загруженных документах.
|-
|fragments.limit
|1
|Максимальное количество фрагментов, которые должны быть найдены в документах в порядке убывания доверия.
|-
|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>. Команда деинсталлирует сервис и удалит рабочий каталог, включая все установленные модели.

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

2025-07-03T12:48:12Z

Ka.shapovalov:

===== '''Общее описание''' =====
Сервис предназначен для сценарных машин.

===== '''Термины и определения''' =====
Script Engine Service (SES) – сервис, обеспечивающий работу сценарных машин.

===== '''Требования к окружению''' =====
В процессе работы сервис взаимодействует со следующими сервисами:

* UPS – настройка осуществляется через файл /opt/ups/config.json
* SMC, SEE, SPR, TTS, SBS, QAS – настройка осуществляется через файл /opt/ses/config.json.

===== '''Установка ses''' =====

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

==='''Настройка сервиса'''===

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

Описание параметров приведено в таблице
{| class="wikitable"
|+
!style="width: 20%"|Параметр
!style="width: 20%"|По умолчанию
!style="width: 60%"|Назначение
|-
|port
|6190
|Порт API интерфейса используется в UPS — настройка servers.ses в конфиге UPS.
|-
|logs.path
|logs/
|Путь к папке логов.
|-
|logs.debug
|false
|Режим расширенного логирования.
|-
|logs.backups
|10
|Количество старых сохраняемых логов.
|-
|logs.maxSize
|5242880
|Максимальный размер текущего лог-файла в байтах.
|-
|storage.audio.web
|/opt/ses/storage/web
|Путь для временного хранения фрагментов аудио веб сессий
|-
|storage.audio.hot
|/opt/ses/storage/hot
|Путь к "горячему" хранилищу аудиоданных
|-
|storage.audio.cold
|null
|Путь к "холодному" хранилищу аудиоданных, куда переливаются данные из "горячего" хранилища.
|-
|servers.{service}.url
|"<nowiki>http://127.0.0.1:PORT/{service}</nowiki>"
|Адрес сервера. Возможные варианты значения service (с портами по умолчанию) следующие: smc(6181), see(6184), spr(6183), tts(6186), sbs(6185), qas(6187).
|-
|servers.{service}.timers.connect
|2
|Таймаут подключения к серверу.
|-
|servers.{service}.timers.read
|10
|Таймаут получения данных с сервера.
|-
|connectors.vk
|{}
|Параметры подключения к ботам VK
{ "имя_подключения":{

 "token":"Ключ доступа",

 "robot":"id робота",

 "group_id":"id сообщества ВКонтакте",

 "whitelist":[],

 "activators":[]

 },

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

}
|-
|connectors.telegram
|{}
|Параметры подключения к telegram ботам
{ "имя_подключения":{

 "token":"Ключ доступа",

 "robot":"id робота",

 "variables":{

 "phone": "1234567890"

 },

 "timers": { "getUpdates": 3 },

 "whitelist":[],

 "activators":[]

 },

...........

}
|-
|connectors.freeswitch
|{}
|Номера внутренних телефонов внутри freeswitch с привязкой к роботам
"5000": {

 "robot": "ffeaa99a-13d2-4bff-b458-1231c884f8ee"

 }
|-
|vad.listening.maxLength
|10000
|Максимальная длина звукового фрагмента
|-
|vad.listening.minSpeech
|120
|Минимальный отрезок речи, который считать значимым
|-
|vad.listening.skipSilence
|60
|Не считать тишиной отрезки, короче данного значения
|-
|vad.listening.maxSilence
|1200
|Максимальная длительность тишины перед отправкой фрагмента
|-
|vad.listening.speechWaiting
|4000
|Длительность ожидания начала речи
|-
|vad.playing.maxLength
|2000
|Максимальная длина звукового фрагмента в режиме активного слушания
|-
|vad.playing.minSpeech
|60
|Минимальный отрезок речи, который считать значимым в режиме активного слушания
|-
|vad.playing.skipSilence
|60
|Не считать тишиной отрезки, короче данного значения в режиме активного слушания
|-
|vad.playing.maxSilence
|200
|Максимальная длительность тишины перед отправкой фрагмента в режиме активного слушания
|-
|cluster.logfile
|logs/sync.log
|Файл логов синхронизации есть только на главном сервере кластера
|-
|cluster.statusFile
|logs/sync.status
|Статус задачи синхронизации есть только на главном сервере кластера
|-
|cluster.nodes
|[ ]
|Перечень подчиненных нод для синхронизации изменений заполняется только на главном сервере кластера
|-
|tmp
|"/tmp/ses"
|Временная папка.
|}

===='''Эмуляция сервисов интеграции'''====

В каталоге '''/opt/ses/testapi''' могут располагаться эмуляторы сервисов интеграции. Эмулятор будет доступен по адресу ''htttp://<адрес ses>/testapi/<название_сервиса>. Для создания эмулятора поместите в папку /opt/ses/testapi/ файл <название_сервиса>.reply. Содержимое файла будет отдано без изменений, как есть по адресу "http://<адрес_ses>:<порт_ses>/ses/testapi/<название_сервиса>".''

==='''Настройка каналов и виджетов'''===

===='''Настройка виджета для сайта'''====

# '''Размещаете на сайте''', например <nowiki>http://сайт.рф</nowiki> '''ссылку на виджет''' <nowiki><script src="http://адрес_ups/ses/widget/js" key="xxxxxxxx"></script></nowiki> (ключ придумайте сами)
# '''Делаете конфиг''' канала в файле /opt/ses/config.json в разделе connectors.web. В конфиге следующее:
<blockquote>"web": {

"<nowiki>http://сайт.рф~xxxxxxxx"</nowiki>: { #сайт_с_виджетом~ключ

 "robot": "28013d0a-...", # id робота

 "color": "#4d3e33", #акцентный цвет виджета"

 "host": "адрес_ses:6191", #адрес который прослушивает ws(wss) запросы

 "microphone": false, #возможность отправлять/принимать аудио

 "transcription": false, #возможность расшифровки аудио клиента

 "variables": {

 "var_1": "1234567890"

 } } }</blockquote>Если на сайте SSL, то дополнительно поднимаете реверс-прокси для UPS (<nowiki>http://адрес_ups</nowiki>) и для websocket (адрес_ses:6191). Особенности реализации на nginx:

'''Основной конфиг''' должен включать директиву <code>proxy_set_header Host $host;</code> а также заголовки CORS и обработку OPTIONS запросов. Дополнительно в нем? возможно? придется обработать путь "/lang" с переводом.

Конфиг для websocket должен обеспечивать обработку upgrade запросов (<nowiki>https://nginx.org/en/docs/http/websocket.html</nowiki>) для перенаправления websocket трафика, а также прослушивание отдельного порта, например 8091.

Тогда в ссылку на виджет (адрес_ups) и в конфиг канала (адрес_ses:6191) нужно будет вносить адреса, которые поддерживают SSL. Пример конфига nginx для wss: <blockquote>server {

 server_name ups_сервер.ru;

 listen 6191 ssl;

 include snippets/ssl-params.conf;

 ssl_certificate /etc/letsencrypt/live/ups_сервер.ru/fullchain.pem;

 ssl_certificate_key /etc/letsencrypt/live/ups_сервер.ru/privkey.pem;

 ssl_trusted_certificate /etc/letsencrypt/live/ups_сервер.ru/chain.pem;

 client_max_body_size 1000M;

 proxy_read_timeout 6000;

 proxy_connect_timeout 6000;

 proxy_send_timeout 6000;

 send_timeout 6000;

 large_client_header_buffers 8 256k;

 location / {

 proxy_pass <nowiki>http://локальныq_адрес_ses:6191</nowiki>;

 proxy_http_version 1.1;

 proxy_set_header Upgrade $http_upgrade;

 proxy_set_header Connection "upgrade";

 proxy_set_header Host $host;

 proxy_cache_bypass $http_upgrade; } }</blockquote>

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

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

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

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

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

==='''Удаление и обновление ses'''===
Для удаления выполните команду:

<code>/opt/ses/uninstall</code>

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

UPS. Описание API

2025-07-03T12:28:57Z

Ka.shapovalov:

===== '''Описание часто используемых параметров''' =====
{| 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''' =====

{| 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, автоматическое определение количества
* '''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''' =====
{| class="wikitable" style="width: 110%"
|+
!style="color:blue;width: 15%" |'''GETsmc/classify/{model}'''
! colspan="3" style="width: 85%" |Классификация текстовой фразы. В случае если модель была создана из меток, в ответе groups и nearest будут пустыми, а ответ будет построен без учета confidenceThreshold из запроса.
В ответе:

* classes — список, для каждого класса которого отображается название класса, к которому был отнесен текст, и вероятность его принадлежности к этому классу.
* groups — название группы и число совпавших классов. Если метки совпадают с несколькими группами, они отображаются в порядке убывания числа совпавших классов (т. е. чем полнее группа, тем выше ее позиция в списке).
* nearest — отображаются группы, до которых не хватает всего одной метки, с указанием процента заполненности и сортировкой по убыванию этого процента.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
*'''text''' - текст, подлежащий классификации
*'''correction''' - уровень коррекции ошибок, от 0 до 3, по умолчанию 0
*'''confidenceThreshold''', % - минимальный порог доверия.
| colspan="2" style="width: 50%" |{ "corrected": "исправленный текст", # при наличии флага коррекции "classes": [

 { "class": "название класса",

 "confidence": 1 },

 { "class": "название класса 2",

 "confidence": 1 } ],

 "groups": [

 { "group": "название группы 1",

 "intersection": 2,

 "classes": [ "название класса", "название класса 2" ] } ],

 "nearest": [

 { "group": "название группы 2",

 "percent": 0.67,

 "need": "название класса которого не хватило 1" },

 { "group": ""название группы 3",

 "percent": 0.67,

 "need": "название класса которого не хватило 2" } ] }
|-
!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''' — процент совпадения
*'''text''' — текст для сравнения с распознанным текстом из wav, необязательный параметр. Если указан, то поиск не будет осуществлен, если распознанный текст будет сильно отличаться от text.
| 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.
| 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.
| 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.'''
| 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 канала
*'''creative''' — флаг креативности возможные варианты "yes" "no"
*'''useCache''' — использовать кешированные ответы
возможные варианты:

- "'''no'''" не использовать

- "'''all'''" использовать все

- "'''checked'''" использовать только проверенные
*'''useGPT''' — использовать генеративную сеть для поиска ответов в документах. возможные варианты "'''yes'''" "'''no'''"
*'''model''' - имя модели GPT, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр

*'''addAlias''' — добавлять похожие вопросы к синонимам, не создавая отдельного вопроса. возможные варианты "'''yes'''" "'''no'''"
| 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''' - генерирует кэш через разные ответы на каждый вопрос по документации

*'''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:blue;width: 15%" |'''GET/qas/chat'''
! colspan="2" | Поиск ответа за пределами документов. Аналогичен методу "POST/qas/chat". Не поддерживает большие тексты.На стадии разработки, не используется.
|-
| colspan="2" |
*'''text -''' текст вопроса
*'''history''' - история вопросов, будет склеена с text при запросе
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''useInternalTemplate''' - использовать ли шаблон запроса. '''no''' - не использовать, либо код шаблона запроса к LLM. Необязательный параметр. Если не указан, используется шаблон по умолчанию.
*'''params''' - необязательный параметр. JSON с произвольными параметрами запроса к LLM. Описание параметров см. в [[QAS. Руководство администратора|руководстве администратора]].
|Аналогично методу "POST/qas/chat".
|-
! style="color:green;width: 15%" |'''POST/qas/cleandoc'''
! colspan="2" |Очистка документа от лишней информации
|-
| colspan="2" |
*'''text -''' текст документа
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|{"error": 0, "message": "success", "text": "измененный текст"}
|-
! 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''' — фильтр вопросов, ограничение списка по вопросам

*'''answer''' — фильтр ответов, ограничение списка по ответам
| 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 канала
*'''creative''' — флаг креативности возможные варианты "yes" "no"
*'''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:blue;width: 15%" |'''GET/qas/questionmaker/start'''
! colspan="2" style="width: 85%" | Запуск генерации вопросов для кэша. По каждому документу генерируются по 5 вопросов на фрагмент. Количество фрагментов зависят от размера документа и настройки размера контекста из конфигурационного файла. Если вопрос сильно похож на существующий, новый не создается, а добавляется к существующему в aliases.
|-
| colspan="2" style="width: 50%" |
*'''category''' — категория, для которой выполнится генерация вопросов.
*'''doc''' - для какого документа генерировать
*'''model''' - какую модель использовать для генерации, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, используемого для генерации вопросов, необязательный параметр
*'''generateAnswers''' - автоматическая генерация ответа для каждого сгенерированного вопроса, yes или no, по умолчанию no.
| style="width: 50%" |{"error": 0, "message": "success" }
|-
! style="color:blue;width: 15%" |'''GET/qas/questionmaker/status'''
! colspan="2" style="width: 85%" |Проверка состояния генерации. Статусы''': started''', '''stopped.''' Если были ошибки поле ответа '''error''' будет содержать код ошибки
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{ "error": "",

 "status": "stopped",

 "progress": 0 }
|-
! 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''' — категория (раздел) знаний. Допускается указание нескольких категорий через разделитель "|".
| 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)
|[ "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 - замена информации в тексте

*'''name''' — название шаблона

*'''prompt''' — текст шаблона

*'''postprompt''' - текст шаблона постобработки результатов (нужен только для summarize)
|{ "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:green;width: 15%" |'''POST/ses/ask/{robot_id}'''
! colspan="2" style="width: 85%" |Получение ответа на запрос пользователя. Метод для отладки робота
|-
| colspan="2" style="width: 50%" |
*'''text''' — текст запроса

*'''channel''' -— id канала

*'''session''' — uuid сессии, если это не первый запрос в сессии

*'''tts''' — вернуть результат синтеза (1- вернуть, 0 - не выполнять синтез)

*'''variables''' — словарик с переменными {"переменная1":"значение","переменнаяN":"значение"}

*'''audio''' — аудиофайл с запросом, текст запроса будет получен распознаванием audio

*'''robot_id''' — id робота
| style="width: 50%" |{ "error": 0, "question": "Вопрос",

 "answer": [

 { "messages": [

 "ответ" ],

 "voice": "" } ],

 "session": null}
|-
! 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:blue;width: 15%" |'''GET/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:blue;width: 15%" |'''GET/ses/robot/cleardraft/{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/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": "bc1cb1a1-c64e-46a1-b422-1a48de9ddacb",

 "name": "pve",

 "type": "smc",

 "model": "Рыжик",

 "param": "PVE",

 "weight": 0,

 "slaveData": [],

 "forEndpointRunOnly": true,

 "actions": {} } }
|-
! 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": "bc1cb1a1-c64e-46a1-b422-1a48de9ddacb", "name": "pve",

 "type": "smc" } ]
|-
! 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": "6500dd0f-4bd1-43b3-9fd4-145eb7210c45",

 "name": "pve",

 "entry": [ [ "bc1cb1a1-c64e-46a1-b422-1a48de9ddacb"]],

 "run": [],

 "actions": {

 "default": [

 {"action": "say",

 "type": "linear",

 "text": [ "текст сообщения"] },

 { "action": "следующее действие"} ] } } }
|-
! 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%" |[ { "id": "8576593b-b0d8-4b03-a623-74f3132356ea", "name": "точка 1",

 "entry": [] },

 { "id": "6500dd0f-4bd1-43b3-9fd4-145eb7210c45",

 "name": "точка 2",

 "entry": [ [ "bc1cb1a1-c64e-46a1-b422-1a48de9ddacb" ] ] }]
|-
! 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/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:blue;width: 15%" |'''GET/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",

 "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" },

 { "id": "48b508ba-a32b-4ada-bcc3-66ce26d81c6a",

 "name": "наименование2" }]
|-
! 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: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": "2024-11-05 15:03:14",
"modified": "2024-11-05 15:03:14",

"current": {.....},

"data": [

 { "request": { },

 "reply": { } } ],

"variables": {},

"history": [

 { "id": ".....", "session": ".....", "robot": ".....",

 "channel": ".....", "closed": false, "endpoint": ".....",

 "variables": {},

 "request": {.....},

 "reply": {.....} } ]}
|-
! 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 ] }
|}