feat(Discovery): Add spellingSuggestions param to QueryOptions

lpatino10 · lpatino10 · commit 68bf9bf7785d · 2019-10-03T16:28:17.000-04:00
This only works on the Cloud Pak for Data version of Discovery
diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v1/model/QueryOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v1/model/QueryOptions.java
@@ -40,6 +40,7 @@ public class QueryOptions extends GenericModel {
   private String similarDocumentIds;
   private String similarFields;
   private String bias;
+  private Boolean spellingSuggestions;
   private Boolean xWatsonLoggingOptOut;
 
   /**
@@ -67,6 +68,7 @@ public static class Builder {
     private String similarDocumentIds;
     private String similarFields;
     private String bias;
+    private Boolean spellingSuggestions;
     private Boolean xWatsonLoggingOptOut;
 
     private Builder(QueryOptions queryOptions) {
@@ -91,6 +93,7 @@ private Builder(QueryOptions queryOptions) {
       this.similarDocumentIds = queryOptions.similarDocumentIds;
       this.similarFields = queryOptions.similarFields;
       this.bias = queryOptions.bias;
+      this.spellingSuggestions = queryOptions.spellingSuggestions;
       this.xWatsonLoggingOptOut = queryOptions.xWatsonLoggingOptOut;
     }
 
@@ -351,6 +354,17 @@ public Builder bias(String bias) {
       return this;
     }
 
+    /**
+     * Set the spellingSuggestions.
+     *
+     * @param spellingSuggestions the spellingSuggestions
+     * @return the QueryOptions builder
+     */
+    public Builder spellingSuggestions(Boolean spellingSuggestions) {
+      this.spellingSuggestions = spellingSuggestions;
+      return this;
+    }
+
     /**
      * Set the xWatsonLoggingOptOut.
      *
@@ -389,6 +403,7 @@ private QueryOptions(Builder builder) {
     similarDocumentIds = builder.similarDocumentIds;
     similarFields = builder.similarFields;
     bias = builder.bias;
+    spellingSuggestions = builder.spellingSuggestions;
     xWatsonLoggingOptOut = builder.xWatsonLoggingOptOut;
   }
 
@@ -655,6 +670,20 @@ public String bias() {
     return bias;
   }
 
+  /**
+   * Gets the spellingSuggestions.
+   *
+   * When `true` and the **natural_language_query** parameter is used, the **natural_languge_query** parameter is spell
+   * checked. The most likely correction is retunred in the **suggested_query** field of the response (if one exists).
+   *
+   * **Important:** this parameter is only valid when using the Cloud Pak version of Discovery.
+   *
+   * @return the spellingSuggestions
+   */
+  public Boolean spellingSuggestions() {
+    return spellingSuggestions;
+  }
+
   /**
    * Gets the xWatsonLoggingOptOut.
    *
