Java idiomatic client for Dialogflow CX.
Note: This client is a work-in-progress, and may occasionally make backwards-incompatible changes.
If you are using Maven, add this to your pom.xml file:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-dialogflow-cx</artifactId>
<version>0.14.2</version>
</dependency>If you are using Gradle without BOM, add this to your dependencies:
implementation 'com.google.cloud:google-cloud-dialogflow-cx:0.14.2'If you are using SBT, add this to your dependencies:
libraryDependencies += "com.google.cloud" % "google-cloud-dialogflow-cx" % "0.14.2"See the Authentication section in the base directory's README.
The client application making API calls must be granted authorization scopes required for the desired Dialogflow CX APIs, and the authenticated principal must have the IAM role(s) required to access GCP resources using the Dialogflow CX API calls.
You will need a Google Cloud Platform Console project with the Dialogflow CX API enabled.
You will need to enable billing to use Google Dialogflow CX.
Follow these instructions to get your project set up. You will also need to set up the local development environment by
installing the Google Cloud SDK and running the following commands in command line:
gcloud auth login and gcloud config set project [YOUR PROJECT ID].
You'll need to obtain the google-cloud-dialogflow-cx library. See the Quickstart section
to add google-cloud-dialogflow-cx as a dependency in your code.
Dialogflow CX provides a new way of designing agents, taking a state machine approach to agent design. This gives you clear and explicit control over a conversation, a better end-user experience, and a better development workflow.
See the Dialogflow CX client library docs to learn how to use this Dialogflow CX Client Library.
Samples are in the samples/ directory.
| Sample | Source Code | Try it |
|---|---|---|
| Configure Webhook To Set Form Parameters As Optional Or Required | source code |  |
| Create Agent | source code | |
| Create Flow | source code | |
| Create Intent | source code | |
| Create Page | source code | |
| Create Simple Page | source code | |
| Delete Page | source code | |
| Detect Intent | source code | |
| Detect Intent Audio Input | source code | |
| Detect Intent Disable Webhook | source code | |
| Detect Intent Event Input | source code | |
| Detect Intent Intent Input | source code | |
| Detect Intent Sentiment Analysis | source code | |
| Detect Intent Stream | source code | |
| Detect Intent Streaming Partial Response | source code | |
| Detect Intent Synthesize Text To Speech Output | source code | |
| Export Agent | source code | |
| List Pages | source code | |
| List Test Case Results | source code | |
| List Training Phrases | source code | |
| Update Intent | source code | |
| Webhook Configure Session Parameters | source code | |
| Webhook Validate Form Parameter | source code | |
To get help, follow the instructions in the shared Troubleshooting document.
Dialogflow CX uses gRPC for the transport layer.
Java 8 or above is required for using this client.
Google's Java client libraries, Google Cloud Client Libraries and Google Cloud API Libraries, follow the Oracle Java SE support roadmap (see the Oracle Java SE Product Releases section).
In general, new feature development occurs with support for the lowest Java LTS version covered by Oracle's Premier Support (which typically lasts 5 years from initial General Availability). If the minimum required JVM for a given library is changed, it is accompanied by a semver major release.
Java 11 and (in September 2021) Java 17 are the best choices for new development.
Google tests its client libraries with all current LTS versions covered by Oracle's Extended Support (which typically lasts 8 years from initial General Availability).
Google's client libraries support legacy versions of Java runtimes with long term stable libraries that don't receive feature updates on a best efforts basis as it may not be possible to backport all patches.
Google provides updates on a best efforts basis to apps that continue to use Java 7, though apps might need to upgrade to current versions of the library that supports their JVM.
The latest versions and the supported Java versions are identified on
the individual GitHub repository github.com/GoogleAPIs/java-SERVICENAME
and on google-cloud-java.
This library follows Semantic Versioning.
It is currently in major version zero (0.y.z), which means that anything may change at any time
and the public API should not be considered stable.
Contributions to this library are always welcome and highly encouraged.
See CONTRIBUTING for more information how to get started.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See Code of Conduct for more information.
Apache 2.0 - See LICENSE for more information.
| Java Version | Status |
|---|---|
| Java 8 |  |
| Java 8 OSX |  |
| Java 8 Windows |  |
| Java 11 |  |
Java is a registered trademark of Oracle and/or its affiliates.