Document AI Warehouse 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

Document AI Warehouse API client for Node.js

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

• Document AI Warehouse API Nodejs Client API Reference

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 Document AI Warehouse API API.
4. Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/contentwarehouse

Samples

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

| Sample | Source Code | | --------------------------- | --------------------------------- | | create document link | source code | | delete document link | source code | | list linked sources | source code | | list linked targets | source code | | create document schema | source code | | delete document schema | source code | | get document schema | source code | | list document schemas | source code | | update document schema | source code | | create document | source code | | delete document | source code | | fetch acl | source code | | get document | source code | | lock document | source code | | search documents | source code | | set acl | source code | | update document | source code | | run pipeline | source code | | create rule set | source code | | delete rule set | source code | | get rule set | source code | | list rule sets | source code | | update rule set | source code | | cloud | source code | | create synonym set | source code | | delete synonym set | source code | | get synonym set | source code | | list synonym sets | source code | | update synonym set | 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/contentwarehouse@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