🐛 fix customization id parameter for speech to text

Author: germanattanasio

speech-to-text/src/main/java/com/ibm/watson/developer_cloud/speech_to_text/v1/SpeechToText.java

@@ -39,6 +39,7 @@
 import com.ibm.watson.developer_cloud.speech_to_text.v1.model.SpeechSession;
 import com.ibm.watson.developer_cloud.speech_to_text.v1.model.SpeechSessionStatus;
 import com.ibm.watson.developer_cloud.speech_to_text.v1.model.Word;
+import com.ibm.watson.developer_cloud.speech_to_text.v1.model.WordData;
 import com.ibm.watson.developer_cloud.speech_to_text.v1.util.MediaTypeUtils;
 import com.ibm.watson.developer_cloud.speech_to_text.v1.websocket.RecognizeCallback;
 import com.ibm.watson.developer_cloud.speech_to_text.v1.websocket.WebSocketManager;
@@ -65,7 +66,7 @@ public class SpeechToText extends WatsonService {
   private static final String ALLOW_OVERRIDE = "allow_override";
   private static final String CALLBACK_URL = "callback_url";
   private static final String CONTINUOUS = "continuous";
-  private static final String CUSTOMIZATION_ID = "custormization_id";
+  private static final String CUSTOMIZATION_ID = "customization_id";
   private static final String EVENTS = "events";
   private static final String INACTIVITY_TIMEOUT = "inactivity_timeout";
   private static final String KEYWORDS = "keywords";
@@ -620,12 +621,12 @@ public ServiceCall<SpeechSessionStatus> getRecognizeStatus(final SpeechSession s
    * @param wordName the word name
    * @return the words
    */
-  public ServiceCall<Word> getWord(String customizationId, String wordName) {
+  public ServiceCall<WordData> getWord(String customizationId, String wordName) {
     Validator.notNull(customizationId, "customizationId cannot be null");
     Validator.notNull(wordName, "wordName cannot be null");
 
     RequestBuilder requestBuilder = RequestBuilder.get(String.format(PATH_WORD, customizationId, wordName));
-    return createServiceCall(requestBuilder.build(), ResponseConverterUtils.getObject(Word.class));
+    return createServiceCall(requestBuilder.build(), ResponseConverterUtils.getObject(WordData.class));
   }
 
   /**
@@ -636,14 +637,14 @@ public ServiceCall<Word> getWord(String customizationId, String wordName) {
    * @param type the word type. Possible values are: ALL, USER or CORPORA.
    * @return the words
    */
-  public ServiceCall<List<Word>> getWords(String customizationId, Word.Type type) {
+  public ServiceCall<List<WordData>> getWords(String customizationId, Word.Type type) {
     Validator.notNull(customizationId, "customizationId cannot be null");
     RequestBuilder requestBuilder = RequestBuilder.get(String.format(PATH_WORDS, customizationId));
     if (type != null) {
       requestBuilder.query(WORD_TYPE, type.toString().toLowerCase());
     }
 
-    ResponseConverter<List<Word>> converter = ResponseConverterUtils.getGenericObject(TYPE_WORDS, WORDS);
+    ResponseConverter<List<WordData>> converter = ResponseConverterUtils.getGenericObject(TYPE_WORDS, WORDS);
     return createServiceCall(requestBuilder.build(), converter);
   }
 

speech-to-text/src/main/java/com/ibm/watson/developer_cloud/speech_to_text/v1/model/Corpus.java

@@ -28,13 +28,13 @@ public class Corpus extends GenericModel {
    */
   public enum Status {
 
-    /** The analyzer. */
-    @SerializedName("analyzed") ANALYZER,
+    /** The corpus has been successfully analyzed. */
+    @SerializedName("analyzed") ANALYZED,
 
-    /** The being processed. */
+    /** The corpus is being processed. */
     @SerializedName("being_processed") BEING_PROCESSED,
 
-    /** The undetermined. */
+    /** The corpus analysis has encountered a problem. */
     @SerializedName("undetermined") UNDETERMINED
   }
 

speech-to-text/src/main/java/com/ibm/watson/developer_cloud/speech_to_text/v1/model/Word.java

@@ -29,11 +29,8 @@ public enum Type {
 
   @SerializedName("display_as")
   private String displayAs;
-  private String error;
   @SerializedName("sounds_like")
   private List<String> soundsLike;
-
-  private List<String> source;
   private String word;
 
   /**
@@ -45,16 +42,6 @@ public String getDisplayAs() {
     return displayAs;
   }
 
-  /**
-   * Gets the error. <br />
-   * If the service discovered a problem with the custom word's definition.
-   *
-   * @return The error
-   */
-  public String getError() {
-    return error;
-  }
-
   /**
    * Gets the sounds like. An array of pronunciations for the custom word
    *
@@ -64,15 +51,6 @@ public List<String> getSoundsLike() {
     return soundsLike;
   }
 
-  /**
-   * Gets the array of sources that describes how the word was added to the custom model's words resource.
-   *
-   * @return The source
-   */
-  public List<String> getSource() {
-    return source;
-  }
-
   /**
    * Gets the word.
    *
@@ -91,15 +69,6 @@ public void setDisplayAs(String displayAs) {
     this.displayAs = displayAs;
   }
 
-  /**
-   * Sets the error.
-   *
-   * @param error The error
-   */
-  public void setError(String error) {
-    this.error = error;
-  }
-
   /**
    * Sets the sounds like. An array of pronunciations for the custom word.
    *
@@ -109,15 +78,6 @@ public void setSoundsLike(List<String> soundsLike) {
     this.soundsLike = soundsLike;
   }
 
-  /**
-   * Sets the array of sources that describes how the word was added to the custom model's words resource.
-   *
-   * @param source The source
-   */
-  public void setSource(List<String> source) {
-    this.source = source;
-  }
-
   /**
    * Sets the word.
    *

speech-to-text/src/main/java/com/ibm/watson/developer_cloud/speech_to_text/v1/model/WordData.java

@@ -0,0 +1,61 @@
+/*
+ * Copyright 2015 IBM Corp. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+package com.ibm.watson.developer_cloud.speech_to_text.v1.model;
+
+import java.util.List;
+
+/**
+ * Represents a {@link Word} with error and source.
+ */
+public class WordData extends Word {
+
+  private String error;
+  private List<String> source;
+
+  /**
+   * Gets the error. If the service discovered a problem with the custom word's definition.
+   *
+   * @return The error
+   */
+  public String getError() {
+    return error;
+  }
+
+  /**
+   * Gets the array of sources that describes how the word was added to the custom model's words resource.
+   *
+   * @return The source
+   */
+  public List<String> getSource() {
+    return source;
+  }
+
+  /**
+   * Sets the error.
+   *
+   * @param error The error
+   */
+  public void setError(String error) {
+    this.error = error;
+  }
+
+  /**
+   * Sets the array of sources that describes how the word was added to the custom model's words resource.
+   *
+   * @param source The source
+   */
+  public void setSource(List<String> source) {
+    this.source = source;
+  }
+
+}

tests/src/test/java/com/ibm/watson/developer_cloud/speech_to_text/v1/SpeechToTextIT.java

@@ -46,6 +46,7 @@
 import com.ibm.watson.developer_cloud.speech_to_text.v1.model.Transcript;
 import com.ibm.watson.developer_cloud.speech_to_text.v1.model.Word;
 import com.ibm.watson.developer_cloud.speech_to_text.v1.model.Word.Type;
+import com.ibm.watson.developer_cloud.speech_to_text.v1.model.WordData;
 import com.ibm.watson.developer_cloud.speech_to_text.v1.websocket.BaseRecognizeCallback;
 
 /**
@@ -384,7 +385,7 @@ public void testAddTextToCorpus() {
    */
   @Test
   public void testGetWords() {
-    List<Word> result = service.getWords(customizationId, Type.ALL).execute();
+    List<WordData> result = service.getWords(customizationId, Type.ALL).execute();
     assertNotNull(result);
     assertTrue(!result.isEmpty());
   }

tests/src/test/java/com/ibm/watson/developer_cloud/speech_to_text/v1/SpeechToTextTest.java

@@ -41,16 +41,18 @@
 import com.ibm.watson.developer_cloud.http.HttpMediaType;
 import com.ibm.watson.developer_cloud.speech_to_text.v1.model.Corpus;
 import com.ibm.watson.developer_cloud.speech_to_text.v1.model.Customization;
+import com.ibm.watson.developer_cloud.speech_to_text.v1.model.Customization.WordTypeToAdd;
 import com.ibm.watson.developer_cloud.speech_to_text.v1.model.RecognitionJob;
 import com.ibm.watson.developer_cloud.speech_to_text.v1.model.RecognizeOptions;
+import com.ibm.watson.developer_cloud.speech_to_text.v1.model.RecognizeOptions.Builder;
 import com.ibm.watson.developer_cloud.speech_to_text.v1.model.SpeechAlternative;
 import com.ibm.watson.developer_cloud.speech_to_text.v1.model.SpeechModel;
 import com.ibm.watson.developer_cloud.speech_to_text.v1.model.SpeechResults;
 import com.ibm.watson.developer_cloud.speech_to_text.v1.model.SpeechSession;
 import com.ibm.watson.developer_cloud.speech_to_text.v1.model.Transcript;
 import com.ibm.watson.developer_cloud.speech_to_text.v1.model.Word;
 import com.ibm.watson.developer_cloud.speech_to_text.v1.model.Word.Type;
-import com.ibm.watson.developer_cloud.speech_to_text.v1.model.Customization.WordTypeToAdd;
+import com.ibm.watson.developer_cloud.speech_to_text.v1.model.WordData;
 import com.ibm.watson.developer_cloud.speech_to_text.v1.util.MediaTypeUtils;
 import com.ibm.watson.developer_cloud.util.GsonSingleton;
 import com.ibm.watson.developer_cloud.util.TestUtils;
@@ -259,6 +261,30 @@ public void testRecognize() throws URISyntaxException, InterruptedException {
     assertEquals(HttpMediaType.AUDIO_WAV, request.getHeader(CONTENT_TYPE));
   }
 
+  /**
+   * Test recognize with customization.
+   *
+   * @throws FileNotFoundException the file not found exception
+   * @throws InterruptedException the interrupted exception
+   */
+  @Test
+  public void testRecognizeWithCustomization() throws FileNotFoundException, InterruptedException {
+    String id = "foo";
+    String recString =
+        getStringFromInputStream(new FileInputStream("src/test/resources/speech_to_text/recognition.json"));
+    JsonObject recognition = new JsonParser().parse(recString).getAsJsonObject();
+
+    server.enqueue(new MockResponse().addHeader(CONTENT_TYPE, HttpMediaType.APPLICATION_JSON).setBody(recString));
+
+    RecognizeOptions options = new RecognizeOptions.Builder().customizationId(id).build();
+    SpeechResults result = service.recognize(SAMPLE_WAV, options).execute();
+    final RecordedRequest request = server.takeRequest();
+
+    assertEquals("POST", request.getMethod());
+    assertEquals(PATH_RECOGNIZE + "?customization_id=" + id, request.getPath());
+    assertEquals(recognition, GSON.toJsonTree(result));
+  }
+
   /**
    * Test recognize -missing audio file, generate IllegalArgumentException.
    *
@@ -583,7 +609,7 @@ public void testGetWords() throws InterruptedException, FileNotFoundException {
 
     server.enqueue(new MockResponse().addHeader(CONTENT_TYPE, HttpMediaType.APPLICATION_JSON).setBody(wordsAsStr));
 
-    List<Word> result = service.getWords(id, Type.ALL).execute();
+    List<WordData> result = service.getWords(id, Type.ALL).execute();
     final RecordedRequest request = server.takeRequest();
 
     assertEquals("GET", request.getMethod());

tests/src/test/resources/speech_to_text/recognition.json

@@ -0,0 +1,14 @@
+{
+  "results": [
+     {
+        "alternatives": [
+           {
+              "confidence": 0.998,
+              "transcript": "who is at risk for immune Thrombocytopenia "
+           }
+        ],
+        "final": true
+     }
+  ],
+  "result_index": 0
+}