Quick Start

The official Speechly Quick Start helps you get started on developing with Speechly.

Welcome to Speechly Quick Start!

Video Quick Start

This Quick Start will guide you through the basics of building Spoken Language Understanding models with Speechly. It covers the following steps:

  1. Creating an application
  2. Creating your first SLU configuration
  3. Trying out the application in the Speechly Playground
  4. Integrating Speechly to your application

The best way to start developing with Speechly is to complete this Quick Start.

1 Creating an application

The first step is to navigate to the Speechly Dashboard in order to create an account, and accept the terms and conditions.

Screenshot from the Speechly Dashboard signup screen
Creating a Speechly account screenshot.

After creating a user account, you will land on the Speechly Dashboard main page, where you manage your applications.

Proceed to creating a new application by clicking the blue Create application button.

Screenshot from the Speechly Dashboard opening screen
The Speechly Dashboard screenshot.

Name your application, select English as the language and Home Automation as the template.

Screenshot from the Speechly Dashboard New Application screen
New Speechly application screenshot.

2 Deploying your first SLU model

Screenshot from the Speechly Dashboard SLU Example configuration view
The SLU Example configuration view.

A Speechly application is configured by providing it with a set of annotated example utterances. Your Home Automation application contains a ready-made configuration that you can deploy by clicking the blue Deploy button in the bottom right corner of the screen.

The deploying should take 1-2 minutes.

A figure explaining one utterance with its intent and entities tagged by using Speechly Annotation Language
An utterance annotated using the Speechly Annotation Language.

Advanced SLU Examples

Please take a look at advanced SLU examples to learn more about the SAL syntax.

3 Trying out the application

Once the application has been deployed, the Try button next to Deploy should turn active, and the status bar shows a green dot reading “Deployed”. Now it’s time to test your application, so click Try to go to the Playground.

Click on Tap to start on the bottom of the page, and give your browser the permissions to use the microphone. A microphone button appears.

Now you can click and hold the microphone to start sending audio to the Speechly API. Click and hold either the microphone button or the space bar and say, “Switch off the lights in the kitchen.” You’ll now see the transcript of what you said along with the intent (turn_off) and the entities (lights and kitchen).

You’re done! Now you can continue trying out different utterances. Or else, you can go back to the configuration screen editing your example phrases in order to teach your model to understand a greater variety of commands.

Learn more!

Next, you can try adding a new intent to the configuration. A useful function to add to a Home Automation application could be that of adjusting the brightness of the lights. Add a new intent, say, set_brightness, which can change the light brightness to a value ranging from 1 to 100 in different rooms. You can learn more about the SAL syntax here.


Profile image for karoliina-louhema

Last updated by karoliina-louhema on September 17, 2020 at 13:22 +0300

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