@google-cloud/datalabeling

Google Cloud Data Labeling: Node.js Client

Data Labeling API client for Node.js

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

• Google Cloud Data Labeling Node.js Client API Reference
• Google Cloud Data Labeling Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-datalabeling

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
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

Quickstart

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});
  console.log('Datasets:');
  console.log(result);
}
quickstart();

Samples

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

Sample	Source Code	Try it
Data_labeling_service.create_annotation_spec_set	source code
Data_labeling_service.create_dataset	source code
Data_labeling_service.create_evaluation_job	source code
Data_labeling_service.create_instruction	source code
Data_labeling_service.delete_annotated_dataset	source code
Data_labeling_service.delete_annotation_spec_set	source code
Data_labeling_service.delete_dataset	source code
Data_labeling_service.delete_evaluation_job	source code
Data_labeling_service.delete_instruction	source code
Data_labeling_service.export_data	source code
Data_labeling_service.get_annotated_dataset	source code
Data_labeling_service.get_annotation_spec_set	source code
Data_labeling_service.get_data_item	source code
Data_labeling_service.get_dataset	source code
Data_labeling_service.get_evaluation	source code
Data_labeling_service.get_evaluation_job	source code
Data_labeling_service.get_example	source code
Data_labeling_service.get_instruction	source code
Data_labeling_service.import_data	source code
Data_labeling_service.label_image	source code
Data_labeling_service.label_text	source code
Data_labeling_service.label_video	source code
Data_labeling_service.list_annotated_datasets	source code
Data_labeling_service.list_annotation_spec_sets	source code
Data_labeling_service.list_data_items	source code
Data_labeling_service.list_datasets	source code
Data_labeling_service.list_evaluation_jobs	source code
Data_labeling_service.list_examples	source code
Data_labeling_service.list_instructions	source code
Data_labeling_service.pause_evaluation_job	source code
Data_labeling_service.resume_evaluation_job	source code
Data_labeling_service.search_evaluations	source code
Data_labeling_service.search_example_comparisons	source code
Data_labeling_service.update_evaluation_job	source code
Get Datasets	source code

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.

Versioning

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

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