Cloud Document AI API: Nodejs Client

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 stable libraries are addressed with the highest priority

Cloud Document AI API client for Node.js

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

• Cloud Document AI API Nodejs Client API Reference
• Cloud Document AI API Documentation

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

• Versioning

• Contributing

• License

Quickstart

Before you begin

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

Installing the client library

npm install @google-cloud/documentai

Samples

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

| Sample | Source Code | | --------------------------- | --------------------------------- | | batch process documents | source code | | create processor | source code | | delete processor | source code | | delete processor version | source code | | deploy processor version | source code | | disable processor | source code | | enable processor | source code | | evaluate processor version | source code | | fetch processor types | source code | | get evaluation | source code | | get processor | source code | | get processor type | source code | | get processor version | source code | | list evaluations | source code | | list processor types | source code | | list processor versions | source code | | list processors | source code | | process document | source code | | review document | source code | | set default processor version | source code | | train processor version | source code | | undeploy processor version | source code | | cloud | source code | | batch process documents | source code | | create processor | source code | | delete processor | source code | | delete processor version | source code | | deploy processor version | source code | | disable processor | source code | | enable processor | source code | | evaluate processor version | source code | | fetch processor types | source code | | get evaluation | source code | | get processor | source code | | get processor type | source code | | get processor version | source code | | import processor version | source code | | list evaluations | source code | | list processor types | source code | | list processor versions | source code | | list processors | source code | | process document | source code | | review document | source code | | set default processor version | source code | | train processor version | source code | | undeploy processor version | source code | | batch delete documents | source code | | get dataset schema | source code | | get document | source code | | import documents | source code | | list documents | source code | | update dataset | source code | | update dataset schema | 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/documentai@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