feat(discovery): Add similarity options in query methods

Author: lpatino10

discovery/src/main/java/com/ibm/watson/developer_cloud/discovery/v1/Discovery.java

@@ -749,6 +749,15 @@ public ServiceCall<QueryResponse> federatedQuery(FederatedQueryOptions federated
     if (federatedQueryOptions.deduplicateField() != null) {
       builder.query("deduplicate.field", federatedQueryOptions.deduplicateField());
     }
+    if (federatedQueryOptions.similar() != null) {
+      builder.query("similar", String.valueOf(federatedQueryOptions.similar()));
+    }
+    if (federatedQueryOptions.similarDocumentIds() != null) {
+      builder.query("similar.document_ids", RequestUtils.join(federatedQueryOptions.similarDocumentIds(), ","));
+    }
+    if (federatedQueryOptions.similarFields() != null) {
+      builder.query("similar.fields", RequestUtils.join(federatedQueryOptions.similarFields(), ","));
+    }
     return createServiceCall(builder.build(), ResponseConverterUtils.getObject(QueryResponse.class));
   }
 
@@ -800,6 +809,15 @@ public ServiceCall<QueryNoticesResponse> federatedQueryNotices(
     if (federatedQueryNoticesOptions.deduplicateField() != null) {
       builder.query("deduplicate.field", federatedQueryNoticesOptions.deduplicateField());
     }
+    if (federatedQueryNoticesOptions.similar() != null) {
+      builder.query("similar", String.valueOf(federatedQueryNoticesOptions.similar()));
+    }
+    if (federatedQueryNoticesOptions.similarDocumentIds() != null) {
+      builder.query("similar.document_ids", RequestUtils.join(federatedQueryNoticesOptions.similarDocumentIds(), ","));
+    }
+    if (federatedQueryNoticesOptions.similarFields() != null) {
+      builder.query("similar.fields", RequestUtils.join(federatedQueryNoticesOptions.similarFields(), ","));
+    }
     return createServiceCall(builder.build(), ResponseConverterUtils.getObject(QueryNoticesResponse.class));
   }
 
@@ -862,6 +880,15 @@ public ServiceCall<QueryResponse> query(QueryOptions queryOptions) {
     if (queryOptions.deduplicateField() != null) {
       builder.query("deduplicate.field", queryOptions.deduplicateField());
     }
+    if (queryOptions.similar() != null) {
+      builder.query("similar", String.valueOf(queryOptions.similar()));
+    }
+    if (queryOptions.similarDocumentIds() != null) {
+      builder.query("similar.document_ids", RequestUtils.join(queryOptions.similarDocumentIds(), ","));
+    }
+    if (queryOptions.similarFields() != null) {
+      builder.query("similar.fields", RequestUtils.join(queryOptions.similarFields(), ","));
+    }
     return createServiceCall(builder.build(), ResponseConverterUtils.getObject(QueryResponse.class));
   }
 
@@ -954,6 +981,15 @@ public ServiceCall<QueryNoticesResponse> queryNotices(QueryNoticesOptions queryN
     if (queryNoticesOptions.deduplicateField() != null) {
       builder.query("deduplicate.field", queryNoticesOptions.deduplicateField());
     }
+    if (queryNoticesOptions.similar() != null) {
+      builder.query("similar", String.valueOf(queryNoticesOptions.similar()));
+    }
+    if (queryNoticesOptions.similarDocumentIds() != null) {
+      builder.query("similar.document_ids", RequestUtils.join(queryNoticesOptions.similarDocumentIds(), ","));
+    }
+    if (queryNoticesOptions.similarFields() != null) {
+      builder.query("similar.fields", RequestUtils.join(queryNoticesOptions.similarFields(), ","));
+    }
     return createServiceCall(builder.build(), ResponseConverterUtils.getObject(QueryNoticesResponse.class));
   }
 

discovery/src/main/java/com/ibm/watson/developer_cloud/discovery/v1/model/FederatedQueryNoticesOptions.java

@@ -35,6 +35,9 @@ public class FederatedQueryNoticesOptions extends GenericModel {
   private List<String> sort;
   private Boolean highlight;
   private String deduplicateField;
+  private Boolean similar;
+  private List<String> similarDocumentIds;
+  private List<String> similarFields;
 
   /**
    * Builder.
@@ -52,6 +55,9 @@ public static class Builder {
     private List<String> sort;
     private Boolean highlight;
     private String deduplicateField;
+    private Boolean similar;
+    private List<String> similarDocumentIds;
+    private List<String> similarFields;
 
     private Builder(FederatedQueryNoticesOptions federatedQueryNoticesOptions) {
       environmentId = federatedQueryNoticesOptions.environmentId;
@@ -66,6 +72,9 @@ private Builder(FederatedQueryNoticesOptions federatedQueryNoticesOptions) {
       sort = federatedQueryNoticesOptions.sort;
       highlight = federatedQueryNoticesOptions.highlight;
       deduplicateField = federatedQueryNoticesOptions.deduplicateField;
+      similar = federatedQueryNoticesOptions.similar;
+      similarDocumentIds = federatedQueryNoticesOptions.similarDocumentIds;
+      similarFields = federatedQueryNoticesOptions.similarFields;
     }
 
     /**
@@ -139,6 +148,36 @@ public Builder addSort(String sort) {
       return this;
     }
 
+    /**
+     * Adds an similarDocumentIds to similarDocumentIds.
+     *
+     * @param similarDocumentIds the new similarDocumentIds
+     * @return the FederatedQueryNoticesOptions builder
+     */
+    public Builder addSimilarDocumentIds(String similarDocumentIds) {
+      Validator.notNull(similarDocumentIds, "similarDocumentIds cannot be null");
+      if (this.similarDocumentIds == null) {
+        this.similarDocumentIds = new ArrayList<String>();
+      }
+      this.similarDocumentIds.add(similarDocumentIds);
+      return this;
+    }
+
+    /**
+     * Adds an similarFields to similarFields.
+     *
+     * @param similarFields the new similarFields
+     * @return the FederatedQueryNoticesOptions builder
+     */
+    public Builder addSimilarFields(String similarFields) {
+      Validator.notNull(similarFields, "similarFields cannot be null");
+      if (this.similarFields == null) {
+        this.similarFields = new ArrayList<String>();
+      }
+      this.similarFields.add(similarFields);
+      return this;
+    }
+
     /**
      * Set the environmentId.
      *
@@ -273,6 +312,41 @@ public Builder deduplicateField(String deduplicateField) {
       this.deduplicateField = deduplicateField;
       return this;
     }
+
+    /**
+     * Set the similar.
+     *
+     * @param similar the similar
+     * @return the FederatedQueryNoticesOptions builder
+     */
+    public Builder similar(Boolean similar) {
+      this.similar = similar;
+      return this;
+    }
+
+    /**
+     * Set the similarDocumentIds.
+     * Existing similarDocumentIds will be replaced.
+     *
+     * @param similarDocumentIds the similarDocumentIds
+     * @return the FederatedQueryNoticesOptions builder
+     */
+    public Builder similarDocumentIds(List<String> similarDocumentIds) {
+      this.similarDocumentIds = similarDocumentIds;
+      return this;
+    }
+
+    /**
+     * Set the similarFields.
+     * Existing similarFields will be replaced.
+     *
+     * @param similarFields the similarFields
+     * @return the FederatedQueryNoticesOptions builder
+     */
+    public Builder similarFields(List<String> similarFields) {
+      this.similarFields = similarFields;
+      return this;
+    }
   }
 
   private FederatedQueryNoticesOptions(Builder builder) {
@@ -290,6 +364,9 @@ private FederatedQueryNoticesOptions(Builder builder) {
     sort = builder.sort;
     highlight = builder.highlight;
     deduplicateField = builder.deduplicateField;
+    similar = builder.similar;
+    similarDocumentIds = builder.similarDocumentIds;
+    similarFields = builder.similarFields;
   }
 
   /**
@@ -445,4 +522,42 @@ public Boolean highlight() {
   public String deduplicateField() {
     return deduplicateField;
   }
+
+  /**
+   * Gets the similar.
+   *
+   * When `true`, results are returned based on their similarity to the document IDs specified in the
+   * `similar.document_ids` parameter. The default is `false`.
+   *
+   * @return the similar
+   */
+  public Boolean similar() {
+    return similar;
+  }
+
+  /**
+   * Gets the similarDocumentIds.
+   *
+   * A comma-separated list of document IDs that will be used to find similar documents. **Note:** If the
+   * `natural_language_query` parameter is also specified, it will be used to expand the scope of the document
+   * similarity search to include the natural language query. Other query parameters, such as `filter` and `query` are
+   * subsequently applied and reduce the query scope.
+   *
+   * @return the similarDocumentIds
+   */
+  public List<String> similarDocumentIds() {
+    return similarDocumentIds;
+  }
+
+  /**
+   * Gets the similarFields.
+   *
+   * A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. If
+   * not specified, the entire document is used for comparison.
+   *
+   * @return the similarFields
+   */
+  public List<String> similarFields() {
+    return similarFields;
+  }
 }

discovery/src/main/java/com/ibm/watson/developer_cloud/discovery/v1/model/FederatedQueryOptions.java

@@ -36,6 +36,9 @@ public class FederatedQueryOptions extends GenericModel {
   private Boolean highlight;
   private Boolean deduplicate;
   private String deduplicateField;
+  private Boolean similar;
+  private List<String> similarDocumentIds;
+  private List<String> similarFields;
 
   /**
    * Builder.
@@ -54,6 +57,9 @@ public static class Builder {
     private Boolean highlight;
     private Boolean deduplicate;
     private String deduplicateField;
+    private Boolean similar;
+    private List<String> similarDocumentIds;
+    private List<String> similarFields;
 
     private Builder(FederatedQueryOptions federatedQueryOptions) {
       environmentId = federatedQueryOptions.environmentId;
@@ -69,6 +75,9 @@ private Builder(FederatedQueryOptions federatedQueryOptions) {
       highlight = federatedQueryOptions.highlight;
       deduplicate = federatedQueryOptions.deduplicate;
       deduplicateField = federatedQueryOptions.deduplicateField;
+      similar = federatedQueryOptions.similar;
+      similarDocumentIds = federatedQueryOptions.similarDocumentIds;
+      similarFields = federatedQueryOptions.similarFields;
     }
 
     /**
@@ -142,6 +151,36 @@ public Builder addSort(String sort) {
       return this;
     }
 
+    /**
+     * Adds an similarDocumentIds to similarDocumentIds.
+     *
+     * @param similarDocumentIds the new similarDocumentIds
+     * @return the FederatedQueryOptions builder
+     */
+    public Builder addSimilarDocumentIds(String similarDocumentIds) {
+      Validator.notNull(similarDocumentIds, "similarDocumentIds cannot be null");
+      if (this.similarDocumentIds == null) {
+        this.similarDocumentIds = new ArrayList<String>();
+      }
+      this.similarDocumentIds.add(similarDocumentIds);
+      return this;
+    }
+
+    /**
+     * Adds an similarFields to similarFields.
+     *
+     * @param similarFields the new similarFields
+     * @return the FederatedQueryOptions builder
+     */
+    public Builder addSimilarFields(String similarFields) {
+      Validator.notNull(similarFields, "similarFields cannot be null");
+      if (this.similarFields == null) {
+        this.similarFields = new ArrayList<String>();
+      }
+      this.similarFields.add(similarFields);
+      return this;
+    }
+
     /**
      * Set the environmentId.
      *
@@ -287,6 +326,41 @@ public Builder deduplicateField(String deduplicateField) {
       this.deduplicateField = deduplicateField;
       return this;
     }
+
+    /**
+     * Set the similar.
+     *
+     * @param similar the similar
+     * @return the FederatedQueryOptions builder
+     */
+    public Builder similar(Boolean similar) {
+      this.similar = similar;
+      return this;
+    }
+
+    /**
+     * Set the similarDocumentIds.
+     * Existing similarDocumentIds will be replaced.
+     *
+     * @param similarDocumentIds the similarDocumentIds
+     * @return the FederatedQueryOptions builder
+     */
+    public Builder similarDocumentIds(List<String> similarDocumentIds) {
+      this.similarDocumentIds = similarDocumentIds;
+      return this;
+    }
+
+    /**
+     * Set the similarFields.
+     * Existing similarFields will be replaced.
+     *
+     * @param similarFields the similarFields
+     * @return the FederatedQueryOptions builder
+     */
+    public Builder similarFields(List<String> similarFields) {
+      this.similarFields = similarFields;
+      return this;
+    }
   }
 
   private FederatedQueryOptions(Builder builder) {
@@ -305,6 +379,9 @@ private FederatedQueryOptions(Builder builder) {
     highlight = builder.highlight;
     deduplicate = builder.deduplicate;
     deduplicateField = builder.deduplicateField;
+    similar = builder.similar;
+    similarDocumentIds = builder.similarDocumentIds;
+    similarFields = builder.similarFields;
   }
 
   /**
@@ -473,4 +550,42 @@ public Boolean deduplicate() {
   public String deduplicateField() {
     return deduplicateField;
   }
+
+  /**
+   * Gets the similar.
+   *
+   * When `true`, results are returned based on their similarity to the document IDs specified in the
+   * `similar.document_ids` parameter. The default is `false`.
+   *
+   * @return the similar
+   */
+  public Boolean similar() {
+    return similar;
+  }
+
+  /**
+   * Gets the similarDocumentIds.
+   *
+   * A comma-separated list of document IDs that will be used to find similar documents. **Note:** If the
+   * `natural_language_query` parameter is also specified, it will be used to expand the scope of the document
+   * similarity search to include the natural language query. Other query parameters, such as `filter` and `query` are
+   * subsequently applied and reduce the query scope.
+   *
+   * @return the similarDocumentIds
+   */
+  public List<String> similarDocumentIds() {
+    return similarDocumentIds;
+  }
+
+  /**
+   * Gets the similarFields.
+   *
+   * A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. If
+   * not specified, the entire document is used for comparison.
+   *
+   * @return the similarFields
+   */
+  public List<String> similarFields() {
+    return similarFields;
+  }
 }