KnowledgeBasesClient

KnowledgeBasesClient

Manages knowledge bases.

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

Constructor

new KnowledgeBasesClient(optionsopt)

Construct an instance of KnowledgeBasesClient.

Parameters:
Name Type Attributes Description
options object <optional>

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

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

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 number <optional>

The port on which to connect to the remote host.
projectId string <optional>

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 function <optional>

Custom promise module to use instead of native Promises.
apiEndpoint string <optional>

The domain name of the API remote host.
Source:

Members

(static) apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Source:

(static) port

The port for this API service.

Source:

(static) scopes

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

Source:

(static) servicePath

The DNS address for this API service.

Source:

Methods

createKnowledgeBase(request, optionsopt, callbackopt) → {Promise}

Creates a knowledge base.

Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

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

Required. The knowledge base to create.

This object should have the same structure as KnowledgeBase
options Object <optional>

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

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

The second parameter to the callback is an object representing KnowledgeBase.
Source:
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(request, optionsopt, callbackopt) → {Promise}

Deletes the specified knowledge base.

Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

Required. The name of the knowledge base to delete. Format: projects/<Project ID>/knowledgeBases/<Knowledge Base ID>.
force boolean <optional>

Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.
options Object <optional>

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

The function which will be called with the result of the API call.
Source:
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(request, optionsopt, callbackopt) → {Promise}

Retrieves the specified knowledge base.

Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the knowledge base to retrieve. Format projects/<Project ID>/knowledgeBases/<Knowledge Base ID>.
options Object <optional>

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

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

The second parameter to the callback is an object representing KnowledgeBase.
Source:
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(callback)

Return the project ID used by this class.

Parameters:
Name Type Description
callback function

the callback to be called with the current project Id.
Source:

knowledgeBasePath(project, knowledgeBase) → {String}

Return a fully-qualified knowledge_base resource name string.

Parameters:
Name Type Description
project String
knowledgeBase String
Source:

listKnowledgeBases(request, optionsopt, callbackopt) → {Promise}

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

Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The project to list of knowledge bases for. Format: projects/<Project ID>.
pageSize number <optional>

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 Object <optional>

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

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.
Source:
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(request, optionsopt) → {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.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The project to list of knowledge bases for. Format: projects/<Project ID>.
pageSize number <optional>

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 Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
Source:
See:
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(knowledgeBaseName) → {String}

Parse the knowledgeBaseName from a knowledge_base resource.

Parameters:
Name Type Description
knowledgeBaseName String

A fully-qualified path representing a knowledge_base resources.
Source:

matchProjectFromKnowledgeBaseName(knowledgeBaseName) → {String}

Parse the knowledgeBaseName from a knowledge_base resource.

Parameters:
Name Type Description
knowledgeBaseName String

A fully-qualified path representing a knowledge_base resources.
Source:

matchProjectFromProjectName(projectName) → {String}

Parse the projectName from a project resource.

Parameters:
Name Type Description
projectName String

A fully-qualified path representing a project resources.
Source:

projectPath(project) → {String}

Return a fully-qualified project resource name string.

Parameters:
Name Type Description
project String
Source:

updateKnowledgeBase(request, optionsopt, callbackopt) → {Promise}

Updates the specified knowledge base.

Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
knowledgeBase Object

Required. The knowledge base to update.

This object should have the same structure as KnowledgeBase
updateMask Object <optional>

Optional. Not specified means update all. Currently, only display_name can be updated, an InvalidArgument will be returned for attempting to update other fields.

This object should have the same structure as FieldMask
options Object <optional>

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

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

The second parameter to the callback is an object representing KnowledgeBase.
Source:
Example
const dialogflow = require('dialogflow');

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

const knowledgeBase = {};
client.updateKnowledgeBase({knowledgeBase: knowledgeBase})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });