Document AI Warehouse: Node.js Client

release level npm version

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


Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Document AI Warehouse 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/contentwarehouse

Using the client library

 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 *  Required. The parent, which owns this collection of document.
 *  Format: projects/{project_number}/locations/{location}.
// const parent = 'abc123'
 *  The maximum number of rule sets to return. The service may return
 *  fewer than this value.
 *  If unspecified, at most 50 rule sets will be returned.
 *  The maximum value is 1000; values above 1000 will be coerced to 1000.
// const pageSize = 1234
 *  A page token, received from a previous `ListRuleSets` call.
 *  Provide this to retrieve the subsequent page.
 *  When paginating, all other parameters provided to `ListRuleSets`
 *  must match the call that provided the page token.
// const pageToken = 'abc123'

// Imports the Contentwarehouse library
const {RuleSetServiceClient} = require('@google-cloud/contentwarehouse').v1;

// Instantiates a client
const contentwarehouseClient = new RuleSetServiceClient();

async function callListRuleSets() {
  // Construct request
  const request = {

  // Run request
  const iterable = await contentwarehouseClient.listRuleSetsAsync(request);
  for await (const response of iterable) {



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

SampleSource CodeTry it
Document_link_service.create_document_linksource codeOpen in Cloud Shell
Document_link_service.delete_document_linksource codeOpen in Cloud Shell
Document_link_service.list_linked_sourcessource codeOpen in Cloud Shell
Document_link_service.list_linked_targetssource codeOpen in Cloud Shell
Document_schema_service.create_document_schemasource codeOpen in Cloud Shell
Document_schema_service.delete_document_schemasource codeOpen in Cloud Shell
Document_schema_service.get_document_schemasource codeOpen in Cloud Shell
Document_schema_service.list_document_schemassource codeOpen in Cloud Shell
Document_schema_service.update_document_schemasource codeOpen in Cloud Shell
Document_service.create_documentsource codeOpen in Cloud Shell
Document_service.delete_documentsource codeOpen in Cloud Shell
Document_service.fetch_aclsource codeOpen in Cloud Shell
Document_service.get_documentsource codeOpen in Cloud Shell
Document_service.lock_documentsource codeOpen in Cloud Shell
Document_service.search_documentssource codeOpen in Cloud Shell
Document_service.set_aclsource codeOpen in Cloud Shell
Document_service.update_documentsource codeOpen in Cloud Shell
Rule_set_service.create_rule_setsource codeOpen in Cloud Shell
Rule_set_service.delete_rule_setsource codeOpen in Cloud Shell
Rule_set_service.get_rule_setsource codeOpen in Cloud Shell
Rule_set_service.list_rule_setssource codeOpen in Cloud Shell
Rule_set_service.update_rule_setsource codeOpen in Cloud Shell
Synonym_set_service.create_synonym_setsource codeOpen in Cloud Shell
Synonym_set_service.delete_synonym_setsource codeOpen in Cloud Shell
Synonym_set_service.get_synonym_setsource codeOpen in Cloud Shell
Synonym_set_service.list_synonym_setssource codeOpen in Cloud Shell
Synonym_set_service.update_synonym_setsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

The Document AI Warehouse 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/contentwarehouse@legacy-8 installs client libraries for versions compatible with Node.js 8.


This library follows Semantic Versioning.

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.

More Information: Google Cloud Platform Launch Stages


Contributions welcome! See the Contributing Guide.

Please note that this, the samples/, 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.


Apache Version 2.0