Download
In order to use Iara's speech recognition, your application must use the iara-speech.js
and the Iara Local Service (ALS) must be running on the computer of each of your users.
1. Installation of the iara-speech.js
There are two ways to use the iara-speech.js
: through our CDN or with local installation (self-hosting).
1.1 Using the CDN (recommended)
The easiest and quickest way to use the iara-speech.js
is through our CDN. Add the following tag <script>
in your web application:
<script src="https://cdn.iarahealth.com/sdk/javascript/1.9.0/iara-speech.min.js"></script>
The HTML code of your application will look like the example below:
<html>
<head>
<!-- Iara Speech SDK -->
<script src="https://cdn.iarahealth.com/sdk/javascript/1.9.0/iara-speech.min.js"></script>
</head>
<body>
<!-- other tags in your application -->
</body>
The examples above use the version1.9.0
of the JavaScript SDK, but you can choose any version through the URL's path. All you have to do is provide the version number, as shown in the example below:
<script src="https://cdn.iarahealth.com/sdk/javascript/{VERSION}/iara-speech.min.js"></script>
where {VERSION}
is the version you wish to use, i.e: 1.9.0
, 1.5.0
, etc.
1.2 Serving locally
If you wish to serve the iara-speech.js
along with the other files in your web application, download the fileiara-speech.js
and place it in your application's folder alongside other Javascript libraries in use, i.e: js/
.
Then, add the following tag <script>
in your web application:
<script src="/path/to/iara-speech.js"></script>
The HTML code of your application will look like the example below:
<html>
<head>
<!-- Iara Speech SDK -->
<script src="/caminho/para/o/arquivo/iara-speech.js"></script>
</head>
<body>
<!-- other tags in your application -->
</body>
2. Installation of the Iara Local Service (ALS)
The Iara local service (ALS) does a lot of local processing to certifies speed for your application, in addition to security and privacy for user data.
As ALS is a native application, it needs to be installed by each user of your application who will use Iara's voice recognition.
IMPORTANT! If Iara's (ALS) local server don't is running on application's user computer, it will not be possible to use Iara's voice recognition.
ALS is available for Windows and Mac platforms. You can get the ALS installer for any of the supported platforms via the URL https://cdn.iarahealth.com/als/:
- Windows (iara-als-installer_win_x64.msi) [64 bits] Requires Windows 7 (SP2 or SP3), Windows 8 or Windows 10.
- Mac OSX (iara-als-installer_macosx_x64.dmg) [64 bits] Requires macOS 10.12 (Sierra), 10.13 (High Sierra) or 10.14 (Mojave).
During the initialization,
iara-speech.js
, will verify if ALS is running on user's computer. If it is not, the eventIaraEvent.INIT_FAIL
will be emitted.
You can handle events thrown by iara-speech.js
refering toALS be running locally and, then, inform to your user that ALS needs to be downloaded and installed.
For more information, please see the events page.