Google Cloud Platform logo

Document AI: Node.js Client

release level npm version codecov

Document AI client for Node.js

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 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/documentai

Using the client library

 * TODO(developer): Uncomment these variables before running the sample.
// const projectId = 'YOUR_PROJECT_ID';
// const location = 'YOUR_PROJECT_LOCATION'; // Format is 'us' or 'eu'
// const gcsInputUri = 'YOUR_SOURCE_PDF';

const {
} = require('@google-cloud/documentai');
const client = new DocumentUnderstandingServiceClient();

async function quickstart() {
  // Configure the request for processing the PDF
  const parent = `projects/${projectId}/locations/${location}`;
  const request = {
    inputConfig: {
      gcsSource: {
        uri: gcsInputUri,
      mimeType: 'application/pdf',

  // Recognizes text entities in the PDF document
  const [result] = await client.processDocument(request);

  // Get all of the document text as one big string
  const {text} = result;

  // Extract shards from the text field
  function extractText(textAnchor) {
    // First shard in document doesn't have startIndex property
    const startIndex = textAnchor.textSegments[0].startIndex || 0;
    const endIndex = textAnchor.textSegments[0].endIndex;

    return text.substring(startIndex, endIndex);

  for (const entity of result.entities) {
    console.log(`\nEntity text: ${extractText(entity.textAnchor)}`);
    console.log(`Entity type: ${entity.type}`);
    console.log(`Entity mention text: ${entity.mentionText}`);


Samples are in the samples/ directory. The samples' has instructions for running the samples.

Sample Source Code Try it
Batch_parse_form source code Open in Cloud Shell
Batch_parse_table source code Open in Cloud Shell
Parse_form source code Open in Cloud Shell
Parse_table source code Open in Cloud Shell
Parse_with_model source code Open in Cloud Shell
Quickstart source code Open in Cloud Shell
Set_endpoint source code Open in Cloud Shell

The Document AI 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.

Client libraries targetting some end-of-life versions of Node.js are available, and can be installed via npm dist-tags. The dist-tags follow the naming convention legacy-(version).

Legacy Node.js versions are supported as a best effort:

  • Legacy versions will not be tested in continuous integration.
  • Some security patches may not be able to be backported.
  • Dependencies will not be kept up-to-date, and features will not be backported.

Legacy tags available

  • legacy-8: install client libraries from this dist-tag for versions compatible with Node.js 8.


This library follows Semantic Versioning.

This library is considered to be in beta. This means it is expected to be mostly stable while we work toward a general availability release; however, complete stability is not guaranteed. We will address issues and requests against beta libraries with a high 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 template in this directory.


Apache Version 2.0