Back to Google Cloud Node

[Data Labeling API: Nodejs Client][homepage]

packages/google-cloud-datalabeling/README.md

0.57.011.4 KB
Original Source

Data Labeling API: Nodejs Client

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.

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

bash
npm install @google-cloud/datalabeling

Samples

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

SampleSource Code
create annotation spec setsource code
create datasetsource code
create evaluation jobsource code
create instructionsource code
delete annotated datasetsource code
delete annotation spec setsource code
delete datasetsource code
delete evaluation jobsource code
delete instructionsource code
export datasource code
get annotated datasetsource code
get annotation spec setsource code
get data itemsource code
get datasetsource code
get evaluationsource code
get evaluation jobsource code
get examplesource code
get instructionsource code
import datasource code
label imagesource code
label textsource code
label videosource code
list annotated datasetssource code
list annotation spec setssource code
list data itemssource code
list datasetssource code
list evaluation jobssource code
list examplessource code
list instructionssource code
pause evaluation jobsource code
resume evaluation jobsource code
search evaluationssource code
search example comparisonssource code
update evaluation jobsource code
cloudsource 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