Constructor

DocumentsClient

new DocumentsClient(options)

Construct an instance of DocumentsClient.

Parameter

options

Optional

object

The configuration object. See the subsequent parameters for more details.

Values in options have the following properties:

Parameter

credentials

Optional

object

Credentials object.

credentials.client_email

Optional

string

credentials.private_key

Optional

string

email

Optional

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

Optional

string

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port

Optional

number

The port on which to connect to the remote host.

projectId

Optional

string

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

promise

Optional

function()

Custom promise module to use instead of native Promises.

servicePath

Optional

string

The domain name of the API remote host.

Properties

port

static

The port for this API service.

scopes

static

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static

The DNS address for this API service.

Methods

createDocument

createDocument(request, options, callback) returns Promise

Creates a new document.

Operation <response: Document, metadata: KnowledgeOperationMetadata>

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Required. The knoweldge base to create a document for. Format: projects/<Project ID>/knowledgeBases/<Knowledge Base ID>.

document

Object

Required. The document to create.

This object should have the same structure as Document

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is a gax.Operation object.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is a gax.Operation object. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const dialogflow = require('dialogflow');

const client = new dialogflow.v2beta1.DocumentsClient({
  // optional auth parameters.
});

const formattedParent = client.knowledgeBasePath('[PROJECT]', '[KNOWLEDGE_BASE]');
const document = {};
const request = {
  parent: formattedParent,
  document: document,
};

// Handle the operation using the promise pattern.
client.createDocument(request)
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Operation#promise starts polling for the completion of the LRO.
    return operation.promise();
  })
  .then(responses => {
    const result = responses[0];
    const metadata = responses[1];
    const finalApiResponse = responses[2];
  })
  .catch(err => {
    console.error(err);
  });

const formattedParent = client.knowledgeBasePath('[PROJECT]', '[KNOWLEDGE_BASE]');
const document = {};
const request = {
  parent: formattedParent,
  document: document,
};

// Handle the operation using the event emitter pattern.
client.createDocument(request)
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Adding a listener for the "complete" event starts polling for the
    // completion of the operation.
    operation.on('complete', (result, metadata, finalApiResponse) => {
      // doSomethingWith(result);
    });

    // Adding a listener for the "progress" event causes the callback to be
    // called on any change in metadata when the operation is polled.
    operation.on('progress', (metadata, apiResponse) => {
      // doSomethingWith(metadata)
    });

    // Adding a listener for the "error" event handles any errors found during polling.
    operation.on('error', err => {
      // throw(err);
    });
  })
  .catch(err => {
    console.error(err);
  });

const formattedParent = client.knowledgeBasePath('[PROJECT]', '[KNOWLEDGE_BASE]');
const document = {};
const request = {
  parent: formattedParent,
  document: document,
};

// Handle the operation using the await pattern.
const [operation] = await client.createDocument(request);

const [response] = await operation.promise();

deleteDocument

deleteDocument(request, options, callback) returns Promise

Deletes the specified document.

Operation <response: google.protobuf.Empty, metadata: KnowledgeOperationMetadata>

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

The name of the document to delete. Format: projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is a gax.Operation object.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is a gax.Operation object. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const dialogflow = require('dialogflow');

const client = new dialogflow.v2beta1.DocumentsClient({
  // optional auth parameters.
});

const formattedName = client.documentPath('[PROJECT]', '[KNOWLEDGE_BASE]', '[DOCUMENT]');

// Handle the operation using the promise pattern.
client.deleteDocument({name: formattedName})
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Operation#promise starts polling for the completion of the LRO.
    return operation.promise();
  })
  .then(responses => {
    const result = responses[0];
    const metadata = responses[1];
    const finalApiResponse = responses[2];
  })
  .catch(err => {
    console.error(err);
  });

const formattedName = client.documentPath('[PROJECT]', '[KNOWLEDGE_BASE]', '[DOCUMENT]');

// Handle the operation using the event emitter pattern.
client.deleteDocument({name: formattedName})
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Adding a listener for the "complete" event starts polling for the
    // completion of the operation.
    operation.on('complete', (result, metadata, finalApiResponse) => {
      // doSomethingWith(result);
    });

    // Adding a listener for the "progress" event causes the callback to be
    // called on any change in metadata when the operation is polled.
    operation.on('progress', (metadata, apiResponse) => {
      // doSomethingWith(metadata)
    });

    // Adding a listener for the "error" event handles any errors found during polling.
    operation.on('error', err => {
      // throw(err);
    });
  })
  .catch(err => {
    console.error(err);
  });

const formattedName = client.documentPath('[PROJECT]', '[KNOWLEDGE_BASE]', '[DOCUMENT]');

// Handle the operation using the await pattern.
const [operation] = await client.deleteDocument({name: formattedName});

const [response] = await operation.promise();

documentPath

documentPath(project, knowledgeBase, document) returns String

Return a fully-qualified document resource name string.

Parameter

project

String

knowledgeBase

String

document

String

Returns

String 

getDocument

getDocument(request, options, callback) returns Promise

Retrieves the specified document.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Required. The name of the document to retrieve. Format projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Document.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing Document. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const dialogflow = require('dialogflow');

const client = new dialogflow.v2beta1.DocumentsClient({
  // optional auth parameters.
});

const formattedName = client.documentPath('[PROJECT]', '[KNOWLEDGE_BASE]', '[DOCUMENT]');
client.getDocument({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

getProjectId

getProjectId(callback)

Return the project ID used by this class.

Parameter

callback

function(Error, string)

the callback to be called with the current project Id.

knowledgeBasePath

knowledgeBasePath(project, knowledgeBase) returns String

Return a fully-qualified knowledge_base resource name string.

Parameter

project

String

knowledgeBase

String

Returns

String 

listDocuments

listDocuments(request, options, callback) returns Promise

Returns the list of all documents of the knowledge base.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Required. The knowledge base to list all documents for. Format: projects/<Project ID>/knowledgeBases/<Knowledge Base ID>.

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Array, nullable Object, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is Array of Document.

When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListDocumentsResponse.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is Array of Document.

    When autoPaginate: false is specified through options, the array has three elements. The first element is Array of Document in a single response. The second element is the next request object if the response indicates the next page exists, or null. The third element is an object representing ListDocumentsResponse.

    The promise has a method named "cancel" which cancels the ongoing API call.

Example

const dialogflow = require('dialogflow');

const client = new dialogflow.v2beta1.DocumentsClient({
  // optional auth parameters.
});

// Iterate over all elements.
const formattedParent = client.knowledgeBasePath('[PROJECT]', '[KNOWLEDGE_BASE]');

client.listDocuments({parent: formattedParent})
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedParent = client.knowledgeBasePath('[PROJECT]', '[KNOWLEDGE_BASE]');


const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (const resource of resources) {
    // doThingsWith(resource);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listDocuments(nextRequest, options).then(callback);
  }
}
client.listDocuments({parent: formattedParent}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

listDocumentsStream

listDocumentsStream(request, options) returns Stream

Equivalent to listDocuments, but returns a NodeJS Stream object.

This fetches the paged responses for listDocuments continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Required. The knowledge base to list all documents for. Format: projects/<Project ID>/knowledgeBases/<Knowledge Base ID>.

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

See also
https://nodejs.org/api/stream.html
Returns

Stream 

An object stream which emits an object representing Document on 'data' event.

Example

const dialogflow = require('dialogflow');

const client = new dialogflow.v2beta1.DocumentsClient({
  // optional auth parameters.
});

const formattedParent = client.knowledgeBasePath('[PROJECT]', '[KNOWLEDGE_BASE]');
client.listDocumentsStream({parent: formattedParent})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

matchDocumentFromDocumentName

matchDocumentFromDocumentName(documentName) returns String

Parse the documentName from a document resource.

Parameter

documentName

String

A fully-qualified path representing a document resources.

Returns

String 

  • A string representing the document.

matchKnowledgeBaseFromDocumentName

matchKnowledgeBaseFromDocumentName(documentName) returns String

Parse the documentName from a document resource.

Parameter

documentName

String

A fully-qualified path representing a document resources.

Returns

String 

  • A string representing the knowledge_base.

matchKnowledgeBaseFromKnowledgeBaseName

matchKnowledgeBaseFromKnowledgeBaseName(knowledgeBaseName) returns String

Parse the knowledgeBaseName from a knowledge_base resource.

Parameter

knowledgeBaseName

String

A fully-qualified path representing a knowledge_base resources.

Returns

String 

  • A string representing the knowledge_base.

matchProjectFromDocumentName

matchProjectFromDocumentName(documentName) returns String

Parse the documentName from a document resource.

Parameter

documentName

String

A fully-qualified path representing a document resources.

Returns

String 

  • A string representing the project.

matchProjectFromKnowledgeBaseName

matchProjectFromKnowledgeBaseName(knowledgeBaseName) returns String

Parse the knowledgeBaseName from a knowledge_base resource.

Parameter

knowledgeBaseName

String

A fully-qualified path representing a knowledge_base resources.

Returns

String 

  • A string representing the project.