This guide describes how to obtain and install binary packages for the Microsoft Azure Bot Service (ABS) plugin to the UniMRCP server on Debian-based Linux distributions. The document is intended for system administrators and developers.
Instructions provided in this guide are applicable to the following versions.
UniMRCP 1.7.0 and above
UniMRCP ABS Plugin 1.0.0 and above
The following Azure APIs are supported by the plugin.
API | Availability |
---|---|
LUIS | ABS 1.0.0 and above |
Service Bot (Direct Line Speech) | ABS 1.1.0 and above |
Service Bot (STT + Direct Line) | ABS 1.6.0 and above |
UniMRCP deb packages are currently available for x86_64 (64-bit) architecture only.
Operating System | Released | End of Support |
---|---|---|
Ubuntu 16.04 LTS (xenial) | May 2020 | March 2021 |
Ubuntu 18.04 LTS (bionic) | May 2020 | June 2023 |
Ubuntu 20.04 LTS (focal) | March 2021 | TBA |
Ubuntu 22.04 LTS (jammy) | April 2023 | TBA |
Packages for other distributions can be developed and made available in the scope of an annual maintenance agreement.
UniMRCP binary packages are available to authenticated users only. In order to register a free account, please visit the following page.
A newly registered account needs to be verified by the user and then activated by the administrator prior further proceeding.
Account verification and activation.
The account credentials can be used to log in to the following websites.
Using the APT package handling utility (apt-get) is recommended for installation of UniMRCP binary packages.
Supply login information by creating a file /etc/apt/auth.conf.d/unimrcp.conf containing the following entry.
machine unimrcp.org
login username
password password
The username and password fields must be replaced with the corresponding account credentials.
Account credentials.
Configure a repository by creating a file /etc/apt/sources.list.d/unimrcp.list containing the following entry.
deb [arch=amd64] https://unimrcp.org/repo/apt/ distr main
The distr field must be replaced with the corresponding distribution code name such as xenial, bionic, focal, etc. To determine the distribution code, use lsb_release -cs
.
Distribution code name.
For verification of binary packages, UniMRCP provides a public GnuPG key, which can be retrieved and installed as follows.
wget -O - https://unimrcp.org/keys/unimrcp-gpg-key.public | sudo apt-key add -
In order to check for updates and apply the changes in the APT configuration, use the following command.
sudo apt-get update
In order to install the ABS plugin, including all the dependencies, use the following command.
sudo apt-get install unimrcp-azure-bot
As a result, apt-get will check and prompt to download all the required packages by installing them in the directory /opt/unimrcp.
In order to install the additional data files for the sample client application umc, the following command can be used.
sudo apt-get install umc-addons
This package is optional and provides additional data to be used for validation of basic setup.
UniMRCP deb packages can be installed manually using the dpkg utility. Note, however, that the system administrator should take care of package dependencies and install all the packages in appropriate order.
The deb packages have the following naming convention:
$packagename_$universion-$distr_$arch.deb
where
packagename is the name of a package
universion is the UniMRCP version
distr is the distribution code name (trusty, xenial, …)
arch is the architecture (amd64, i386, all, …)
The following is a list of UniMRCP deb packages required for the installation of the ABS plugin.
Package Name | Description |
---|---|
unimrcp-azure-bot | Azure Bot Service plugin to the server. |
uniazuresdk | UniMRCP edition of the Azure Speech SDK library. |
umc-addons | Sample en-US data files used with umc. [Optional] |
unilicnodegen | Node information retrieval tool, required for license deployment. |
unimrcp-server | Shared library and application of the server. |
unimrcp-client | Shared libraries and sample applications of the client. [Optional] |
unimrcp-demo-plugins | Set of demo plugins to the server. [Optional] |
unimrcp-common | Data common for the client and the server. |
uniapr | UniMRCP edition of the Apache Portable Runtime (APR) library. |
uniapr-util | UniMRCP edition of the Apache Portable Runtime Utility (APR-Util) library. |
unisofia-sip | UniMRCP edition of the Sofia SIP library. |
Packages for APR, APR-Util and Sofia-SIP libraries must be installed first.
sudo dpkg --install uniapr_$aprversion-$distr_$arch.deb
sudo dpkg --install uniapr-util_$apuversion-$distr_$arch.deb
sudo dpkg --install unisofia-sip_$sofiaversion-$distr_$arch.deb
Then, a package containing common data for the client and the server, and a package for the server should follow.
sudo dpkg --install unimrcp-common_$universion-$distr_$arch.deb
sudo dpkg --install unimrcp-server_$universion-$distr_$arch.deb
Next, a package containing the utility tool unilicnodegen, required for license deployment.
sudo dpkg --install unilicnodegen_$toolversion-$distr_$arch.deb
Finally, a package containing the Azure Bot plugin should follow.
sudo dpkg --install unimrcp-azure-bot_$universion-$distr_$arch.deb
The ABS plugin to the UniMRCP server is a licensed software.
In order to obtain a trial license, node information must be retrieved and submitted for license generation.
Use the installed tool unilicnodegen to retrieve the node information.
sudo /opt/unimrcp/bin/unilicnodegen
As a result, a text file uninode.info will be saved in the current directory.
Consider the following procedure to place an order.
- Navigate to https://unispeech.io/azbot.
- Under the section Obtain License, select
- License Variation: Trial
- License Term: 30-day
- License Type: Node-bound
- License Quantity: 2
- Click Add to cart and then View cart.
- Click Proceed to checkout and then Place order.
- Attach the retrieved uninode.info file to the placed order.
Ther orders are normally processed within one business day. A license file will be provided as a result.
The license file needs to be placed into the directory /opt/unimrcp/data.
sudo cp umsazurebot_*.lic /opt/unimrcp/data
In order to utilize either the LUIS API and/or the Bot Service API, corresponding service subscription key and region need to be retrieved from the Microsoft Azure portal and further installed to the UniMRCP server.
Navigate to the Microsoft Azure dashboard and create a new resource.
- Navigate to the Dashboard.
- Create a LUIS app for intent recognition
and/or
Create a bot with the Direct Line Speech channel- Collect one of the two keys (1) and the region (2).
Create a text file azbot.subscription.key in the directory /opt/unimrcp/data.
sudo nano /opt/unimrcp/data/azbot.subscription.key
Place the collected key and the region in the following JSON format.
{
"subscription-key": "*******************************",
"region": "westus",
"service-endpoint": "",
"api": ""
}
If the credentials are supposed to be used with a LUIS app, then the api token must be set to luis.
Otherwise, for a bot service, the api token shall remain empty or be set to dsc (Direct Line Speech via Direct Service Connector) or to stt-dsc (STT + Direct Line via Direct Service Connector).
In order to load the ABS plugin into the UniMRCP server, open the file unimrcpserver.xml, located in the directory /opt/unimrcp/conf, and add the following entry under the XML element <plugin-factory>. Disable other recognition plugins, if available. The demo plugins for other resources can also be disabled.
<!-- Factory of plugins (MRCP engines) -->
<plugin-factory>
<engine id="Demo-Recog-1" name="demorecog" enable="false"/>
<engine id="Azure-Bot-1" name="umsazurebot" enable="true"/>
</plugin-factory>
In order to enable log output from the plugin and set filtering rules, open the configuration file logger.xml, located in the directory /opt/unimrcp/conf, and add the following entry under the element <sources>.
<source name="AZUREBOT-PLUGIN" priority="INFO" masking="NONE"/>
The configuration file of the plugin is located in /opt/unimrcp/conf/umsazurebot.xml. Default settings should be sufficient for the general use.
Validate your setup by using the sample UniMRCP client and server applications on the same host. The default configuration and data files should be sufficient for a basic test.
This step is required if a LUIS app is used and can be skipped for bot service.
Create a new or use an existing LUIS application.
In order to reference the LUIS application, the corresponding App ID must be specified in the configuration file of the plugin, located in /opt/unimrcp/conf/umsazurebot.xml.
<streaming-recognition
language="en-US"
appid="********-****-****-****-************ "
/>
Note that the application identifier can also be specified per recognition request. See the Usage Guide for more information.
Launch the UniMRCP server application as a service
sudo systemctl start unimrcp
Open the current log file located in /opt/unimrcp/log/unimrcpserver_current.log, and check whether the plugin is normally loaded.
[INFO] Load Plugin [Azure-Bot-1\] [/opt/unimrcp/plugin/umsazurebot.so]
Next, check for the license information.
[NOTICE] UniMRCP AZUREBOT License
-product name: umsazurebot
-product version: 1.0.0
-license owner: -
-license type: trial
-issue date: 2020-04-25
-exp date: 2020-05-25
-channel count: 2
-feature set: 0
The optional package umc-addons must be installed for this test to work.
Launch the sample UniMRCP client application umc.
cd /opt/unimrcp/bin
./umc
Run a typical speech recognition scenario by issuing the command run gdf1 from the console of the umc client application.
run gdf1
This command sends a RECOGNIZE request to the server and then starts streaming a sample audio input file bookroom.pcm to recognize.
Check for the NLSML results. Note that deepening on the referenced LUIS mode, the content may differ.
<?xml version="1.0"?>
<result>
<interpretation grammar="builtin:speech/transcribe" confidence="0.777">
<instance>
<object><string name="query">book a room</string>
<object name="topScoringIntent">
<string name="intent">RoomReservation.Reserve</string>
<number name="score">0.77710616600000004</number>
</object>
<array name="entities"></array>
</object>
</instance><input mode="speech">book a room</input>
</interpretation>
</result>
Visually inspect the log output for any possible warnings or errors.
Note that utterances are stored in the var directory, if the corresponding parameter is enabled in the configuration file umsazurebot.xml and/or requested by the client.