UMS. Руководство администратора: различия между версиями

Текущая версия от 12:05, 20 февраля 2025

Общее описание

Сервис UMS — это серверная реализация протокола MRCP, предназначенная для работы с сервисом SPR.

Термины и определения

UMS — Universal MRCP Server (расширенная реализация MRCP-сервера для обработки речи)

MRCP — Media Resource Control Protocol (протокол управления медиа-ресурсами)

SRP — Short Phrase Recognized (продукт для распознавания речи)

VAD — Voice Activity Detection (обнаружение голосовой активности во входном акустическом сигнале для отделения активной речи от фонового шума или тишины)

Установка пакета UMC

Дистрибутив распространяется в виде универсального установочного пакета. Пакет может быть установлен в онлайн-режиме (при наличии доступа к репозиториям) или оффлайн (с предварительно собранными пакетами). Для установки в оффлайн-режиме сперва нужно запустить экземпляр скрипта на копии целевой системы (версия и ядро ОС) с доступом к репозиториям. Для установки пакета запустить инсталлятор с требуемыми ключами. При запуске без ключей инсталлятор выдаст короткую справку. Например.

-Установить сервис онлайн

./ums-X.XXX-universal.sh -i -on

-Установить сервис оффлайн

./ums-X.XXX-universal.sh -i -off

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

./ums-X.XXX-universal.sh --extract

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

./ums-X.XXX-universal.sh --pack <service>-offline.tgz

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

./ums-X.XXX-universal.sh --pack -d <имя каталога>

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

./ums-X.XXX-universal.sh -e -d archive

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

./ums-X.XXX-universal.sh --build

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

./ums-X.XXX-universal.sh --null

Конфигурирование

Основной файл конфигурации /opt/ums/params.conf В файле ссылка на сервис распознавания или прокси сервис через который доступен кластер сервисов распознавания

{

 "spr_server": "127.0.0.1:6182"

}

UMS в составе содержит nginx-сервер. Его файл конфигурации: /opt/ums/nginx/etc/nginx/conf.d/default.conf.example. В нем, возможно, будет необходимость править таймауты.

На поведение UMS также влияет строка запроса, например:

builtin:grammar/calls?language=ru-RU&b=1&spl=ru-RU&i=any&ct=0.7&sl=0.7&sint=1000&sct=800&nit=3000

Параметры распознавания:

b — Возможность прервать проигрываемый файл (режим barge-in) и начать распознавание

(нельзя перебить = 0, можно перебить и обнаружение речи осуществляет ASR движок = 1, можно перебить и обнаружение

речи осуществляет Asterisk = 2).

t — Время, по истечении которого система распознавания может прервать процедуру распознавания с кодом.

recognition-timeout (003) в случае, если распознавание началось и нет ни одного варианта распознавания.

Значение задается в миллисекундах ↵в диапазоне [0..MAXTIMEOUT].

ct — Порог уверенного распознавания (0.0 – 1.0).

Если confidence-level, возвращаемый при распознавании, меньше confidence-threshold, то результат распознавания — no match.

sl — Чувствительность к несловарным командам. (0.0 — 1.0). Чем больше значение, тем выше чувствительность к шуму.

nit — no input timeout (msec) Время, по истечении которого система распознавания может прервать процедуру распознавания с кодом

no-input-timeout (002), в случае, если распознавание началось и не найдено речи.
Значение задается в миллисекундах, в диапазоне [0..MAXTIMEOUT].

sint — speech incomplete timeout (msec)

i - digits to allow recognition to be interrupted with (by default DTMFs are sent to the MRCP server to recognize;
otherwise, if "any" or other digits are specified, recognition will be interrupted)

sct - speech complete timeout (msec)

Подробнее: unimrcp.org/manuals/html/AsteriskManual

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

Сервис использует следующие порты:

8060/tcp
8060/udp
5000-6000/udp
443/tcp
11554/tcp
6170/tcp

Сбор данных об ошибках

Сервис логи MRCP хранит по адресу

/opt/ums/mrcp/usr/local/unimrcp/log

Удаление UMC

Для удаления запустить инсталлятор с ключом:

./ums-X.XXX-universal.sh --uninstall

@@ Строка 1: / Строка 1: @@
 ===== '''Общее описание''' =====
-Сервис ums  это серверная реализация протокола MRCP предназначенная для работы с сервисом SPR
+Сервис UMS — это серверная реализация протокола MRCP, предназначенная для работы с сервисом SPR.
 ====='''Термины и определения'''=====
-UMS - Universal MRCP Server (расширенная реализация MRCP сервера для обработки речи)
+UMS — Universal MRCP Server (расширенная реализация MRCP-сервера для обработки речи)
-MRCP - Media Resource Control Protocol (протокол управления медиа-ресурсами )
-SRP - Short Phrase Recognized (продукт для распознавания речи)
+MRCP — Media Resource Control Protocol (протокол управления медиа-ресурсами)
+SRP — Short Phrase Recognized (продукт для распознавания речи)
+VAD — Voice Activity Detection (обнаружение голосовой активности во входном акустическом сигнале для отделения активной речи от фонового шума или тишины)
-VAD -Voice Activity Detection (обнаружение голосовой активности во входном акустическом сигнале для отделения активной речи от фонового шума или тишины)
-====='''Установка пакета'''=====
+====='''Установка пакета UMC'''=====
-[https://cloud.connect2ai.net/index.php/apps/files/?dir=/ums&fileid=508 Дистрибутив] распространяется в виде универсального установочного пакета.
+[https://cloud.connect2ai.net/index.php/apps/files/?dir=/ums&fileid=508 Дистрибутив] распространяется в виде универсального установочного пакета. Пакет может быть установлен в ''онлайн''-режиме (при наличии доступа к репозиториям) или оффлайн (с предварительно собранными пакетами).  Для установки в оффлайн-режиме сперва нужно запустить экземпляр скрипта на копии целевой системы (версия и ядро ОС) с доступом к репозиториям. Для установки пакета запустить инсталлятор с требуемыми ключами. При запуске без ключей инсталлятор выдаст короткую справку. Например.
-Пакет может быть установлен в ''онлайн'' режиме (при наличии доступа к репозиториям) или ''оффлайн'' (с предварительно собранными пакетами).
-Для установки в оффлайн режиме сперва нужно запустить экземпляр скрипта на копии целевой системы (версия и ядро ОС) с доступом к репозиториям.
-Для установки пакета запустить инсталлятор с требуемыми ключами. При запуске без ключей инсталлятор выдаст короткую справку.
-Например
   -Установить сервис онлайн
 <code>./ums-X.XXX-universal.sh -i -on</code>
@@ Строка 33: / Строка 34: @@
   -Удалить внутренний архив из скрипта
 <code>./ums-X.XXX-universal.sh --null</code>
 ====='''Конфигурирование'''=====
@@ Строка 42: / Строка 45: @@
 <code>}</code>
-UMS в составе содержит nginx сервер. Его файл конфигурации: <code>/opt/ums/nginx/etc/nginx/conf.d/default.conf.example</code>
+UMS в составе содержит nginx-сервер. Его файл конфигурации: /opt/ums/nginx/etc/nginx/conf.d/default.conf.example. В нем, возможно, будет необходимость править таймауты.
-В нем возможно будет необходимость править таймауты.
-На поведение UMS также влияет строка запроса например:
+На поведение UMS также влияет строка запроса, например:
 <code>builtin:grammar/calls?language=ru-RU&b=1&spl=ru-RU&i=any&ct=0.7&sl=0.7&sint=1000&sct=800&nit=3000</code>
@@ Строка 51: / Строка 53: @@
 '''Параметры распознавания:'''
-  b — Возможность прервать проигрываемый файл (режим barge-in) и начать распознавание (нельзя перебить=0, можно перебить
+  '''b''' — Возможность прервать проигрываемый файл (режим barge-in) и начать распознавание
- и обнаружение речи осуществляет ASR движок=1, можно перебить и обнаружение речи осуществляет Asterisk=2)
-  t — Время, по истечении которого система распознавания может прервать процедуру распознавания с кодом
+  (нельзя перебить = 0, можно перебить и обнаружение речи осуществляет ASR движок = 1, можно перебить и обнаружение
-recognition-timeout (003), в случае, если распознавание началось, и нет ни одного варианта распознавания. Значение задается в миллисекундах
-в диапазоне [0..MAXTIMEOUT].
-  ct — Порог уверенного распознавания (0.0 – 1.0).
+  речи осуществляет Asterisk = 2).
-Если confidence-level, возвращаемый при распознавании, меньше confidence-threshold, то результат распознавания no match.
-  sl — Чувствительность к несловарным командам. (0.0 — 1.0). Чем больше значение, тем выше чувствительность к шуму.
+  '''t''' — Время, по истечении которого система распознавания может прервать процедуру распознавания с кодом.
-  nit — no input timeout (msec) Время, по истечении которого система распознавания может прервать процедуру
+  recognition-timeout (003) в случае, если распознавание началось и нет ни одного варианта распознавания.
-  распознавания, с кодом no-input-timeout (002), в случае, если распознавание началось и не найдено речи.
+  Значение задается в миллисекундах ↵в диапазоне [0..MAXTIMEOUT].
+ '''ct''' — Порог уверенного распознавания (0.0 – 1.0).
+ Если confidence-level, возвращаемый при распознавании, меньше confidence-threshold, то результат распознавания — no match.
+ '''sl''' — Чувствительность к несловарным командам. (0.0 — 1.0). Чем больше значение, тем выше чувствительность к шуму.
+ '''nit''' — no input timeout (msec) Время, по истечении которого система распознавания может прервать процедуру распознавания с кодом
+ no-input-timeout (002), в случае, если распознавание началось и не найдено речи.
   Значение задается в миллисекундах, в диапазоне [0..MAXTIMEOUT].
-  sint — speech incomplete timeout (msec)
+  '''sint''' — speech incomplete timeout (msec)
-  i - digits to allow recognition to be interrupted with (by default DTMFs are sent to the MRCP server to recognize;
+  '''i''' - digits to allow recognition to be interrupted with (by default DTMFs are sent to the MRCP server to recognize;
   otherwise, if "any" or other digits are specified, recognition will be interrupted)
-  sct - speech complete timeout (msec)
+  '''sct''' - speech complete timeout (msec)
+Подробнее: [https://www.unimrcp.org/manuals/html/AsteriskManual.html#_Toc424230605 unimrcp.org/manuals/html/AsteriskManual]
+====='''Протоколы и порты'''=====
+Сервис использует следующие порты:
+* 8060/tcp
+* 8060/udp
+* 5000-6000/udp
+* 443/tcp
+* 11554/tcp
+* 6170/tcp
+====='''Сбор данных об ошибках'''=====
+Сервис логи MRCP хранит по адресу
+<code>/opt/ums/mrcp/usr/local/unimrcp/log</code>
+====='''Удаление UMC'''=====
+Для удаления запустить инсталлятор с ключом:
+<code>./ums-X.XXX-universal.sh --uninstall<code>