Dialogflow API: Node.js Client

Dialogflow API client for Node.js

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

• Dialogflow API Node.js Client API Reference
• Dialogflow API Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-dialogflow

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
  • Installing the client library

• Samples

• Versioning
• Contributing
• License

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 

Samples

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

Sample	Source Code	Try it
Agents.delete_agent	source code
Agents.export_agent	source code
Agents.get_agent	source code
Agents.get_validation_result	source code
Agents.import_agent	source code
Agents.restore_agent	source code
Agents.search_agents	source code
Agents.set_agent	source code
Agents.train_agent	source code
Answer_records.list_answer_records	source code
Answer_records.update_answer_record	source code
Contexts.create_context	source code
Contexts.delete_all_contexts	source code
Contexts.delete_context	source code
Contexts.get_context	source code
Contexts.list_contexts	source code
Contexts.update_context	source code
Conversation_datasets.create_conversation_dataset	source code
Conversation_datasets.delete_conversation_dataset	source code
Conversation_datasets.get_conversation_dataset	source code
Conversation_datasets.import_conversation_data	source code
Conversation_datasets.list_conversation_datasets	source code
Conversation_models.create_conversation_model	source code
Conversation_models.create_conversation_model_evaluation	source code
Conversation_models.delete_conversation_model	source code
Conversation_models.deploy_conversation_model	source code
Conversation_models.get_conversation_model	source code
Conversation_models.get_conversation_model_evaluation	source code
Conversation_models.list_conversation_model_evaluations	source code
Conversation_models.list_conversation_models	source code
Conversation_models.undeploy_conversation_model	source code
Conversation_profiles.clear_suggestion_feature_config	source code
Conversation_profiles.create_conversation_profile	source code
Conversation_profiles.delete_conversation_profile	source code
Conversation_profiles.get_conversation_profile	source code
Conversation_profiles.list_conversation_profiles	source code
Conversation_profiles.set_suggestion_feature_config	source code
Conversation_profiles.update_conversation_profile	source code
Conversations.complete_conversation	source code
Conversations.create_conversation	source code
Conversations.generate_stateless_suggestion	source code
Conversations.generate_stateless_summary	source code
Conversations.generate_suggestions	source code
Conversations.get_conversation	source code
Conversations.ingest_context_references	source code
Conversations.list_conversations	source code
Conversations.list_messages	source code
Conversations.search_knowledge	source code
Conversations.suggest_conversation_summary	source code
Documents.create_document	source code
Documents.delete_document	source code
Documents.export_document	source code
Documents.get_document	source code
Documents.import_documents	source code
Documents.list_documents	source code
Documents.reload_document	source code
Documents.update_document	source code
Encryption_spec_service.get_encryption_spec	source code
Encryption_spec_service.initialize_encryption_spec	source code
Entity_types.batch_create_entities	source code
Entity_types.batch_delete_entities	source code
Entity_types.batch_delete_entity_types	source code
Entity_types.batch_update_entities	source code
Entity_types.batch_update_entity_types	source code
Entity_types.create_entity_type	source code
Entity_types.delete_entity_type	source code
Entity_types.get_entity_type	source code
Entity_types.list_entity_types	source code
Entity_types.update_entity_type	source code
Environments.create_environment	source code
Environments.delete_environment	source code
Environments.get_environment	source code
Environments.get_environment_history	source code
Environments.list_environments	source code
Environments.update_environment	source code
Fulfillments.get_fulfillment	source code
Fulfillments.update_fulfillment	source code
Generators.create_generator	source code
Generators.delete_generator	source code
Generators.get_generator	source code
Generators.list_generators	source code
Generators.update_generator	source code
Intents.batch_delete_intents	source code
Intents.batch_update_intents	source code
Intents.create_intent	source code
Intents.delete_intent	source code
Intents.get_intent	source code
Intents.list_intents	source code
Intents.update_intent	source code
Knowledge_bases.create_knowledge_base	source code
Knowledge_bases.delete_knowledge_base	source code
Knowledge_bases.get_knowledge_base	source code
Knowledge_bases.list_knowledge_bases	source code
Knowledge_bases.update_knowledge_base	source code
Participants.analyze_content	source code
Participants.create_participant	source code
Participants.get_participant	source code
Participants.list_participants	source code
Participants.streaming_analyze_content	source code
Participants.suggest_articles	source code
Participants.suggest_faq_answers	source code
Participants.suggest_knowledge_assist	source code
Participants.suggest_smart_replies	source code
Participants.update_participant	source code
Session_entity_types.create_session_entity_type	source code
Session_entity_types.delete_session_entity_type	source code
Session_entity_types.get_session_entity_type	source code
Session_entity_types.list_session_entity_types	source code
Session_entity_types.update_session_entity_type	source code
Sessions.detect_intent	source code
Sessions.streaming_detect_intent	source code
Versions.create_version	source code
Versions.delete_version	source code
Versions.get_version	source code
Versions.list_versions	source code
Versions.update_version	source code
Agents.delete_agent	source code
Agents.export_agent	source code
Agents.get_agent	source code
Agents.get_validation_result	source code
Agents.import_agent	source code
Agents.restore_agent	source code
Agents.search_agents	source code
Agents.set_agent	source code
Agents.train_agent	source code
Answer_records.get_answer_record	source code
Answer_records.list_answer_records	source code
Answer_records.update_answer_record	source code
Contexts.create_context	source code
Contexts.delete_all_contexts	source code
Contexts.delete_context	source code
Contexts.get_context	source code
Contexts.list_contexts	source code
Contexts.update_context	source code
Conversation_profiles.clear_suggestion_feature_config	source code
Conversation_profiles.create_conversation_profile	source code
Conversation_profiles.delete_conversation_profile	source code
Conversation_profiles.get_conversation_profile	source code
Conversation_profiles.list_conversation_profiles	source code
Conversation_profiles.set_suggestion_feature_config	source code
Conversation_profiles.update_conversation_profile	source code
Conversations.batch_create_messages	source code
Conversations.complete_conversation	source code
Conversations.create_conversation	source code
Conversations.generate_stateless_suggestion	source code
Conversations.generate_stateless_summary	source code
Conversations.generate_suggestions	source code
Conversations.get_conversation	source code
Conversations.ingest_context_references	source code
Conversations.list_conversations	source code
Conversations.list_messages	source code
Conversations.search_knowledge	source code
Conversations.suggest_conversation_summary	source code
Documents.create_document	source code
Documents.delete_document	source code
Documents.get_document	source code
Documents.import_documents	source code
Documents.list_documents	source code
Documents.reload_document	source code
Documents.update_document	source code
Encryption_spec_service.get_encryption_spec	source code
Encryption_spec_service.initialize_encryption_spec	source code
Entity_types.batch_create_entities	source code
Entity_types.batch_delete_entities	source code
Entity_types.batch_delete_entity_types	source code
Entity_types.batch_update_entities	source code
Entity_types.batch_update_entity_types	source code
Entity_types.create_entity_type	source code
Entity_types.delete_entity_type	source code
Entity_types.get_entity_type	source code
Entity_types.list_entity_types	source code
Entity_types.update_entity_type	source code
Environments.create_environment	source code
Environments.delete_environment	source code
Environments.get_environment	source code
Environments.get_environment_history	source code
Environments.list_environments	source code
Environments.update_environment	source code
Fulfillments.get_fulfillment	source code
Fulfillments.update_fulfillment	source code
Generators.create_generator	source code
Generators.delete_generator	source code
Generators.get_generator	source code
Generators.list_generators	source code
Generators.update_generator	source code
Intents.batch_delete_intents	source code
Intents.batch_update_intents	source code
Intents.create_intent	source code
Intents.delete_intent	source code
Intents.get_intent	source code
Intents.list_intents	source code
Intents.update_intent	source code
Knowledge_bases.create_knowledge_base	source code
Knowledge_bases.delete_knowledge_base	source code
Knowledge_bases.get_knowledge_base	source code
Knowledge_bases.list_knowledge_bases	source code
Knowledge_bases.update_knowledge_base	source code
Participants.analyze_content	source code
Participants.compile_suggestion	source code
Participants.create_participant	source code
Participants.get_participant	source code
Participants.list_participants	source code
Participants.list_suggestions	source code
Participants.streaming_analyze_content	source code
Participants.suggest_articles	source code
Participants.suggest_faq_answers	source code
Participants.suggest_knowledge_assist	source code
Participants.suggest_smart_replies	source code
Participants.update_participant	source code
Phone_numbers.delete_phone_number	source code
Phone_numbers.list_phone_numbers	source code
Phone_numbers.undelete_phone_number	source code
Phone_numbers.update_phone_number	source code
Session_entity_types.create_session_entity_type	source code
Session_entity_types.delete_session_entity_type	source code
Session_entity_types.get_session_entity_type	source code
Session_entity_types.list_session_entity_types	source code
Session_entity_types.update_session_entity_type	source code
Sessions.detect_intent	source code
Sessions.streaming_detect_intent	source code
Sip_trunks.create_sip_trunk	source code
Sip_trunks.delete_sip_trunk	source code
Sip_trunks.get_sip_trunk	source code
Sip_trunks.list_sip_trunks	source code
Sip_trunks.update_sip_trunk	source code
Versions.create_version	source code
Versions.delete_version	source code
Versions.get_version	source code
Versions.list_versions	source code
Versions.update_version	source code
Quickstart	source code

The Dialogflow API Node.js Client API Reference documentation also contains samples.

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@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning .

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 stablelibraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide .

Please note that this README.md , the samples/README.md , and a variety of configuration files in this repository (including .nycrc and tsconfig.json ) are generated from a central template. To edit one of these files, make an edit to its templates in directory .

License

Apache Version 2.0

See LICENSE