Merge pull request #726 from watson-developer-cloud/develop

4.0.0 - Code generation

Author: germanattanasio

.config.properties.enc

@@ -17,4 +17,5 @@ bin/
 .gradletasknamecache
 docs
 .swagger-codegen-ignore
-.vscode/
+.vscode/
+conversation/src/test/java/com/ibm/watson/developer_cloud/conversation/v1/ConversationTest.java

.gitignore

@@ -4,7 +4,7 @@ if [ "$TRAVIS_PULL_REQUEST" == "false" ] && [ "$TRAVIS_BRANCH" ]; then
 
   git config --global user.email "[email protected]"
   git config --global user.name "Watson Github Bot"
-  git clone --quiet --branch=gh-pages https://${GH_TOKEN}@github.com/watson-developer-cloud/java-sdk gh-pages > /dev/null
+  git clone --quiet --branch=gh-pages https://${GITHUB_TOKEN_DOCS}@github.com/watson-developer-cloud/java-sdk gh-pages > /dev/null
 
   pushd gh-pages
     # on tagged builds, $TRAVIS_BRANCH is the tag (e.g. v1.2.3), otherwise it's the branch name (e.g. master)

.utility/push-javadoc-to-gh-pages.sh

@@ -0,0 +1,97 @@
+# 4.0
+
+## Conversation
+
+- No old version dates -- just current
+- All methods now take options objects, e.g.:
+
+    ```java
+    MessageRequest request = new MessageRequest.Builder()
+      .inputText(message)
+      .build();
+    service.message(workspaceId, request).execute();
+    ```
+  is now:
+
+    ```java
+    MessageOptions messageOptions = new MessageOptions.Builder()
+      .workspaceId(workspaceId)
+      .input(new InputData.Builder(message).build())
+      .build();
+    service.message(messageOptions).execute();
+    ```
+- `Context` is now a formal class that extends map.
+- Many classes have been renamed - mostly dropping "Response" from classnames.
+  - `EntityResponse` is now `Entity`
+  - `ExampleResponse` is now `Example`
+  - `IntentResponse` is now Intent
+  - `WorkspaceResponse` is now `Workspace`
+
+  _This renaming was done for simplicity and to improve consistency across SDKs going forward._
+
+- Counterexample now has its own classes no longer overloaded on Example
+
+## Tone Analyzer
+
+- The method `getTone()` was replaced with: `tone()`.
+
+  For example:
+
+  ```java
+  public ServiceCall<ToneAnalysis> getTone(String text, ToneOptions options)
+  ```
+
+  Is now:
+  ```java
+  public ServiceCall<ToneAnalysis> tone(ToneOptions options)
+  ```
+
+  `tone()` example:
+  ```java
+  ToneOptions toneOptions = new ToneOptions.Builder()
+    .text(text)
+    .build();
+  ToneAnalysis tone = service.tone(toneOptions).execute();
+  ```
+
+- The method `getToneChat()` was replaced with: `toneChat()`.
+
+  For example:
+
+  ```java
+  public ServiceCall<ToneAnalysis> getChatTone(ToneChatRequest options)
+  ```
+
+  Is now:
+
+  ```java
+  public ServiceCall<UtteranceAnalyses> chatTone(ToneChatOptions options) {
+
+  ```
+
+  `chatTone()` example:
+  ```java
+  String[] texts = {
+    "My charger isn't working.",
+    "Thanks for reaching out. Can you give me some more detail about the issue?",
+    "I put my charger in my tablet to charge it up last night and it keeps saying it isn't"
+        + " charging. The charging icon comes on, but it stays on even when I take the charger out. "
+        + "Which is ridiculous, it's brand new.",
+    "I'm sorry you're having issues with charging. What kind of charger are you using?"
+  };
+
+  List<Utterance> utterances = new ArrayList<>();
+  for (int i = 0; i < texts.length; i++) {
+    Utterance utterance = new Utterance.Builder()
+      .text(texts[i])
+      .user(users[i])
+      .build();
+    utterances.add(utterance);
+  }
+  ToneChatOptions toneChatOptions = new ToneChatOptions.Builder()
+    .utterances(utterances)
+    .build();
+
+  // Call the service
+  UtteranceAnalyses utterancesTone = service.toneChat(toneChatOptions).execute();
+  ```

MIGRATION.md

@@ -14,7 +14,6 @@ APIs and SDKs that use cognitive computing to solve complex problems.
   * [Gradle](#gradle)
 * [Usage](#usage)
 * [Getting the Service Credentials](#getting-the-service-credentials)
-* [Android](#android)
 * IBM Watson Services
   * [Alchemy Language](alchemy)
   * [Alchemy Vision](alchemy)
@@ -35,8 +34,7 @@ APIs and SDKs that use cognitive computing to solve complex problems.
   * [Tone Analyzer](tone-analyzer)
   * [Tradeoff Analytics](tradeoff-analytics)
   * [Visual Recognition](visual-recognition)
-* [Reactive API call for v3.0.1](#introduce-reactive-api-call-for-v301)
-* [Breaking Changes for v3.0](#breaking-changes-for-v30)
+* [Changes for v4.0](#changes-for-v40)
 * [Using a Proxy](#using-a-proxy)
 * [Android](#android)
 * [Running in Bluemix](#running-in-bluemix)
@@ -143,103 +141,11 @@ To get your service credentials, follow these steps:
     1. On the left side of the page, click **Service Credentials**, and then **View credentials** to view your service credentials.
     1. Copy `url`, `username` and `password`(`api_key` for AlchemyAPI or Visual Recognition).
 
-
-## Introduce reactive API call for v3.0.1
-
-To do a reactive call, you need to add `rx()`.  With reactive you can use synchronous or asynchronous calls as you like, and you can combine multiple rest calls more efficiently.
-
-Use callback way
-
-```java
-service.getDialogs().rx().thenApply(new CompletableFuture.Fun<List<Dialog>, Integer>() {
-  @Override
-  public Integer apply(List<Dialog> dialogs) {
-    return dialogs.size();
-  }
-}).thenAccept(new CompletableFuture.Action<Integer>() {
-  @Override
-  public void accept(Integer integer) {
-    System.out.println(integer);
-  }
-});
-```
-
-Use asynchronous callback way
-
-```java
-service.getDialogs().rx().thenApplyAsync(new CompletableFuture.Fun<List<Dialog>, Integer>() {
-  @Override
-  public Integer apply(List<Dialog> dialogs) {
-    return dialogs.size();
-  }
-}).thenAccept(new CompletableFuture.Action<Integer>() {
-  @Override
-  public void accept(Integer size) {
-    System.out.println(size);
-  }
-});
-```
-
-Use synchronous way
-
-```java
-Integer size=service.getDialogs().rx().get().size();
-System.out.println(size);
-```
-
-## Breaking Changes for v3.0
-
-The version 3.0 is a major release focused on simplicity and consistency. Several breaking changes were introduced.
-
-### Synchronous vs. Asynchronous
-
-Before 3.0 all the API calls were synchronous.
-
-```java
-List<Dialog> dialogs = dialogService.getDialogs();
-System.out.println(dialogs);
-```
-
-To do a synchronous call, you need to add `execute()`.
-
-```java
-List<Dialog> dialogs = dialogService.getDialogs().execute();
-System.out.println(dialogs);
-```
-
-To do an asynchronous call, you need to specify a callback.
-
-```java
-service.getDialogs().enqueue(new ServiceCallback<List<Dialog>>() {
-  @Override
-  public void onResponse(List<Dialog> response) {
-    System.out.println(response);
-  }
-
-  @Override
-  public void onFailure(Exception e) {
-  }}
-);
-```
-
-See the [CHANGELOG](CHANGELOG.md) for the release notes.
+## Changes for v4.0
+Version 4.0 focuses on the move to programmatically-generated code for many of the services. See the [changelog](https://github.com/watson-developer-cloud/java-sdk/wiki/Changelog) for the details.
 
 ## Migration
-
-To migrate to 3.0 from a previous version, simply add `.execute()` to the old methods.
-For example if you previously had
-
-```java
-List<Dialog> dialogs = dialogService.getDialogs();
-System.out.println(dialogs);
-```
-
-Just add `execute()` on the end, and your code will work exactly the same as before.
-
-```java
-List<Dialog> dialogs = dialogService.getDialogs().execute();
-System.out.println(dialogs);
-```
+This version includes many breaking changes as a result of standardizing behavior across the new generated services. Full details on migration from previous versions can be found [here](https://github.com/watson-developer-cloud/java-sdk/wiki/Migration).
 
 ## Android
 
@@ -305,7 +211,7 @@ For example, if you have the conversation service in Germany, the Endpoint may b
 You will need to call
 
 ```java
-Conversation service = new Conversation("<version-date>");
+ConversationService service = new ConversationService("<version-date>");
 service.sentEndPoint("https://gateway-fra.watsonplatform.net/conversation/api")
 ```
 

README.md

@@ -21,11 +21,38 @@
 Use the [Conversation][conversation] service to identify intents, entities, and conduct conversations.
 
 ```java
-ConversationService service = new ConversationService(ConversationService.VERSION_DATE_2017_03_02);
+ConversationService service = new ConversationService(ConversationService.VERSION_DATE_2017_05_26);
 service.setUsernameAndPassword("<username>", "<password>");
 
-MessageRequest newMessage = new MessageRequest.Builder().inputText("Hi").build();
-MessageResponse response = service.message("<workspace-id>", newMessage).execute();
+InputData input = new InputData.Builder("Hi").build();
+MessageOptions options = new MessageOptions.Builder(workspaceId).input(input).build();
+MessageResponse response = service.message(options).execute();
+System.out.println(response);
+```
+
+Moving from Node 1 to Node 2.
+
+```java
+Context context = null;
+
+// first message
+MessageOptions newMessageOptions = new MessageOptions.Builder()
+    .workspaceId("<workspace-id>")
+    .input(new InputData.Builder("First message").build())
+    .context(context)
+    .build();
+
+MessageResponse response = service.message(newMessageOptions).execute();
+
+// second message
+newMessageOptions = new MessageOptions.Builder()
+    .workspaceId("<workspace-id>")
+    .input(new InputData.Builder("Second message").build())
+    .context(response.getContext()) // output context from the first message
+    .build();
+
+response = service.message(newMessageOptions).execute();
+
 System.out.println(response);
 ```