WS-1220: add salience option (#107)

* WS-1220: add salience option

* WS-1220: checkstyle

* WS-1220: checkstyle again

Author: Li Xu

json/src/main/java/com/basistech/rosette/apimodel/jackson/EntitiesOptionsMixin.java

@@ -25,6 +25,7 @@ public final class EntitiesOptionsMixin extends OptionsMixin {
     @JsonCreator
     private EntitiesOptionsMixin(
             @JsonProperty("calculateConfidence") Boolean calculateConfidence,
+            @JsonProperty("calculateSalience") Boolean calculateSalience,
             @JsonProperty("linkEntities") Boolean linkEntities
     ) {
         //

json/src/main/java/com/basistech/rosette/apimodel/jackson/SentimentOptionsMixin.java

@@ -24,7 +24,8 @@
 public abstract class SentimentOptionsMixin extends OptionsMixin {
     @JsonCreator
     protected SentimentOptionsMixin(
-            @JsonProperty("calculateEntityConfidence") Boolean calculateEntityConfidence
+            @JsonProperty("calculateEntityConfidence") Boolean calculateEntityConfidence,
+            @JsonProperty("calculateEntitySalience") Boolean calculateEntitySalience
     ) {
         //
     }

model/src/main/java/com/basistech/rosette/apimodel/EntitiesOptions.java

@@ -23,8 +23,9 @@
  */
 public final class EntitiesOptions extends Options {
 
-    public static final EntitiesOptions DEFAULT_OPTIONS = new EntitiesOptions(false, true);
+    public static final EntitiesOptions DEFAULT_OPTIONS = new EntitiesOptions(false, false, true);
     private Boolean calculateConfidence;
+    private Boolean calculateSalience;
     private Boolean linkEntities;
 
     /**
@@ -33,8 +34,9 @@ public final class EntitiesOptions extends Options {
      * @param calculateConfidence return confidence score for the extraction.
      * @param linkEntities perform entity linking in addition to extraction.
      */
-    protected EntitiesOptions(Boolean calculateConfidence, Boolean linkEntities) {
+    protected EntitiesOptions(Boolean calculateConfidence, Boolean calculateSalience, Boolean linkEntities) {
         this.calculateConfidence = calculateConfidence;
+        this.calculateSalience = calculateSalience;
         this.linkEntities = linkEntities;
     }
 
@@ -52,6 +54,13 @@ public Boolean getCalculateConfidence() {
         return calculateConfidence;
     }
 
+    /**
+     * @return the calculateSalience flag.
+     */
+    public Boolean getCalculateSalience() {
+        return calculateSalience;
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) {
@@ -62,16 +71,18 @@ public boolean equals(Object o) {
         }
         EntitiesOptions that = (EntitiesOptions) o;
         return Objects.equals(linkEntities, that.linkEntities)
-                && Objects.equals(calculateConfidence, that.calculateConfidence);
+                && Objects.equals(calculateConfidence, that.calculateConfidence)
+                && Objects.equals(calculateSalience, that.calculateSalience);
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(calculateConfidence, linkEntities);
+        return Objects.hash(calculateConfidence, calculateSalience, linkEntities);
     }
 
     public static class Builder {
         private Boolean calculateConfidence;
+        private Boolean calculateSalience;
         private Boolean linkEntities;
 
         public Builder() {
@@ -89,6 +100,17 @@ public Builder calculateConfidence(Boolean calculateConfidence) {
             return this;
         }
 
+        /**
+         * DocumentRequest calculate salience score. If the value is {@code true}, then the endpoint will
+         * return salience scores. If {@code false} or {@code null}, not.
+         * @param calculateSalience whether to get salience score.
+         * @return this.
+         */
+        public Builder calculateSalience(Boolean calculateSalience) {
+            this.calculateSalience = calculateSalience;
+            return this;
+        }
+
         /**
          * DocumentRequest entity linking. If the value is {@code true}, then the the endpoint will link entities to the
          * knowledge base. If {@code false}, not. If {@code null}, the endpoint will perform default processing.
@@ -101,7 +123,7 @@ public Builder linkEntities(Boolean linkEntities) {
         }
 
         public EntitiesOptions build() {
-            return new EntitiesOptions(calculateConfidence, linkEntities);
+            return new EntitiesOptions(calculateConfidence, calculateSalience, linkEntities);
         }
     }
 }

model/src/main/java/com/basistech/rosette/apimodel/EntityMention.java

@@ -31,6 +31,7 @@ public final class EntityMention {
     private final Integer count;
     private final String entityId;
     private final Double confidence;
+    private final Double salience;
 
     /**
      * constructor for {@code EntityMention}
@@ -40,6 +41,7 @@ public final class EntityMention {
      * @param normalized normalized mention text
      * @param count mention count
      * @param entityId if the entity was linked, the ID from the knowledge base.
+     * @param confidence entity confidence
      */
     @Deprecated
     public EntityMention(
@@ -58,6 +60,7 @@ public EntityMention(
         this.count = count;
         this.entityId = entityId;
         this.confidence = confidence;
+        this.salience = null;
     }
 
     /**
@@ -67,6 +70,7 @@ public EntityMention(
      * @param normalized normalized mention text
      * @param entityId if the entity was linked, the ID from the knowledge base.
      * @param count mention count
+     * @param confidence entity confidence
      */
     public EntityMention(
             String type,
@@ -83,6 +87,36 @@ public EntityMention(
         this.entityId = entityId;
         this.count = count;
         this.confidence = confidence;
+        this.salience = null;
+    }
+
+    /**
+     * constructor for {@code EntityMention}
+     * @param type entity type
+     * @param mention mention text
+     * @param normalized normalized mention text
+     * @param entityId if the entity was linked, the ID from the knowledge base.
+     * @param count mention count
+     * @param confidence entity confidence
+     * @param salience entity salience
+     */
+    public EntityMention(
+            String type,
+            String mention,
+            String normalized,
+            String entityId,
+            Integer count,
+            Double confidence,
+            Double salience
+    ) {
+        this.indocChainId = null;
+        this.type = type;
+        this.mention = mention;
+        this.normalized = normalized;
+        this.entityId = entityId;
+        this.count = count;
+        this.confidence = confidence;
+        this.salience = salience;
     }
 
     /**
@@ -144,6 +178,14 @@ public Double getConfidence() {
         return confidence;
     }
 
+    /**
+     * get the salience score for the entity.
+     * @return the salience score  (0.0-1.0)
+     */
+    public Double getSalience() {
+        return salience;
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) {
@@ -159,11 +201,12 @@ public boolean equals(Object o) {
                 && Objects.equals(normalized, that.normalized)
                 && Objects.equals(count, that.count)
                 && Objects.equals(entityId, that.entityId)
-                && Objects.equals(confidence, that.confidence);
+                && Objects.equals(confidence, that.confidence)
+                && Objects.equals(salience, that.salience);
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(indocChainId, type, mention, normalized, count, entityId, confidence);
+        return Objects.hash(indocChainId, type, mention, normalized, count, entityId, confidence, salience);
     }
 }

model/src/main/java/com/basistech/rosette/apimodel/EntitySentiment.java

@@ -29,6 +29,7 @@ public final class EntitySentiment {
     private final Integer count;
     private final String entityId;
     private final Double confidence;
+    private final Double salience;
     private final Label sentiment;
 
     /**
@@ -48,12 +49,35 @@ public EntitySentiment(String type,
                            String entityId,
                            Double confidence,
                            Label sentiment) {
+        this(type, mention, normalized, count, entityId, confidence, null, sentiment);
+    }
+
+    /**
+     * constructor for {@code EntitySentiment}
+     * @param type entity type
+     * @param mention mention text
+     * @param normalized normalized mention text
+     * @param count mention count
+     * @param entityId if the entity was linked, the ID from the knowledge base.
+     * @param confidence entity confidence.
+     * @param salience entity salience.
+     * @param sentiment the sentiment information.
+     */
+    public EntitySentiment(String type,
+                           String mention,
+                           String normalized,
+                           Integer count,
+                           String entityId,
+                           Double confidence,
+                           Double salience,
+                           Label sentiment) {
         this.type = type;
         this.mention = mention;
         this.normalized = normalized;
         this.count = count;
         this.entityId = entityId;
         this.confidence = confidence;
+        this.salience = salience;
         this.sentiment = sentiment;
     }
 
@@ -107,6 +131,14 @@ public Double getConfidence() {
         return confidence;
     }
 
+    /**
+     * get the entity salience
+     * @return the entity salience
+     */
+    public Double getSalience() {
+        return salience;
+    }
+
     /**
      * @return the sentiment information.
      */
@@ -129,11 +161,12 @@ public boolean equals(Object o) {
                 && Objects.equals(count, that.count)
                 && Objects.equals(entityId, that.entityId)
                 && Objects.equals(confidence, that.confidence)
+                && Objects.equals(salience, that.salience)
                 && Objects.equals(sentiment, that.sentiment);
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(type, mention, normalized, count, entityId, confidence, sentiment);
+        return Objects.hash(type, mention, normalized, count, entityId, confidence, salience, sentiment);
     }
 }

model/src/main/java/com/basistech/rosette/apimodel/SentimentOptions.java

@@ -22,16 +22,18 @@
  * Sentiment options.
  */
 public final class SentimentOptions extends Options {
-    public static final SentimentOptions DEGAULT_OPTIONS = new SentimentOptions(false);
+    public static final SentimentOptions DEGAULT_OPTIONS = new SentimentOptions(false, false);
     private Boolean calculateEntityConfidence;
+    private Boolean calculateEntitySalience;
 
     /**
      * Constructor for {@code SentimentOptions}
      *
      * @param calculateEntityConfidence return confidence score for the entities.
      */
-    protected SentimentOptions(Boolean calculateEntityConfidence) {
+    protected SentimentOptions(Boolean calculateEntityConfidence, Boolean calculateEntitySalience) {
         this.calculateEntityConfidence = calculateEntityConfidence;
+        this.calculateEntitySalience = calculateEntitySalience;
     }
 
     /**
@@ -41,6 +43,13 @@ public Boolean getCalculateEntityConfidence() {
         return calculateEntityConfidence;
     }
 
+    /**
+     * @return the calculateEntitySalience flag.
+     */
+    public Boolean getCalculateEntitySalience() {
+        return calculateEntitySalience;
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) {
@@ -50,16 +59,18 @@ public boolean equals(Object o) {
             return false;
         }
         SentimentOptions that = (SentimentOptions)o;
-        return Objects.equals(this.calculateEntityConfidence, that.calculateEntityConfidence);
+        return Objects.equals(this.calculateEntityConfidence, that.calculateEntityConfidence)
+                && Objects.equals(this.calculateEntitySalience, that.calculateEntitySalience);
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(calculateEntityConfidence);
+        return Objects.hash(calculateEntityConfidence, calculateEntitySalience);
     }
 
     public static class Builder {
         private Boolean calculateEntityConfidence;
+        private Boolean calculateEntitySalience;
 
         /**
          * DocumentRequest calculate entity confidence score. If the value is {@code true}, then the endpoint will
@@ -72,8 +83,19 @@ public Builder calculateEntityConfidence(Boolean calculateEntityConfidence) {
             return this;
         }
 
+        /**
+         * DocumentRequest calculate entity salience score. If the value is {@code true}, then the endpoint will
+         * return salience scores. If {@code false} or {@code null}, not.
+         * @param calculateEntitySalience whether to get entity salience score.
+         * @return this.
+         */
+        public Builder calculateEntitySalience(Boolean calculateEntitySalience) {
+            this.calculateEntitySalience = calculateEntitySalience;
+            return this;
+        }
+
         public SentimentOptions build() {
-            return new SentimentOptions(calculateEntityConfidence);
+            return new SentimentOptions(calculateEntityConfidence, calculateEntitySalience);
         }
     }
 }