This version of the Speechly documentation is no longer actively maintained. For up-to-date documentation, see the latest version.

Configuring Your Application

Natural Language Understanding (NLU) configuration improves speech-to-text accuracy and extracts keywords and intents from speech in real time.

Real-time Natural Language Understanding (NLU) features

  • Real-time intent detection – returns the meaning of the speech segment
  • Real-time entity detection and classification - returns the keywords and their types in the speech segment
  • Speech-to-text adaptation: Tweaks the ASR engine to prefer the vocabulary used in the NLU configuration. This improves the accuracy for your use case, especially if you require e.g. uncommon brand names or specialist jargon.

Note: NLU features are not available via Batch API and On-device APIs

Enabling NLU

The NLU configuration is empty by default and NLU features are disabled. Without NLU, Speechly operates in speech-to-text mode and returns no intents or entities.

To enable the NLU features, you’ll need to provide a NLU configuration for your app id in the Dashboard or with the CLI tool.

The configuration contains text phrases users might say. Each phrase is tagged with an intent. Keywords can tagged, too, so they get returned to your app as entities. There’s also special syntax for generating phrases automatically.

Getting started

Why must I configure my application?

In general it is necessary to design the utterances for each application separately. With Speechly, the configuration serves two equally important purposes:

  1. Teaching our speech recognition system the vocabulary that is relevant in your application. An application may require the use of uncommon words (e.g. obscure brand names or specialist jargon) that must explicitly be taught to our speech recognition model.

  2. Defining the information (intents and entities) that should be extracted from users' utterances. It is difficult to provide ready-made configurations that would sufficiently suit a variety of use-cases. The set of intents and entities are tightly coupled with the workings of each specific application.

Last updated by Mathias Lindholm on June 20, 2022 at 16:53 +0300

Found an error on our documentation? Please file an issue or make a pull request