Google Cloud Data Labeling: Node.js Client

release level npm version

Data Labeling API client 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 billing for your project.
  3. Enable the Google Cloud Data Labeling API.
  4. 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/datalabeling

Using the client library

const {DataLabelingServiceClient} = require('@google-cloud/datalabeling');
const client = new DataLabelingServiceClient();

async function quickstart() {
  const parent = client.projectPath(projectId);
  const [result] = await client.listDatasets({parent});


Samples are in the samples/ directory. Each sample's has instructions for running its sample.

SampleSource CodeTry it
Data_labeling_service.create_annotation_spec_setsource codeOpen in Cloud Shell
Data_labeling_service.create_datasetsource codeOpen in Cloud Shell
Data_labeling_service.create_evaluation_jobsource codeOpen in Cloud Shell
Data_labeling_service.create_instructionsource codeOpen in Cloud Shell
Data_labeling_service.delete_annotated_datasetsource codeOpen in Cloud Shell
Data_labeling_service.delete_annotation_spec_setsource codeOpen in Cloud Shell
Data_labeling_service.delete_datasetsource codeOpen in Cloud Shell
Data_labeling_service.delete_evaluation_jobsource codeOpen in Cloud Shell
Data_labeling_service.delete_instructionsource codeOpen in Cloud Shell
Data_labeling_service.export_datasource codeOpen in Cloud Shell
Data_labeling_service.get_annotated_datasetsource codeOpen in Cloud Shell
Data_labeling_service.get_annotation_spec_setsource codeOpen in Cloud Shell
Data_labeling_service.get_data_itemsource codeOpen in Cloud Shell
Data_labeling_service.get_datasetsource codeOpen in Cloud Shell
Data_labeling_service.get_evaluationsource codeOpen in Cloud Shell
Data_labeling_service.get_evaluation_jobsource codeOpen in Cloud Shell
Data_labeling_service.get_examplesource codeOpen in Cloud Shell
Data_labeling_service.get_instructionsource codeOpen in Cloud Shell
Data_labeling_service.import_datasource codeOpen in Cloud Shell
Data_labeling_service.label_imagesource codeOpen in Cloud Shell
Data_labeling_service.label_textsource codeOpen in Cloud Shell
Data_labeling_service.label_videosource codeOpen in Cloud Shell
Data_labeling_service.list_annotated_datasetssource codeOpen in Cloud Shell
Data_labeling_service.list_annotation_spec_setssource codeOpen in Cloud Shell
Data_labeling_service.list_data_itemssource codeOpen in Cloud Shell
Data_labeling_service.list_datasetssource codeOpen in Cloud Shell
Data_labeling_service.list_evaluation_jobssource codeOpen in Cloud Shell
Data_labeling_service.list_examplessource codeOpen in Cloud Shell
Data_labeling_service.list_instructionssource codeOpen in Cloud Shell
Data_labeling_service.pause_evaluation_jobsource codeOpen in Cloud Shell
Data_labeling_service.resume_evaluation_jobsource codeOpen in Cloud Shell
Data_labeling_service.search_evaluationssource codeOpen in Cloud Shell
Data_labeling_service.search_example_comparisonssource codeOpen in Cloud Shell
Data_labeling_service.update_evaluation_jobsource codeOpen in Cloud Shell
Get Datasetssource codeOpen in Cloud Shell
Quickstart.testsource codeOpen in Cloud Shell

The Google Cloud Data Labeling 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/datalabeling@legacy-8 installs client libraries for versions compatible with Node.js 8.


This library follows Semantic Versioning.

This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

More Information: Google Cloud Platform Launch Stages


Contributions welcome! See the Contributing Guide.

Please note that this, the samples/, 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.


Apache Version 2.0