Cloud Speech: Node.js Client
Cloud Speech Client Library for Node.js
A comprehensive list of changes in each version may be found in the CHANGELOG .
- Cloud Speech Node.js Client API Reference
- Cloud Speech Documentation
- github.com/googleapis/google-cloud-node/packages/google-cloud-speech
Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained .
Table of contents:
Quickstart
Before you begin
- Select or create a Cloud Platform project .
- Enable the Cloud Speech API .
- 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
');
// Creates a client
const client = new speech. SpeechClient
();
async function quickstart() {
// The path to the remote LINEAR16 file
const gcsUri = 'gs://cloud-samples-data/speech/brooklyn_bridge.raw';
// The audio file's encoding, sample rate in hertz, and BCP-47 language code
const audio = {
uri: gcsUri,
};
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
Samples are in the samples/
directory. Each sample's README.md
has instructions for running its sample.
Sample | Source Code | Try it |
---|---|---|
Adaptation.create_custom_class
|
source code | ![]() |
Adaptation.create_phrase_set
|
source code | ![]() |
Adaptation.delete_custom_class
|
source code | ![]() |
Adaptation.delete_phrase_set
|
source code | ![]() |
Adaptation.get_custom_class
|
source code | ![]() |
Adaptation.get_phrase_set
|
source code | ![]() |
Adaptation.list_custom_classes
|
source code | ![]() |
Adaptation.list_phrase_set
|
source code | ![]() |
Adaptation.update_custom_class
|
source code | ![]() |
Adaptation.update_phrase_set
|
source code | ![]() |
Speech.long_running_recognize
|
source code | ![]() |
Speech.recognize
|
source code | ![]() |
Speech.streaming_recognize
|
source code | ![]() |
Adaptation.create_custom_class
|
source code | ![]() |
Adaptation.create_phrase_set
|
source code | ![]() |
Adaptation.delete_custom_class
|
source code | ![]() |
Adaptation.delete_phrase_set
|
source code | ![]() |
Adaptation.get_custom_class
|
source code | ![]() |
Adaptation.get_phrase_set
|
source code | ![]() |
Adaptation.list_custom_classes
|
source code | ![]() |
Adaptation.list_phrase_set
|
source code | ![]() |
Adaptation.update_custom_class
|
source code | ![]() |
Adaptation.update_phrase_set
|
source code | ![]() |
Speech.long_running_recognize
|
source code | ![]() |
Speech.recognize
|
source code | ![]() |
Speech.streaming_recognize
|
source code | ![]() |
Speech.batch_recognize
|
source code | ![]() |
Speech.create_custom_class
|
source code | ![]() |
Speech.create_phrase_set
|
source code | ![]() |
Speech.create_recognizer
|
source code | ![]() |
Speech.delete_custom_class
|
source code | ![]() |
Speech.delete_phrase_set
|
source code | ![]() |
Speech.delete_recognizer
|
source code | ![]() |
Speech.get_config
|
source code | ![]() |
Speech.get_custom_class
|
source code | ![]() |
Speech.get_phrase_set
|
source code | ![]() |
Speech.get_recognizer
|
source code | ![]() |
Speech.list_custom_classes
|
source code | ![]() |
Speech.list_phrase_sets
|
source code | ![]() |
Speech.list_recognizers
|
source code | ![]() |
Speech.recognize
|
source code | ![]() |
Speech.streaming_recognize
|
source code | ![]() |
Speech.undelete_custom_class
|
source code | ![]() |
Speech.undelete_phrase_set
|
source code | ![]() |
Speech.undelete_recognizer
|
source code | ![]() |
Speech.update_config
|
source code | ![]() |
Speech.update_custom_class
|
source code | ![]() |
Speech.update_phrase_set
|
source code | ![]() |
Speech.update_recognizer
|
source code | ![]() |
Quickstart
|
source code | ![]() |
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. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.
Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:
- Legacy versions are not tested in continuous integration.
- Some security patches and features cannot be backported.
- Dependencies cannot be kept up-to-date.
Client libraries targeting some end-of-life versions of Node.js are available, and
can be installed through npm dist-tags
.
The dist-tags follow the naming convention legacy-(version)
.
For example, npm install @google-cloud/speech@legacy-8
installs client libraries
for versions compatible with Node.js 8.
Versioning
This library follows Semantic Versioning .
This library is considered to be 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 stablelibraries are addressed with the highest priority.
More Information: Google Cloud Platform Launch Stages
Contributing
Contributions welcome! See the Contributing Guide .
Please note that this README.md
, the samples/README.md
,
and a variety of configuration files in this repository (including .nycrc
and tsconfig.json
)
are generated from a central template. To edit one of these files, make an edit
to its templates in directory
.
License
Apache Version 2.0
See LICENSE