Constructor

IntentsClient

new IntentsClient(options)

Construct an instance of IntentsClient.

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

batchDeleteIntents

batchDeleteIntents(request, options, callback) returns Promise

Deletes intents in 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 name of the agent to delete all entities types for. Format: projects/<Project ID>/agent.

intents

Array of Object

Required. The collection of intents to delete. Only intent name must be filled in.

This object should have the same structure as Intent

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

const formattedParent = client.projectAgentPath('[PROJECT]');
const intents = [];
const request = {
  parent: formattedParent,
  intents: intents,
};

// Handle the operation using the promise pattern.
client.batchDeleteIntents(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.projectAgentPath('[PROJECT]');
const intents = [];
const request = {
  parent: formattedParent,
  intents: intents,
};

// Handle the operation using the event emitter pattern.
client.batchDeleteIntents(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.projectAgentPath('[PROJECT]');
const intents = [];
const request = {
  parent: formattedParent,
  intents: intents,
};

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

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

batchUpdateIntents

batchUpdateIntents(request, options, callback) returns Promise

Updates/Creates multiple intents in the specified agent.

Operation <response: BatchUpdateIntentsResponse>

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Required. The name of the agent to update or create intents in. Format: projects/<Project ID>/agent.

languageCode

string

Optional. The language of training phrases, parameters and rich messages defined in intents. If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

intentBatchUri

Optional

string

The URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with "gs://".

intentBatchInline

Optional

Object

The collection of intents to update or create.

This object should have the same structure as IntentBatch

updateMask

Optional

Object

Optional. The mask to control which fields get updated.

This object should have the same structure as FieldMask

intentView

Optional

number

Optional. The resource view to apply to the returned intent.

The number should be among the values of IntentView

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

const formattedParent = client.projectAgentPath('[PROJECT]');
const languageCode = '';
const request = {
  parent: formattedParent,
  languageCode: languageCode,
};

// Handle the operation using the promise pattern.
client.batchUpdateIntents(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.projectAgentPath('[PROJECT]');
const languageCode = '';
const request = {
  parent: formattedParent,
  languageCode: languageCode,
};

// Handle the operation using the event emitter pattern.
client.batchUpdateIntents(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.projectAgentPath('[PROJECT]');
const languageCode = '';
const request = {
  parent: formattedParent,
  languageCode: languageCode,
};

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

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

createIntent

createIntent(request, options, callback) returns Promise

Creates an intent in 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 create a intent for. Format: projects/<Project ID>/agent.

intent

Object

Required. The intent to create.

This object should have the same structure as Intent

languageCode

Optional

string

Optional. The language of training phrases, parameters and rich messages defined in intent. If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

intentView

Optional

number

Optional. The resource view to apply to the returned intent.

The number should be among the values of IntentView

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

Returns

Promise 

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

Example

const dialogflow = require('dialogflow');

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

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

deleteIntent

deleteIntent(request, options, callback) returns Promise

Deletes the specified intent and its direct or indirect followup intents.

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 intent to delete. If this intent has direct or indirect followup intents, we also delete them.

Format: projects/<Project ID>/agent/intents/<Intent 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)

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

const formattedName = client.intentPath('[PROJECT]', '[INTENT]');
client.deleteIntent({name: formattedName}).catch(err => {
  console.error(err);
});

getIntent

getIntent(request, options, callback) returns Promise

Retrieves the specified intent.

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 intent. Format: projects/<Project ID>/agent/intents/<Intent ID>.

languageCode

Optional

string

Optional. The language to retrieve training phrases, parameters and rich messages for. If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

intentView

Optional

number

Optional. The resource view to apply to the returned intent.

The number should be among the values of IntentView

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

Returns

Promise 

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

Example

const dialogflow = require('dialogflow');

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

const formattedName = client.intentPath('[PROJECT]', '[INTENT]');
client.getIntent({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.

intentPath

intentPath(project, intent) returns String

Return a fully-qualified intent resource name string.

Parameter

project

String

intent

String

Returns

String 

listIntents

listIntents(request, options, callback) returns Promise

Returns the list of all intents in 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 all intents from. Format: projects/<Project ID>/agent.

languageCode

Optional

string

Optional. The language to list training phrases, parameters and rich messages for. If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

intentView

Optional

number

Optional. The resource view to apply to the returned intent.

The number should be among the values of IntentView

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

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

Returns

Promise 

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

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

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

Example

const dialogflow = require('dialogflow');

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

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

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

listIntentsStream

listIntentsStream(request, options) returns Stream

Equivalent to listIntents, but returns a NodeJS Stream object.

This fetches the paged responses for listIntents 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 all intents from. Format: projects/<Project ID>/agent.

languageCode

Optional

string

Optional. The language to list training phrases, parameters and rich messages for. If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

intentView

Optional

number

Optional. The resource view to apply to the returned intent.

The number should be among the values of IntentView

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

Example

const dialogflow = require('dialogflow');

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

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

matchIntentFromIntentName

matchIntentFromIntentName(intentName) returns String

Parse the intentName from a intent resource.

Parameter

intentName

String

A fully-qualified path representing a intent resources.

Returns

String 

  • A string representing the intent.

matchProjectFromIntentName

matchProjectFromIntentName(intentName) returns String

Parse the intentName from a intent resource.

Parameter

intentName

String

A fully-qualified path representing a intent resources.

Returns

String 

  • A string representing the project.

matchProjectFromProjectAgentName

matchProjectFromProjectAgentName(projectAgentName) returns String

Parse the projectAgentName from a project_agent resource.

Parameter

projectAgentName

String

A fully-qualified path representing a project_agent resources.

Returns

String 

  • A string representing the project.

projectAgentPath

projectAgentPath(project) returns String

Return a fully-qualified project_agent resource name string.

Parameter

project

String

Returns

String 

updateIntent

updateIntent(request, options, callback) returns Promise

Updates the specified intent.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

intent

Object

Required. The intent to update.

This object should have the same structure as Intent

languageCode

string

Optional. The language of training phrases, parameters and rich messages defined in intent. If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

updateMask

Optional

Object

Optional. The mask to control which fields get updated.

This object should have the same structure as FieldMask

intentView

Optional

number

Optional. The resource view to apply to the returned intent.

The number should be among the values of IntentView

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

Returns

Promise 

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

Example

const dialogflow = require('dialogflow');

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

const intent = {};
const languageCode = '';
const request = {
  intent: intent,
  languageCode: languageCode,
};
client.updateIntent(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });