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][client-docs]
• [Dialogflow API Documentation][product-docs]
• 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][projects].
2. [Enable billing for your project][billing].
3. [Enable the Dialogflow API API][enable_api].
4. [Set up authentication][auth] 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 | ![Open in Cloud Shell][shell_img] | | Agents.export_agent | source code | ![Open in Cloud Shell][shell_img] | | Agents.get_agent | source code | ![Open in Cloud Shell][shell_img] | | Agents.get_validation_result | source code | ![Open in Cloud Shell][shell_img] | | Agents.import_agent | source code | ![Open in Cloud Shell][shell_img] | | Agents.restore_agent | source code | ![Open in Cloud Shell][shell_img] | | Agents.search_agents | source code | ![Open in Cloud Shell][shell_img] | | Agents.set_agent | source code | ![Open in Cloud Shell][shell_img] | | Agents.train_agent | source code | ![Open in Cloud Shell][shell_img] | | Answer_records.list_answer_records | source code | ![Open in Cloud Shell][shell_img] | | Answer_records.update_answer_record | source code | ![Open in Cloud Shell][shell_img] | | Contexts.create_context | source code | ![Open in Cloud Shell][shell_img] | | Contexts.delete_all_contexts | source code | ![Open in Cloud Shell][shell_img] | | Contexts.delete_context | source code | ![Open in Cloud Shell][shell_img] | | Contexts.get_context | source code | ![Open in Cloud Shell][shell_img] | | Contexts.list_contexts | source code | ![Open in Cloud Shell][shell_img] | | Contexts.update_context | source code | ![Open in Cloud Shell][shell_img] | | Conversation_datasets.create_conversation_dataset | source code | ![Open in Cloud Shell][shell_img] | | Conversation_datasets.delete_conversation_dataset | source code | ![Open in Cloud Shell][shell_img] | | Conversation_datasets.get_conversation_dataset | source code | ![Open in Cloud Shell][shell_img] | | Conversation_datasets.import_conversation_data | source code | ![Open in Cloud Shell][shell_img] | | Conversation_datasets.list_conversation_datasets | source code | ![Open in Cloud Shell][shell_img] | | Conversation_models.create_conversation_model | source code | ![Open in Cloud Shell][shell_img] | | Conversation_models.create_conversation_model_evaluation | source code | ![Open in Cloud Shell][shell_img] | | Conversation_models.delete_conversation_model | source code | ![Open in Cloud Shell][shell_img] | | Conversation_models.deploy_conversation_model | source code | ![Open in Cloud Shell][shell_img] | | Conversation_models.get_conversation_model | source code | ![Open in Cloud Shell][shell_img] | | Conversation_models.get_conversation_model_evaluation | source code | ![Open in Cloud Shell][shell_img] | | Conversation_models.list_conversation_model_evaluations | source code | ![Open in Cloud Shell][shell_img] | | Conversation_models.list_conversation_models | source code | ![Open in Cloud Shell][shell_img] | | Conversation_models.undeploy_conversation_model | source code | ![Open in Cloud Shell][shell_img] | | Conversation_profiles.clear_suggestion_feature_config | source code | ![Open in Cloud Shell][shell_img] | | Conversation_profiles.create_conversation_profile | source code | ![Open in Cloud Shell][shell_img] | | Conversation_profiles.delete_conversation_profile | source code | ![Open in Cloud Shell][shell_img] | | Conversation_profiles.get_conversation_profile | source code | ![Open in Cloud Shell][shell_img] | | Conversation_profiles.list_conversation_profiles | source code | ![Open in Cloud Shell][shell_img] | | Conversation_profiles.set_suggestion_feature_config | source code | ![Open in Cloud Shell][shell_img] | | Conversation_profiles.update_conversation_profile | source code | ![Open in Cloud Shell][shell_img] | | Conversations.complete_conversation | source code | ![Open in Cloud Shell][shell_img] | | Conversations.create_conversation | source code | ![Open in Cloud Shell][shell_img] | | Conversations.generate_stateless_suggestion | source code | ![Open in Cloud Shell][shell_img] | | Conversations.generate_stateless_summary | source code | ![Open in Cloud Shell][shell_img] | | Conversations.get_conversation | source code | ![Open in Cloud Shell][shell_img] | | Conversations.list_conversations | source code | ![Open in Cloud Shell][shell_img] | | Conversations.list_messages | source code | ![Open in Cloud Shell][shell_img] | | Conversations.search_knowledge | source code | ![Open in Cloud Shell][shell_img] | | Conversations.suggest_conversation_summary | source code | ![Open in Cloud Shell][shell_img] | | Documents.create_document | source code | ![Open in Cloud Shell][shell_img] | | Documents.delete_document | source code | ![Open in Cloud Shell][shell_img] | | Documents.export_document | source code | ![Open in Cloud Shell][shell_img] | | Documents.get_document | source code | ![Open in Cloud Shell][shell_img] | | Documents.import_documents | source code | ![Open in Cloud Shell][shell_img] | | Documents.list_documents | source code | ![Open in Cloud Shell][shell_img] | | Documents.reload_document | source code | ![Open in Cloud Shell][shell_img] | | Documents.update_document | source code | ![Open in Cloud Shell][shell_img] | | Encryption_spec_service.get_encryption_spec | source code | ![Open in Cloud Shell][shell_img] | | Encryption_spec_service.initialize_encryption_spec | source code | ![Open in Cloud Shell][shell_img] | | Entity_types.batch_create_entities | source code | ![Open in Cloud Shell][shell_img] | | Entity_types.batch_delete_entities | source code | ![Open in Cloud Shell][shell_img] | | Entity_types.batch_delete_entity_types | source code | ![Open in Cloud Shell][shell_img] | | Entity_types.batch_update_entities | source code | ![Open in Cloud Shell][shell_img] | | Entity_types.batch_update_entity_types | source code | ![Open in Cloud Shell][shell_img] | | Entity_types.create_entity_type | source code | ![Open in Cloud Shell][shell_img] | | Entity_types.delete_entity_type | source code | ![Open in Cloud Shell][shell_img] | | Entity_types.get_entity_type | source code | ![Open in Cloud Shell][shell_img] | | Entity_types.list_entity_types | source code | ![Open in Cloud Shell][shell_img] | | Entity_types.update_entity_type | source code | ![Open in Cloud Shell][shell_img] | | Environments.create_environment | source code | ![Open in Cloud Shell][shell_img] | | Environments.delete_environment | source code | ![Open in Cloud Shell][shell_img] | | Environments.get_environment | source code | ![Open in Cloud Shell][shell_img] | | Environments.get_environment_history | source code | ![Open in Cloud Shell][shell_img] | | Environments.list_environments | source code | ![Open in Cloud Shell][shell_img] | | Environments.update_environment | source code | ![Open in Cloud Shell][shell_img] | | Fulfillments.get_fulfillment | source code | ![Open in Cloud Shell][shell_img] | | Fulfillments.update_fulfillment | source code | ![Open in Cloud Shell][shell_img] | | Generators.create_generator | source code | ![Open in Cloud Shell][shell_img] | | Generators.delete_generator | source code | ![Open in Cloud Shell][shell_img] | | Generators.get_generator | source code | ![Open in Cloud Shell][shell_img] | | Generators.list_generators | source code | ![Open in Cloud Shell][shell_img] | | Generators.update_generator | source code | ![Open in Cloud Shell][shell_img] | | Intents.batch_delete_intents | source code | ![Open in Cloud Shell][shell_img] | | Intents.batch_update_intents | source code | ![Open in Cloud Shell][shell_img] | | Intents.create_intent | source code | ![Open in Cloud Shell][shell_img] | | Intents.delete_intent | source code | ![Open in Cloud Shell][shell_img] | | Intents.get_intent | source code | ![Open in Cloud Shell][shell_img] | | Intents.list_intents | source code | ![Open in Cloud Shell][shell_img] | | Intents.update_intent | source code | ![Open in Cloud Shell][shell_img] | | Knowledge_bases.create_knowledge_base | source code | ![Open in Cloud Shell][shell_img] | | Knowledge_bases.delete_knowledge_base | source code | ![Open in Cloud Shell][shell_img] | | Knowledge_bases.get_knowledge_base | source code | ![Open in Cloud Shell][shell_img] | | Knowledge_bases.list_knowledge_bases | source code | ![Open in Cloud Shell][shell_img] | | Knowledge_bases.update_knowledge_base | source code | ![Open in Cloud Shell][shell_img] | | Participants.analyze_content | source code | ![Open in Cloud Shell][shell_img] | | Participants.create_participant | source code | ![Open in Cloud Shell][shell_img] | | Participants.get_participant | source code | ![Open in Cloud Shell][shell_img] | | Participants.list_participants | source code | ![Open in Cloud Shell][shell_img] | | Participants.streaming_analyze_content | source code | ![Open in Cloud Shell][shell_img] | | Participants.suggest_articles | source code | ![Open in Cloud Shell][shell_img] | | Participants.suggest_faq_answers | source code | ![Open in Cloud Shell][shell_img] | | Participants.suggest_knowledge_assist | source code | ![Open in Cloud Shell][shell_img] | | Participants.suggest_smart_replies | source code | ![Open in Cloud Shell][shell_img] | | Participants.update_participant | source code | ![Open in Cloud Shell][shell_img] | | Session_entity_types.create_session_entity_type | source code | ![Open in Cloud Shell][shell_img] | | Session_entity_types.delete_session_entity_type | source code | ![Open in Cloud Shell][shell_img] | | Session_entity_types.get_session_entity_type | source code | ![Open in Cloud Shell][shell_img] | | Session_entity_types.list_session_entity_types | source code | ![Open in Cloud Shell][shell_img] | | Session_entity_types.update_session_entity_type | source code | ![Open in Cloud Shell][shell_img] | | Sessions.detect_intent | source code | ![Open in Cloud Shell][shell_img] | | Sessions.streaming_detect_intent | source code | ![Open in Cloud Shell][shell_img] | | Versions.create_version | source code | ![Open in Cloud Shell][shell_img] | | Versions.delete_version | source code | ![Open in Cloud Shell][shell_img] | | Versions.get_version | source code | ![Open in Cloud Shell][shell_img] | | Versions.list_versions | source code | ![Open in Cloud Shell][shell_img] | | Versions.update_version | source code | ![Open in Cloud Shell][shell_img] | | Agents.delete_agent | source code | ![Open in Cloud Shell][shell_img] | | Agents.export_agent | source code | ![Open in Cloud Shell][shell_img] | | Agents.get_agent | source code | ![Open in Cloud Shell][shell_img] | | Agents.get_validation_result | source code | ![Open in Cloud Shell][shell_img] | | Agents.import_agent | source code | ![Open in Cloud Shell][shell_img] | | Agents.restore_agent | source code | ![Open in Cloud Shell][shell_img] | | Agents.search_agents | source code | ![Open in Cloud Shell][shell_img] | | Agents.set_agent | source code | ![Open in Cloud Shell][shell_img] | | Agents.train_agent | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dialog