Discovery Engine API: Node.js Client

release level npm version

Discovery Engine 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:


Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Discovery Engine API 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/discoveryengine

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 branch resource name, such as
 *  `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}`.
 *  Use `default_branch` as the branch ID, to list documents under the default
 *  branch.
 *  If the caller does not have permission to list Documents  s under this
 *  branch, regardless of whether or not this branch exists, a
 *  PERMISSION_DENIED error is returned.
// const parent = 'abc123'
 *  Maximum number of Document s
 *  to return. If unspecified, defaults to 100. The maximum allowed value is
 *  1000. Values above 1000 will be coerced to 1000.
 *  If this field is negative, an INVALID_ARGUMENT error is returned.
// const pageSize = 1234
 *  A page token
 *  ListDocumentsResponse.next_page_token,
 *  received from a previous
 *  DocumentService.ListDocuments
 *  call. Provide this to retrieve the subsequent page.
 *  When paginating, all other parameters provided to
 *  DocumentService.ListDocuments
 *  must match the call that provided the page token. Otherwise, an
 *  INVALID_ARGUMENT error is returned.
// const pageToken = 'abc123'

// Imports the Discoveryengine library
const {DocumentServiceClient} =

// Instantiates a client
const discoveryengineClient = new DocumentServiceClient();

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

  // Run request
  const iterable = await discoveryengineClient.listDocumentsAsync(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_service.create_documentsource codeOpen in Cloud Shell
Document_service.delete_documentsource codeOpen in Cloud Shell
Document_service.get_documentsource codeOpen in Cloud Shell
Document_service.import_documentssource codeOpen in Cloud Shell
Document_service.list_documentssource codeOpen in Cloud Shell
Document_service.update_documentsource codeOpen in Cloud Shell
Recommendation_service.recommendsource codeOpen in Cloud Shell
User_event_service.collect_user_eventsource codeOpen in Cloud Shell
User_event_service.import_user_eventssource codeOpen in Cloud Shell
User_event_service.write_user_eventsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

The Discovery Engine API 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/discoveryengine@legacy-8 installs client libraries 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 templates in directory.


Apache Version 2.0