v2beta1.KnowledgeBasesClient

class   static

Manages knowledge bases.

Allows users to setup and maintain knowledge bases with their knowledge data.

Constructor

KnowledgeBasesClient

new KnowledgeBasesClient(options)

Construct an instance of KnowledgeBasesClient.

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

createKnowledgeBase

createKnowledgeBase(request, options, callback) returns Promise

Creates a knowledge base.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Required. The agent to create a knowledge base for. Format: projects/<Project ID>/agent.

knowledgeBase

Object

Required. The knowledge base to create.

This object should have the same structure as KnowledgeBase

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 KnowledgeBase.
Returns

Promise 

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

Example 

const dialogflow = require('dialogflow');

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

const formattedParent = client.projectPath('[PROJECT]');
const knowledgeBase = {};
const request = {
  parent: formattedParent,
  knowledgeBase: knowledgeBase,
};
client.createKnowledgeBase(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

deleteKnowledgeBase

deleteKnowledgeBase(request, options, callback) returns Promise

Deletes the specified knowledge base.

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 knowledge base to delete. Format: projects/<Project ID>/knowledgeBases/<Knowledge Base ID>.

force

Optional

boolean

Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.

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)

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

Promise 

  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Example 

const dialogflow = require('dialogflow');

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

const formattedName = client.knowledgeBasePath('[PROJECT]', '[KNOWLEDGE_BASE]');
client.deleteKnowledgeBase({name: formattedName}).catch(err => {
  console.error(err);
});

getKnowledgeBase

getKnowledgeBase(request, options, callback) returns Promise

Retrieves the specified knowledge base.

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 knowledge base to retrieve. Format projects/<Project ID>/knowledgeBases/<Knowledge Base 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 KnowledgeBase.
Returns

Promise 

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

Example 

const dialogflow = require('dialogflow');

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

const formattedName = client.knowledgeBasePath('[PROJECT]', '[KNOWLEDGE_BASE]');
client.getKnowledgeBase({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 

listKnowledgeBases

listKnowledgeBases(request, options, callback) returns Promise

Returns the list of all knowledge bases of the specified agent.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Required. The agent to list of knowledge bases for. Format: projects/<Project ID>/agent.

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 KnowledgeBase.

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 ListKnowledgeBasesResponse.
Returns

Promise 

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

    When autoPaginate: false is specified through options, the array has three elements. The first element is Array of KnowledgeBase 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 ListKnowledgeBasesResponse.

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

Example 

const dialogflow = require('dialogflow');

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

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

client.listKnowledgeBases({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.projectPath('[PROJECT]');


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.listKnowledgeBases(nextRequest, options).then(callback);
  }
}
client.listKnowledgeBases({parent: formattedParent}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

listKnowledgeBasesStream

listKnowledgeBasesStream(request, options) returns Stream

Equivalent to listKnowledgeBases, but returns a NodeJS Stream object.

This fetches the paged responses for listKnowledgeBases 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 agent to list of knowledge bases for. Format: projects/<Project ID>/agent.

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 KnowledgeBase on 'data' event.

Example 

const dialogflow = require('dialogflow');

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

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

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.

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.

matchProjectFromProjectName

matchProjectFromProjectName(projectName) returns String

Parse the projectName from a project resource.

Parameter

projectName

String

A fully-qualified path representing a project resources.
Returns

String 

  • A string representing the project.

projectPath

projectPath(project) returns String

Return a fully-qualified project resource name string.

Parameter

project

String
Returns

String