Dialogflow API: Nodejs Client

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority

npm version

Dialogflow API client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Dialogflow API API.
  4. Set up authentication so you can access the API from your local workstation. ### Installing the client library
npm install @google-cloud/dialogflow-cx

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample Source Code
create agent source code
delete agent source code
export agent source code
get agent source code
get agent validation result source code
get generative settings source code
list agents source code
restore agent source code
update agent source code
update generative settings source code
validate agent source code
get changelog source code
list changelogs source code
get deployment source code
list deployments source code
create entity type source code
delete entity type source code
export entity types source code
get entity type source code
import entity types source code
list entity types source code
update entity type source code
create environment source code
delete environment source code
deploy flow source code
get environment source code
list continuous test results source code
list environments source code
lookup environment history source code
run continuous test source code
update environment source code
create experiment source code
delete experiment source code
get experiment source code
list experiments source code
start experiment source code
stop experiment source code
update experiment source code
create flow source code
delete flow source code
export flow source code
get flow source code
get flow validation result source code
import flow source code
list flows source code
train flow source code
update flow source code
validate flow source code
create generator source code
delete generator source code
get generator source code
list generators source code
update generator source code
create intent source code
delete intent source code
export intents source code
get intent source code
import intents source code
list intents source code
update intent source code
create page source code
delete page source code
get page source code
list pages source code
update page source code
create security settings source code
delete security settings source code
get security settings source code
list security settings source code
update security settings source code
create session entity type source code
delete session entity type source code
get session entity type source code
list session entity types source code
update session entity type source code
detect intent source code
fulfill intent source code
match intent source code
server streaming detect intent source code
streaming detect intent source code
submit answer feedback source code
cloud source code
batch delete test cases source code
batch run test cases source code
calculate coverage source code
create test case source code
export test cases source code
get test case source code
get test case result source code
import test cases source code
list test case results source code
list test cases source code
run test case source code
update test case source code
create transition route group source code
delete transition route group source code
get transition route group source code
list transition route groups source code
update transition route group source code
compare versions source code
create version source code
delete version source code
get version source code
list versions source code
load version source code
update version source code
create webhook source code
delete webhook source code
get webhook source code
list webhooks source code
update webhook source code
create agent source code
delete agent source code
export agent source code
get agent source code
get agent validation result source code
get generative settings source code
list agents source code
restore agent source code
update agent source code
update generative settings source code
validate agent source code
get changelog source code
list changelogs source code
delete conversation source code
get conversation source code
list conversations source code
get deployment source code
list deployments source code
create entity type source code
delete entity type source code
export entity types source code
get entity type source code
import entity types source code
list entity types source code
update entity type source code
create environment source code
delete environment source code
deploy flow source code
get environment source code
list continuous test results source code
list environments source code
lookup environment history source code
run continuous test source code
update environment source code
create example source code
delete example source code
get example source code
list examples source code
update example source code
create experiment source code
delete experiment source code
get experiment source code
list experiments source code
start experiment source code
stop experiment source code
update experiment source code
create flow source code
delete flow source code
export flow source code
get flow source code
get flow validation result source code
import flow source code
list flows source code
train flow source code
update flow source code
validate flow source code
create generator source code
delete generator source code
get generator source code
list generators source code
update generator source code
create intent source code
delete intent source code
export intents source code
get intent source code
import intents source code
list intents source code
update intent source code
create page source code
delete page source code
get page source code
list pages source code
update page source code
create playbook source code
create playbook version source code
delete playbook source code
delete playbook version source code
export playbook source code
get playbook source code
get playbook version source code
import playbook source code
list playbook versions source code
list playbooks source code
restore playbook version source code
update playbook source code
create security settings source code
delete security settings source code
get security settings source code
list security settings source code
update security settings source code
create session entity type source code
delete session entity type source code
get session entity type source code
list session entity types source code
update session entity type source code
detect intent source code
fulfill intent source code
match intent source code
server streaming detect intent source code
streaming detect intent source code
submit answer feedback source code
cloud source code
batch delete test cases source code
batch run test cases source code
calculate coverage source code
create test case source code
export test cases source code
get test case source code
get test case result source code
import test cases source code
list test case results source code
list test cases source code
run test case source code
update test case source code
create tool source code
create tool version source code
delete tool source code
delete tool version source code
export tools source code
get tool source code
get tool version source code
list tool versions source code
list tools source code
restore tool version source code
update tool source code
create transition route group source code
delete transition route group source code
get transition route group source code
list transition route groups source code
update transition route group source code
compare versions source code
create version source code
delete version source code
get version source code
list versions source code
load version source code
update version source code
create webhook source code
delete webhook source code
get webhook source code
list webhooks source code
update webhook source code

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/dialogflow-cx@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template.

License

Apache Version 2.0

See LICENSE