by googleapis

googleapis / nodejs-speech

Node.js client for Google Cloud Speech: Speech to text conversion powered by machine learning.

495 Stars 243 Forks Last release: about 1 month ago (v4.1.3) Apache License 2.0 527 Commits 59 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Google Cloud Platform logo

Cloud Speech: Node.js Client

release level npm version codecov

Cloud Speech Client Library for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:


Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable the Cloud Speech API.
  3. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/speech

Using the client library

// Imports the Google Cloud client library
const speech = require('@google-cloud/speech');
const fs = require('fs').promises;

// Creates a client const client = new speech.SpeechClient();

async function quickstart() { // The name of the audio file to transcribe const fileName = './resources/audio.raw';

// Reads a local audio file and converts it to base64 const file = await fs.readFile(fileName); const audioBytes = file.toString('base64');

// The audio file's encoding, sample rate in hertz, and BCP-47 language code const audio = { content: audioBytes, }; const config = { encoding: 'LINEAR16', sampleRateHertz: 16000, languageCode: 'en-US', }; const request = { audio: audio, config: config, };

// Detects speech in the audio file const [response] = await client.recognize(request); const transcription = response.results .map(result => result.alternatives[0].transcript) .join('\n'); console.log(Transcription: ${transcription}); } quickstart();


Samples are in the

directory. The samples'
has instructions for running the samples.

| Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | | Microphone stream | source code | Open in Cloud Shell | | Beta Features | source code | Open in Cloud Shell | | Infinite Streaming | source code | Open in Cloud Shell | | Quickstart | source code | Open in Cloud Shell | | Recognize | source code | Open in Cloud Shell | | Recognize speech with metadata | source code | Open in Cloud Shell | | Transcribe Context Classes | source code | Open in Cloud Shell |

The Cloud Speech Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js.

Client libraries targetting some end-of-life versions of Node.js are available, and can be installed via npm dist-tags. The dist-tags follow the naming convention


Legacy Node.js versions are supported as a best effort:

  • Legacy versions will not be tested in continuous integration.
  • Some security patches may not be able to be backported.
  • Dependencies will not be kept up-to-date, and features will not be backported.

Legacy tags available

  • legacy-8
    : install client libraries from this dist-tag for versions compatible with Node.js 8.


This library follows Semantic Versioning.

This library is considered to be General Availability (GA). This means it is stable; the code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against GA libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages


Contributions welcome! See the Contributing Guide.

Please note that this
, the
, and a variety of configuration files in this repository (including
) are generated from a central template. To edit one of these files, make an edit to its template in this directory.


Apache Version 2.0


We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.