@speechly/browser-client

speechly-browser-client

This repository contains source code for the browser client for Speechly SLU API. Speechly allows you to easily build applications with voice-enabled UIs.

Usage

Install the package:

# Using Yarn
yarn add @speechly/browser-client

# Using NPM
npm install --save @speechly/browser-client

Start using the client:

import { Client, Segment } from "@speechly/browser-client";

// Create a new Client. appId and language are configured in the dashboard.
const client = new Client({
  appId: "your-app-id",
  language: "en-US",
});

// Initialize the client - this will ask the user for microphone permissions and establish the connection to Speechly API.
// Make sure you call `initlialize` from a user action handler (e.g. from a button press handler).
await client.initialize();

// React to the updates from the API.
client.onSegmentChange((segment: Segment) => {
  console.log(
    "Received new segment from the API:",
    segment.intent,
    segment.entities,
    segment.words,
    segment.isFinal
  );
});

// Start recording.
// Ideally this should be bound to e.g. a button press.
await client.startContext();

// Stop recording after a timeout.
// Ideally this should be bound to e.g. a button press.
setTimeout(async function() {
  await client.stopContext();
}, 3000);

Check out the browser-client-example repository for a demo app built using this client.

Documentation

You can find the detailed API documentation in GitHub repository.

Contributing

See contribution guide in CONTRIBUTING.md.