chore(Visual Recognition): Apply manual changes

Author: lpatino10

visual-recognition/src/main/java/com/ibm/watson/developer_cloud/visual_recognition/v3/VisualRecognition.java

@@ -32,10 +32,12 @@
 import com.ibm.watson.developer_cloud.visual_recognition.v3.model.GetCoreMlModelOptions;
 import com.ibm.watson.developer_cloud.visual_recognition.v3.model.ListClassifiersOptions;
 import com.ibm.watson.developer_cloud.visual_recognition.v3.model.UpdateClassifierOptions;
-import java.io.InputStream;
 import okhttp3.MultipartBody;
 import okhttp3.RequestBody;
 
+import java.io.File;
+import java.io.InputStream;
+
 /**
  * The IBM Watson™ Visual Recognition service uses deep learning algorithms to identify scenes, objects, and faces
  * in images you upload to the service. You can create and train a custom classifier to identify subjects that suit
@@ -137,9 +139,13 @@ public VisualRecognition(String versionDate, IamOptions iamOptions) {
    */
   public ServiceCall<ClassifiedImages> classify(ClassifyOptions classifyOptions) {
     Validator.notNull(classifyOptions, "classifyOptions cannot be null");
-    Validator.isTrue((classifyOptions.imagesFile() != null) || (classifyOptions.url() != null) || (classifyOptions
-        .threshold() != null) || (classifyOptions.owners() != null) || (classifyOptions.classifierIds() != null),
-        "At least one of imagesFile, url, threshold, owners, or classifierIds must be supplied.");
+    Validator.isTrue((classifyOptions.imagesFile() != null)
+            || (classifyOptions.url() != null)
+            || (classifyOptions.threshold() != null)
+            || (classifyOptions.owners() != null)
+            || (classifyOptions.classifierIds() != null)
+            || (classifyOptions.parameters() != null),
+        "At least one of imagesFile, url, threshold, owners, classifierIds, or parameters must be supplied.");
     String[] pathSegments = { "v3/classify" };
     RequestBuilder builder = RequestBuilder.post(RequestBuilder.constructHttpUrl(getEndPoint(), pathSegments));
     builder.query(VERSION, versionDate);
@@ -153,6 +159,9 @@ public ServiceCall<ClassifiedImages> classify(ClassifyOptions classifyOptions) {
           .imagesFileContentType());
       multipartBuilder.addFormDataPart("images_file", classifyOptions.imagesFilename(), imagesFileBody);
     }
+    if (classifyOptions.parameters() != null) {
+      multipartBuilder.addFormDataPart("parameters", classifyOptions.parameters());
+    }
     if (classifyOptions.url() != null) {
       multipartBuilder.addFormDataPart("url", classifyOptions.url());
     }
@@ -200,8 +209,10 @@ public ServiceCall<ClassifiedImages> classify() {
    */
   public ServiceCall<DetectedFaces> detectFaces(DetectFacesOptions detectFacesOptions) {
     Validator.notNull(detectFacesOptions, "detectFacesOptions cannot be null");
-    Validator.isTrue((detectFacesOptions.imagesFile() != null) || (detectFacesOptions.url() != null),
-        "At least one of imagesFile or url must be supplied.");
+    Validator.isTrue((detectFacesOptions.imagesFile() != null)
+            || (detectFacesOptions.url() != null)
+            || (detectFacesOptions.parameters() != null),
+        "At least one of imagesFile, url, or parameters must be supplied.");
     String[] pathSegments = { "v3/detect_faces" };
     RequestBuilder builder = RequestBuilder.post(RequestBuilder.constructHttpUrl(getEndPoint(), pathSegments));
     builder.query(VERSION, versionDate);
@@ -212,6 +223,9 @@ public ServiceCall<DetectedFaces> detectFaces(DetectFacesOptions detectFacesOpti
           .imagesFileContentType());
       multipartBuilder.addFormDataPart("images_file", detectFacesOptions.imagesFilename(), imagesFileBody);
     }
+    if (detectFacesOptions.parameters() != null) {
+      multipartBuilder.addFormDataPart("parameters", detectFacesOptions.parameters());
+    }
     if (detectFacesOptions.url() != null) {
       multipartBuilder.addFormDataPart("url", detectFacesOptions.url());
     }
@@ -261,10 +275,13 @@ public ServiceCall<Classifier> createClassifier(CreateClassifierOptions createCl
     MultipartBody.Builder multipartBuilder = new MultipartBody.Builder();
     multipartBuilder.setType(MultipartBody.FORM);
     multipartBuilder.addFormDataPart("name", createClassifierOptions.name());
-    RequestBody classnamePositiveExamplesBody = RequestUtils.inputStreamBody(createClassifierOptions
-        .classnamePositiveExamples(), "application/octet-stream");
-    multipartBuilder.addFormDataPart("classname_positive_examples", createClassifierOptions
-        .classnamePositiveExamplesFilename(), classnamePositiveExamplesBody);
+    // Classes
+    for (String className : createClassifierOptions.classNames()) {
+      String dataName = className + "_positive_examples";
+      File positiveExamples = createClassifierOptions.positiveExamplesByClassName(className);
+      RequestBody body = RequestUtils.fileBody(positiveExamples, "application/octet-stream");
+      multipartBuilder.addFormDataPart(dataName, positiveExamples.getName(), body);
+    }
     if (createClassifierOptions.negativeExamples() != null) {
       RequestBody negativeExamplesBody = RequestUtils.inputStreamBody(createClassifierOptions.negativeExamples(),
           "application/octet-stream");
@@ -342,7 +359,8 @@ public ServiceCall<Classifiers> listClassifiers() {
    * Update a custom classifier by adding new positive or negative classes (examples) or by adding new images to
    * existing classes. You must supply at least one set of positive or negative examples. For details, see [Updating
    * custom
-   * classifiers](https://console.bluemix.net/docs/services/visual-recognition/customizing.html#updating-custom-classifiers).
+   * classifiers]
+   * (https://console.bluemix.net/docs/services/visual-recognition/customizing.html#updating-custom-classifiers).
    *
    * Encode all names in UTF-8 if they contain non-ASCII characters (.zip and image file names, and classifier and class
    * names). The service assumes UTF-8 encoding if it encounters non-ASCII characters.
@@ -356,7 +374,7 @@ public ServiceCall<Classifiers> listClassifiers() {
    */
   public ServiceCall<Classifier> updateClassifier(UpdateClassifierOptions updateClassifierOptions) {
     Validator.notNull(updateClassifierOptions, "updateClassifierOptions cannot be null");
-    Validator.isTrue((updateClassifierOptions.classnamePositiveExamples() != null) || (updateClassifierOptions
+    Validator.isTrue((updateClassifierOptions.classNames().size() > 0) || (updateClassifierOptions
         .negativeExamples() != null),
         "At least one of classnamePositiveExamples or negativeExamples must be supplied.");
     String[] pathSegments = { "v3/classifiers" };
@@ -366,11 +384,12 @@ public ServiceCall<Classifier> updateClassifier(UpdateClassifierOptions updateCl
     builder.query(VERSION, versionDate);
     MultipartBody.Builder multipartBuilder = new MultipartBody.Builder();
     multipartBuilder.setType(MultipartBody.FORM);
-    if (updateClassifierOptions.classnamePositiveExamples() != null) {
-      RequestBody classnamePositiveExamplesBody = RequestUtils.inputStreamBody(updateClassifierOptions
-          .classnamePositiveExamples(), "application/octet-stream");
-      multipartBuilder.addFormDataPart("classname_positive_examples", updateClassifierOptions
-          .classnamePositiveExamplesFilename(), classnamePositiveExamplesBody);
+    // Classes
+    for (String className : updateClassifierOptions.classNames()) {
+      String dataName = className + "_positive_examples";
+      File positiveExamples = updateClassifierOptions.positiveExamplesByClassName(className);
+      RequestBody body = RequestUtils.fileBody(positiveExamples, "application/octet-stream");
+      multipartBuilder.addFormDataPart(dataName, positiveExamples.getName(), body);
     }
     if (updateClassifierOptions.negativeExamples() != null) {
       RequestBody negativeExamplesBody = RequestUtils.inputStreamBody(updateClassifierOptions.negativeExamples(),

visual-recognition/src/main/java/com/ibm/watson/developer_cloud/visual_recognition/v3/model/ClassifyOptions.java

@@ -67,6 +67,8 @@ public interface AcceptLanguage {
   private List<String> owners;
   private List<String> classifierIds;
   private String imagesFileContentType;
+  @Deprecated
+  private String parameters;
 
   /**
    * Builder.
@@ -80,6 +82,8 @@ public static class Builder {
     private List<String> owners;
     private List<String> classifierIds;
     private String imagesFileContentType;
+    @Deprecated
+    private String parameters;
 
     private Builder(ClassifyOptions classifyOptions) {
       imagesFile = classifyOptions.imagesFile;
@@ -90,6 +94,7 @@ private Builder(ClassifyOptions classifyOptions) {
       owners = classifyOptions.owners;
       classifierIds = classifyOptions.classifierIds;
       imagesFileContentType = classifyOptions.imagesFileContentType;
+      parameters = classifyOptions.parameters;
     }
 
     /**
@@ -240,6 +245,18 @@ public Builder imagesFile(File imagesFile) throws FileNotFoundException {
       this.imagesFilename = imagesFile.getName();
       return this;
     }
+
+    /**
+     * Set the parameters.
+     *
+     * @param parameters the parameters
+     * @return the ClassifyOptions builder
+     * @deprecated replaced by the top-level parameters url, threshold, owners, and classifierIds
+     */
+    public Builder parameters(String parameters) {
+      this.parameters = parameters;
+      return this;
+    }
   }
 
   private ClassifyOptions(Builder builder) {
@@ -251,6 +268,7 @@ private ClassifyOptions(Builder builder) {
     owners = builder.owners;
     classifierIds = builder.classifierIds;
     imagesFileContentType = builder.imagesFileContentType;
+    parameters = builder.parameters;
   }
 
   /**
@@ -373,4 +391,14 @@ public List<String> classifierIds() {
   public String imagesFileContentType() {
     return imagesFileContentType;
   }
+
+  /**
+   * Gets the parameters.
+   *
+   * @return the parameters
+   * @deprecated replaced by the top-level parameters url, threshold, owners, and classifierIds
+   */
+  public String parameters() {
+    return parameters;
+  }
 }

visual-recognition/src/main/java/com/ibm/watson/developer_cloud/visual_recognition/v3/model/CreateClassifierOptions.java

@@ -16,6 +16,9 @@
 import java.io.FileInputStream;
 import java.io.FileNotFoundException;
 import java.io.InputStream;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Set;
 
 import com.ibm.watson.developer_cloud.service.model.GenericModel;
 import com.ibm.watson.developer_cloud.util.Validator;
@@ -26,8 +29,7 @@
 public class CreateClassifierOptions extends GenericModel {
 
   private String name;
-  private InputStream classnamePositiveExamples;
-  private String classnamePositiveExamplesFilename;
+  private Map<String, File> classnamePositiveExamples;
   private InputStream negativeExamples;
   private String negativeExamplesFilename;
 
@@ -36,15 +38,13 @@ public class CreateClassifierOptions extends GenericModel {
    */
   public static class Builder {
     private String name;
-    private InputStream classnamePositiveExamples;
-    private String classnamePositiveExamplesFilename;
+    private Map<String, File> classnamePositiveExamples;
     private InputStream negativeExamples;
     private String negativeExamplesFilename;
 
     private Builder(CreateClassifierOptions createClassifierOptions) {
       name = createClassifierOptions.name;
-      classnamePositiveExamples = createClassifierOptions.classnamePositiveExamples;
-      classnamePositiveExamplesFilename = createClassifierOptions.classnamePositiveExamplesFilename;
+      classnamePositiveExamples.putAll(createClassifierOptions.classnamePositiveExamples);
       negativeExamples = createClassifierOptions.negativeExamples;
       negativeExamplesFilename = createClassifierOptions.negativeExamplesFilename;
     }
@@ -53,17 +53,17 @@ private Builder(CreateClassifierOptions createClassifierOptions) {
      * Instantiates a new builder.
      */
     public Builder() {
+      classnamePositiveExamples = new HashMap<>();
     }
 
     /**
      * Instantiates a new builder with required properties.
      *
      * @param name the name
-     * @param classnamePositiveExamples the classnamePositiveExamples
      */
-    public Builder(String name, InputStream classnamePositiveExamples) {
+    public Builder(String name) {
+      this();
       this.name = name;
-      this.classnamePositiveExamples = classnamePositiveExamples;
     }
 
     /**
@@ -87,24 +87,17 @@ public Builder name(String name) {
     }
 
     /**
-     * Set the classnamePositiveExamples.
+     * Adds a classifier with a name and positive examples. If the classifier name is already contained, the old
+     * positive examples are replaced by the specified value.
      *
-     * @param classnamePositiveExamples the classnamePositiveExamples
-     * @return the CreateClassifierOptions builder
+     * @param className the class name
+     * @param positiveExamples the positive examples
+     * @return the builder
      */
-    public Builder classnamePositiveExamples(InputStream classnamePositiveExamples) {
-      this.classnamePositiveExamples = classnamePositiveExamples;
-      return this;
-    }
-
-    /**
-     * Set the classnamePositiveExamplesFilename.
-     *
-     * @param classnamePositiveExamplesFilename the classnamePositiveExamplesFilename
-     * @return the CreateClassifierOptions builder
-     */
-    public Builder classnamePositiveExamplesFilename(String classnamePositiveExamplesFilename) {
-      this.classnamePositiveExamplesFilename = classnamePositiveExamplesFilename;
+    public Builder addClass(String className, File positiveExamples) {
+      Validator.notNull(className, "className cannot be null");
+      Validator.notNull(positiveExamples, "positiveExamples cannot be null");
+      classnamePositiveExamples.put(className, positiveExamples);
       return this;
     }
 
@@ -130,20 +123,6 @@ public Builder negativeExamplesFilename(String negativeExamplesFilename) {
       return this;
     }
 
-    /**
-     * Set the classnamePositiveExamples.
-     *
-     * @param classnamePositiveExamples the classnamePositiveExamples
-     * @return the CreateClassifierOptions builder
-     *
-     * @throws FileNotFoundException if the file could not be found
-     */
-    public Builder classnamePositiveExamples(File classnamePositiveExamples) throws FileNotFoundException {
-      this.classnamePositiveExamples = new FileInputStream(classnamePositiveExamples);
-      this.classnamePositiveExamplesFilename = classnamePositiveExamples.getName();
-      return this;
-    }
-
     /**
      * Set the negativeExamples.
      *
@@ -161,12 +140,10 @@ public Builder negativeExamples(File negativeExamples) throws FileNotFoundExcept
 
   private CreateClassifierOptions(Builder builder) {
     Validator.notNull(builder.name, "name cannot be null");
-    Validator.notNull(builder.classnamePositiveExamples, "classnamePositiveExamples cannot be null");
-    Validator.isTrue((builder.negativeExamples == null) || (builder.negativeExamplesFilename != null),
-        "negativeExamplesFilename cannot be null if negativeExamples is not null.");
+    Validator.isTrue(!builder.classnamePositiveExamples.isEmpty(),
+        "To create a classifier, you must supply at least one positive examples file.");
     name = builder.name;
     classnamePositiveExamples = builder.classnamePositiveExamples;
-    classnamePositiveExamplesFilename = builder.classnamePositiveExamplesFilename;
     negativeExamples = builder.negativeExamples;
     negativeExamplesFilename = builder.negativeExamplesFilename;
   }
@@ -192,7 +169,7 @@ public String name() {
   }
 
   /**
-   * Gets the classnamePositiveExamples.
+   * Gets the class names.
    *
    * A .zip file of images that depict the visual subject of a class in the new classifier. You can include more than
    * one positive example file in a call.
@@ -205,21 +182,20 @@ public String name() {
    *
    * Encode special characters in the file name in UTF-8.
    *
-   * @return the classnamePositiveExamples
+   * @return the classNames
    */
-  public InputStream classnamePositiveExamples() {
-    return classnamePositiveExamples;
+  public Set<String> classNames() {
+    return classnamePositiveExamples.keySet();
   }
 
   /**
-   * Gets the classnamePositiveExamplesFilename.
-   *
-   * The filename for classnamePositiveExamples.
+   * Gets the positive examples by class name.
    *
-   * @return the classnamePositiveExamplesFilename
+   * @param className the class name
+   * @return the positiveExamples
    */
-  public String classnamePositiveExamplesFilename() {
-    return classnamePositiveExamplesFilename;
+  public File positiveExamplesByClassName(String className) {
+    return classnamePositiveExamples.get(className);
   }
 
   /**