Constructor

AgentsClient

new AgentsClient(options)

Construct an instance of AgentsClient.

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

exportAgent

exportAgent(request, options, callback) returns Promise

Exports the specified agent to a ZIP file.

Operation <response: ExportAgentResponse>

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Required. The project that the agent to export is associated with. Format: projects/<Project ID>.

agentUri

Optional

string

Optional. The Google Cloud Storage URI to export the agent to. The format of this URI must be gs://<bucket-name>/<object-name>. If left unspecified, the serialized agent is returned inline.

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.AgentsClient({
  // optional auth parameters.
});

const formattedParent = client.projectPath('[PROJECT]');

// Handle the operation using the promise pattern.
client.exportAgent({parent: formattedParent})
  .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.projectPath('[PROJECT]');

// Handle the operation using the event emitter pattern.
client.exportAgent({parent: formattedParent})
  .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.projectPath('[PROJECT]');

// Handle the operation using the await pattern.
const [operation] = await client.exportAgent({parent: formattedParent});

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

getAgent

getAgent(request, options, callback) returns Promise

Retrieves 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 project that the agent to fetch is associated with. Format: projects/<Project 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 Agent.

Returns

Promise 

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

Example

const dialogflow = require('dialogflow');

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

const formattedParent = client.projectPath('[PROJECT]');
client.getAgent({parent: formattedParent})
  .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.

importAgent

importAgent(request, options, callback) returns Promise

Imports the specified agent from a ZIP file.

Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest.

Operation <response: google.protobuf.Empty>

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Required. The project that the agent to import is associated with. Format: projects/<Project ID>.

agentUri

Optional

string

The URI to a Google Cloud Storage file containing the agent to import. Note: The URI must start with "gs://".

agentContent

Optional

string

The agent to import.

Example for how to import an agent via the command line:

curl \
    'https://dialogflow.googleapis.com/v2beta1/projects/<project_name>/agent:import\
     -X POST \
     -H 'Authorization: Bearer '$(gcloud auth application-default
     print-access-token) \
     -H 'Accept: application/json' \
     -H 'Content-Type: application/json' \
     --compressed \
     --data-binary "{
        'agentContent': '$(cat <agent zip file> | base64 -w 0)'
     }"

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.AgentsClient({
  // optional auth parameters.
});

const formattedParent = client.projectPath('[PROJECT]');

// Handle the operation using the promise pattern.
client.importAgent({parent: formattedParent})
  .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.projectPath('[PROJECT]');

// Handle the operation using the event emitter pattern.
client.importAgent({parent: formattedParent})
  .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.projectPath('[PROJECT]');

// Handle the operation using the await pattern.
const [operation] = await client.importAgent({parent: formattedParent});

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

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 

restoreAgent

restoreAgent(request, options, callback) returns Promise

Restores the specified agent from a ZIP file.

Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted.

Operation <response: google.protobuf.Empty>

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Required. The project that the agent to restore is associated with. Format: projects/<Project ID>.

agentUri

Optional

string

The URI to a Google Cloud Storage file containing the agent to restore. Note: The URI must start with "gs://".

agentContent

Optional

string

The agent to restore.

Example for how to restore an agent via the command line:

curl \
    'https://dialogflow.googleapis.com/v2beta1/projects/<project_name>/agent:restore\
     -X POST \
     -H 'Authorization: Bearer '$(gcloud auth application-default
     print-access-token) \
     -H 'Accept: application/json' \
     -H 'Content-Type: application/json' \
     --compressed \
     --data-binary "{
         'agentContent': '$(cat <agent zip file> | base64 -w 0)'
     }"

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.AgentsClient({
  // optional auth parameters.
});

const formattedParent = client.projectPath('[PROJECT]');

// Handle the operation using the promise pattern.
client.restoreAgent({parent: formattedParent})
  .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.projectPath('[PROJECT]');

// Handle the operation using the event emitter pattern.
client.restoreAgent({parent: formattedParent})
  .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.projectPath('[PROJECT]');

// Handle the operation using the await pattern.
const [operation] = await client.restoreAgent({parent: formattedParent});

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

searchAgents

searchAgents(request, options, callback) returns Promise

Returns the list of agents.

Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to List Sub-Collections.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Required. The project to list agents from. Format: projects/<Project ID or '-'>.

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

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

Returns

Promise 

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

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

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

Example

const dialogflow = require('dialogflow');

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

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

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

searchAgentsStream

searchAgentsStream(request, options) returns Stream

Equivalent to searchAgents, but returns a NodeJS Stream object.

This fetches the paged responses for searchAgents 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 project to list agents from. Format: projects/<Project ID or '-'>.

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

Example

const dialogflow = require('dialogflow');

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

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

trainAgent

trainAgent(request, options, callback) returns Promise

Trains the specified agent.

Operation <response: google.protobuf.Empty>

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Required. The project that the agent to train is associated with. Format: projects/<Project 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.AgentsClient({
  // optional auth parameters.
});

const formattedParent = client.projectPath('[PROJECT]');

// Handle the operation using the promise pattern.
client.trainAgent({parent: formattedParent})
  .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.projectPath('[PROJECT]');

// Handle the operation using the event emitter pattern.
client.trainAgent({parent: formattedParent})
  .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.projectPath('[PROJECT]');

// Handle the operation using the await pattern.
const [operation] = await client.trainAgent({parent: formattedParent});

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