Merge pull request #1199 from watson-developer-cloud/fix-examples

chore(examples): fix compilation errors and use maven on sdk examples

Author: kevinkowa

examples/README.md

@@ -6,4 +6,4 @@ This example shows you how to use the Java SDK.
 
 To run the example you need to install the dependencies
 
-    $ gradle assemble
+    $ mvn install

examples/build.gradle

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>com.ibm.watson</groupId>
+    <artifactId>examples</artifactId>
+    <version>1.0-SNAPSHOT</version>
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <source>8</source>
+                    <target>8</target>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+    <dependencies>
+        <dependency>
+            <groupId>com.ibm.watson</groupId>
+            <artifactId>ibm-watson</artifactId>
+            <version>9.3.0</version>
+        </dependency>
+    </dependencies>
+</project>

examples/pom.xml

@@ -16,6 +16,7 @@
 import com.ibm.cloud.sdk.core.http.ServiceCallback;
 import com.ibm.cloud.sdk.core.security.Authenticator;
 import com.ibm.cloud.sdk.core.security.IamAuthenticator;
+import com.ibm.watson.assistant.v1.model.MessageInput;
 import com.ibm.watson.assistant.v1.model.MessageOptions;
 import com.ibm.watson.assistant.v1.model.MessageResponse;
 import io.reactivex.Single;

examples/src/main/java/com/ibm/watson/assistant/v1/AssistantExample.java

@@ -14,8 +14,11 @@
 
 import com.ibm.cloud.sdk.core.http.Response;
 import com.ibm.cloud.sdk.core.http.ServiceCallback;
+import com.ibm.cloud.sdk.core.security.Authenticator;
+import com.ibm.cloud.sdk.core.security.IamAuthenticator;
 import com.ibm.watson.assistant.v1.Assistant;
 import com.ibm.watson.assistant.v1.model.Context;
+import com.ibm.watson.assistant.v1.model.MessageInput;
 import com.ibm.watson.assistant.v1.model.MessageOptions;
 import com.ibm.watson.assistant.v1.model.MessageResponse;
 import com.ibm.watson.tone_analyzer.v3.ToneAnalyzer;
@@ -29,28 +32,28 @@ public static void main(String[] args) throws Exception {
 
     // instantiate the assistant service
     Authenticator assistantAuthenticator = new IamAuthenticator("<iam_api_key>");
-    Assistant assistantService = new Assistant("2019-02-28", assistantAuthenticator);
+    final Assistant assistantService = new Assistant("2019-02-28", assistantAuthenticator);
 
     // instantiate the tone analyzer service
     Authenticator toneAuthenticator = new IamAuthenticator("<iam_api_key>");
     ToneAnalyzer toneService = new ToneAnalyzer("2017-09-21", toneAuthenticator);
 
     // workspace id
-    String workspaceId = "<workspace-id>";
+    final String workspaceId = "<workspace-id>";
 
     // maintain history in the context variable - will add a history variable to
     // each of the emotion, social
     // and language tones
-    boolean maintainHistory = false;
+    final boolean maintainHistory = false;
 
     /**
      * Input for the Assistant service: text (String): an input string (the user's conversation
      * turn) and context (Context): any context that needs to be maintained - either added by the
      * client app or passed in the response from the Assistant service on the previous conversation
      * turn.
      */
-    String text = "I am happy";
-    Context context = null;
+    final String text = "I am happy";
+    final Context context = new Context();
 
     // UPDATE CONTEXT HERE IF CONTINUING AN ONGOING CONVERSATION
     // set local context variable to the context from the last response from the
@@ -59,7 +62,7 @@ public static void main(String[] args) throws Exception {
     // com.ibm.watson.assistant.v1.model)
 
     // async call to Tone Analyzer
-    ToneOptions toneOptions = new ToneOptions.Builder().text(input).build();
+    ToneOptions toneOptions = new ToneOptions.Builder().text(text).build();
     toneService
         .tone(toneOptions)
         .enqueue(
@@ -68,9 +71,9 @@ public static void main(String[] args) throws Exception {
               public void onResponse(Response<ToneAnalysis> toneResponsePayload) {
 
                 // update context with the tone data returned by the Tone Analyzer
-                context =
+                context.setSystem(
                     ToneDetection.updateUserTone(
-                        context, toneResponsePayload.getResult(), maintainHistory);
+                        context, toneResponsePayload.getResult(), maintainHistory));
 
                 // create input for message
                 MessageInput input = new MessageInput();

examples/src/main/java/com/ibm/watson/assistant/v1/tone_analyzer_integration/AssistantToneAnalyzerIntegrationExample.java

@@ -12,6 +12,7 @@
  */
 package com.ibm.watson.assistant.v1.tone_analyzer_integration;
 
+import com.ibm.watson.assistant.v1.model.Context;
 import com.ibm.watson.tone_analyzer.v3.model.ToneAnalysis;
 import com.ibm.watson.tone_analyzer.v3.model.ToneCategory;
 import com.ibm.watson.tone_analyzer.v3.model.ToneScore;
@@ -65,7 +66,7 @@ public static Map<String, Object> updateUserTone(
     List<ToneScore> socialTone = new ArrayList<ToneScore>();
 
     // If the context doesn't already contain the user object, initialize it
-    if (context.containsKey("user") != null) {
+    if (context.getSystem().containsKey("user")) {
       context.put("user", initUser());
     }
 

examples/src/main/java/com/ibm/watson/assistant/v1/tone_analyzer_integration/ToneDetection.java

@@ -68,7 +68,7 @@ public static void main(String[] args) {
       // no environment found, create a new one (assuming we are a FREE plan)
       String environmentName = "watson_developer_cloud_test_environment";
       CreateEnvironmentOptions createOptions =
-          new CreateEnvironmentOptions.Builder().name(environmentName).size(0L) /* FREE */.build();
+          new CreateEnvironmentOptions.Builder().name(environmentName).size(String.valueOf(0L)) /* FREE */.build();
       Environment createResponse = discovery.createEnvironment(createOptions).execute().getResult();
       environmentId = createResponse.getEnvironmentId();
       System.out.println("Created new environment ID: " + environmentId);
@@ -100,8 +100,8 @@ public static void main(String[] args) {
     ListConfigurationsResponse listConfigsResponse =
         discovery.listConfigurations(listConfigsOptions).execute().getResult();
     for (Configuration configuration : listConfigsResponse.getConfigurations()) {
-      if (configuration.getName().equals(DEFAULT_CONFIG_NAME)) {
-        configurationId = configuration.getConfigurationId();
+      if (configuration.name().equals(DEFAULT_CONFIG_NAME)) {
+        configurationId = configuration.configurationId();
         System.out.println("Found default configuration ID: " + configurationId);
         break;
       }

examples/src/main/java/com/ibm/watson/discovery/v1/DiscoveryQueryExample.java

@@ -1,3 +1,5 @@
+package com.ibm.watson.discovery.v2;
+
 import com.ibm.cloud.sdk.core.security.Authenticator;
 import com.ibm.cloud.sdk.core.security.BearerTokenAuthenticator;
 import com.ibm.watson.discovery.v2.Discovery;
@@ -39,14 +41,14 @@ public static void main(String[] args) throws IOException {
     String documentId = addResponse.getDocumentId();
 
     // Query your collection with the new document inside.
-    QueryOptions queryOptoins =
+    QueryOptions queryOptions =
         new QueryOptions.Builder()
             .projectId(projectId)
             .addCollectionIds(collectionId)
             .naturalLanguageQuery(
                 "Watson") // Feel free to replace this to query something different.
             .build();
-    QueryResponse queryResponse = service.query(options).execute().getResult();
+    QueryResponse queryResponse = service.query(queryOptions).execute().getResult();
 
     System.out.println(queryResponse.getMatchingResults() + " results were returned by the query!");
 

examples/src/main/java/com/ibm/watson/discovery/v2/DiscoveryV2Example.java

@@ -25,7 +25,7 @@ public static void main(String[] args) {
     LanguageTranslator service = new LanguageTranslator("2018-05-01", authenticator);
 
     TranslateOptions translateOptions =
-        new TranslateOptions.Builder().addText(text).modelId("en-es").build();
+        new TranslateOptions.Builder().addText("text").modelId("en-es").build();
     TranslationResult translationResult = service.translate(translateOptions).execute().getResult();
 
     System.out.println(translationResult);

examples/src/main/java/com/ibm/watson/language_translator/v3/LanguageTranslatorExample.java

@@ -15,7 +15,7 @@
 import com.ibm.cloud.sdk.core.http.HttpMediaType;
 import com.ibm.cloud.sdk.core.security.Authenticator;
 import com.ibm.cloud.sdk.core.security.IamAuthenticator;
-import com.ibm.watson.speech_to_text.v1.model.RecognizeOptions;
+import com.ibm.watson.speech_to_text.v1.model.RecognizeWithWebsocketsOptions;
 import com.ibm.watson.speech_to_text.v1.model.SpeechRecognitionResults;
 import com.ibm.watson.speech_to_text.v1.websocket.BaseRecognizeCallback;
 import javax.sound.sampled.AudioFormat;
@@ -53,8 +53,8 @@ public static void main(final String[] args) throws Exception {
 
     AudioInputStream audio = new AudioInputStream(line);
 
-    RecognizeOptions options =
-        new RecognizeOptions.Builder()
+    RecognizeWithWebsocketsOptions options =
+        new RecognizeWithWebsocketsOptions.Builder()
             .audio(audio)
             .interimResults(true)
             .timestamps(true)

examples/src/main/java/com/ibm/watson/personality_insights/v3/PersonalityInsightsExample.java

@@ -15,7 +15,7 @@
 import com.ibm.cloud.sdk.core.http.HttpMediaType;
 import com.ibm.cloud.sdk.core.security.Authenticator;
 import com.ibm.cloud.sdk.core.security.IamAuthenticator;
-import com.ibm.watson.speech_to_text.v1.model.RecognizeOptions;
+import com.ibm.watson.speech_to_text.v1.model.RecognizeWithWebsocketsOptions;
 import com.ibm.watson.speech_to_text.v1.model.SpeechRecognitionResults;
 import com.ibm.watson.speech_to_text.v1.websocket.BaseRecognizeCallback;
 import java.io.FileInputStream;
@@ -35,8 +35,8 @@ public static void main(String[] args) throws FileNotFoundException, Interrupted
 
     FileInputStream audio = new FileInputStream("src/test/resources/speech_to_text/sample1.wav");
 
-    RecognizeOptions options =
-        new RecognizeOptions.Builder()
+    RecognizeWithWebsocketsOptions options =
+        new RecognizeWithWebsocketsOptions.Builder()
             .audio(audio)
             .interimResults(true)
             .contentType(HttpMediaType.AUDIO_WAV)

examples/src/main/java/com/ibm/watson/speech_to_text/v1/MicrophoneWithWebSocketsExample.java

@@ -17,6 +17,7 @@
 import com.ibm.cloud.sdk.core.security.IamAuthenticator;
 import com.ibm.cloud.sdk.core.util.GsonSingleton;
 import com.ibm.watson.speech_to_text.v1.model.RecognizeOptions;
+import com.ibm.watson.speech_to_text.v1.model.RecognizeWithWebsocketsOptions;
 import com.ibm.watson.speech_to_text.v1.model.SpeakerLabelsResult;
 import com.ibm.watson.speech_to_text.v1.model.SpeechRecognitionAlternative;
 import com.ibm.watson.speech_to_text.v1.model.SpeechRecognitionResult;
@@ -119,7 +120,7 @@ public void add(SpeechRecognitionResults speechResults) {
       if (speechResults.getResults() != null)
         for (int i = 0; i < speechResults.getResults().size(); i++) {
           SpeechRecognitionResult transcript = speechResults.getResults().get(i);
-          if (transcript.isFinalResults()) {
+          if (transcript.isXFinal()) {
             SpeechRecognitionAlternative speechAlternative = transcript.getAlternatives().get(0);
 
             for (int ts = 0; ts < speechAlternative.getTimestamps().size(); ts++) {
@@ -163,7 +164,7 @@ public void add(SpeakerLabelsResult speakerLabel) {
         recoToken.updateFrom(speakerLabel);
       }
 
-      if (speakerLabel.isFinalResults()) {
+      if (speakerLabel.isXFinal()) {
         markTokensBeforeAsFinal(speakerLabel.getFrom());
         report();
         cleanFinal();
@@ -222,8 +223,8 @@ public static void main(String[] args) throws FileNotFoundException, Interrupted
     Authenticator authenticator = new IamAuthenticator("<iam_api_key>");
     SpeechToText service = new SpeechToText(authenticator);
 
-    RecognizeOptions options =
-        new RecognizeOptions.Builder()
+    RecognizeWithWebsocketsOptions options =
+        new RecognizeWithWebsocketsOptions.Builder()
             .audio(audio)
             .interimResults(true)
             .speakerLabels(true)

examples/src/main/java/com/ibm/watson/speech_to_text/v1/RecognizeUsingWebSocketsExample.java

@@ -12,6 +12,7 @@
  */
 package com.ibm.watson.speech_to_text.v1;
 
+import com.ibm.cloud.sdk.core.http.HttpMediaType;
 import com.ibm.cloud.sdk.core.security.Authenticator;
 import com.ibm.cloud.sdk.core.security.IamAuthenticator;
 import com.ibm.watson.speech_to_text.v1.model.RecognizeOptions;
@@ -33,7 +34,7 @@ public static void main(String[] args) throws FileNotFoundException {
     RecognizeOptions options =
         new RecognizeOptions.Builder()
             .audio(audio)
-            .contentType(RecognizeOptions.ContentType.AUDIO_WAV)
+            .contentType(HttpMediaType.AUDIO_WAV)
             .build();
     SpeechRecognitionResults transcript = service.recognize(options).execute().getResult();