Cheetah Speech-to-Text
Node.js Quick Start

Platforms

• Linux (x86_64)
• macOS (x86_64, arm64)
• Windows (x86_64, arm64)
• Raspberry Pi (3, 4, 5)

Requirements

• Picovoice Account & AccessKey
• Node.js 18+
• npm

Picovoice Account & AccessKey

Signup or Login to Picovoice Console to get your AccessKey. Make sure to keep your AccessKey secret.

Quick Start

Setup

1. Install Node.js.

2. Install the cheetah-node npm package:

npm install @picovoice/cheetah-node

Usage

Create an instance of the engine:

const Cheetah = require("@picovoice/cheetah-node");

const accessKey = "${ACCESS_KEY}";
const cheetah = new Cheetah(accessKey);

Transcribe audio:

function getNextAudioFrame() {
  // ...
  return audioFrame;
}

while (true) {
  const audioFrame = getNextAudioFrame();
  const [partialTranscript, isEndpoint] = cheetah.process(audioFrame);
  if (isEndpoint) {
    finalTranscript = cheetah.flush()
  }
}

Release resources explicitly when done with Cheetah Streaming Speech-to-Text:

cheetah.release()

Model File

The Cheetah Speech-to-Text Node.js SDK comes preloaded with a default English language model (.pv file). Default models for other supported languages can be found in the Cheetah Speech-to-Text GitHub repository.

Create custom language models using the Picovoice Console. Here you can train language models with custom vocabulary and boost words in the existing vocabulary.

Pass in the .pv file via the modelPath parameter in the options argument of the Cheetah Speech-to-Text constructor:

const handle = new Cheetah(accessKey, { modelPath: "${MODEL_PATH}"});

Demo

For the Cheetah Streaming Speech-to-Text Node.js SDK, we offer demo applications that demonstrate how to use the Speech-to-Text engine on real-time audio streams (i.e. microphone input) and audio files.

Setup

Install the Cheetah Streaming Speech-to-Text demo package:

npm install -g @picovoice/cheetah-node-demo

This package installs command-line utilities for the Cheetah Streaming Speech-to-Text Node.js demos.

Usage

Use the --help flag to see the usage options for the demo:

cheetah-demo-mic --help

Ensure you have a working microphone connected to your system and run the following command to transcribe audio live:

cheetah-demo-mic --access_key ${ACCESS_KEY}

For more information on our Cheetah Streaming Speech-to-Text demos for Node.js, head over to our GitHub repository.

Resources