Skip to content

Latest commit

 

History

History

README.md

Google Cloud Platform logo

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.

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:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Data Labeling API API.
  4. Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/datalabeling

Samples

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

Sample Source Code
create annotation spec set source code
create dataset source code
create evaluation job source code
create instruction source code
delete annotated dataset source code
delete annotation spec set source code
delete dataset source code
delete evaluation job source code
delete instruction source code
export data source code
get annotated dataset source code
get annotation spec set source code
get data item source code
get dataset source code
get evaluation source code
get evaluation job source code
get example source code
get instruction source code
import data source code
label image source code
label text source code
label video source code
list annotated datasets source code
list annotation spec sets source code
list data items source code
list datasets source code
list evaluation jobs source code
list examples source code
list instructions source code
pause evaluation job source code
resume evaluation job source code
search evaluations source code
search example comparisons source code
update evaluation job source code
cloud source code

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.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template.

License

Apache Version 2.0

See LICENSE