Client Library API Reference

See also Web Speech API, Web Components, Unreal Engine 4 and gRPC protobuf definitions.

Overview

• Overview
• Preparing the client library and the audio source
• Provide a handler for the results
• Start speech processing
• Stop speech processing
• The Segment data structures
• Intent
• Entity
• Transcript

Preparing the client library and the audio source

// Pseudocode. Preparation steps may vary per client library.
// See specific API reference for details.
speechly_client = new SpeechlyClient()
speechly_client.initialize()
// Open the microphone or audio source before attaching
speechly_client.attach( audio_source )

Preparation consists of the following tasks:

1. Creating the client instance.
2. Initializing Speechly’s speech recognition engine.
3. Opening and attaching an audio source (e.g. microphone).

An authorization token needs to be provided during the preparation steps. Either an app_id or project_id can be used. These can be acquired via the Dashboard or Command Line Tool.

Provide a handler for the results

// Pseudocode. See specific API reference for details.
speechly_client.onSegmentChange( fn(segment) )

fn is the function you pass for handling the words, intents and entities detected by the speech recognition engine. They are passed in a segment structure.

As the user speaks, the handler is called repeatedly with an updated results.

• See segment

Start speech processing

// Pseudocode
context_id = await speechly_client.start( app_id )

Starts streaming audio from the microphone (or other audio source) to the speech recognition engine. The client library gathers result events from the HTTP/gRPC API and fires onSegmentChange and other relevant callbacks.

project_id authorization during the preparation allows you to direct the audio to any app configuration within the project by providing the app_id argument.

Stop speech processing

// Pseudocode
await speechly_client.stop()

Stops streaming audio to the speech recognition engine and wait for remaining results to arrive. Callbacks fire until the audio stream has been fully processed.

The Segment data structures

// Pseudocode
struct Segment {
    contextId: string,
    id: int,
    isFinal: boolean,
    intent: Intent,
    entities: list<Entity>,
    words: list<Transcript>
}

Intent

Intent { name: string, isFinal: boolean }

Entity

Entity { name: string, value: string, isFinal: boolean,
         startIndex: int, endIndex: int }

Transcript

Transcript { index: int, value: string, isFinal: boolean }