Tej 1058 linking confidence rosapi 1.8 (#110)

* TEJ-1058: added linkingConfidence to EntityMention

* TEJ-1058: test data

Author: Katsuya-Tomioka

api/src/test/mock-data/response/eng-doc-entities.json

@@ -19,7 +19,8 @@
       "indocChainId": 2, 
       "mention": "Afghanistan", 
       "normalized": "Afghanistan", 
-      "type": "LOCATION"
+      "type": "LOCATION",
+      "salience": 1.0
     }, 
     {
       "count": 1, 

api/src/test/mock-data/response/eng-doc-entities_linked.json

@@ -4,19 +4,22 @@
       "confidence": 0.6191439548350202, 
       "entityId": "Q30", 
       "indocChainId": 0, 
-      "mention": "U.S."
+      "mention": "U.S.",
+      "linkingConfidence": 0.5
     }, 
     {
       "confidence": 0.1883195998298547, 
       "entityId": "Q796", 
       "indocChainId": 1, 
-      "mention": "Iraq"
-    }, 
+      "mention": "Iraq",
+      "linkingConfidence": 0.5
+    },
     {
       "confidence": 0.16953509200793812, 
       "entityId": "Q889", 
       "indocChainId": 2, 
-      "mention": "Afghanistan"
+      "mention": "Afghanistan",
+      "linkingConfidence": 0.5
     }
   ]
-}
+}

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

@@ -28,7 +28,9 @@ public EntityMentionMixin(
             @JsonProperty("normalized") String normalized,
             @JsonProperty("count") Integer count,
             @JsonProperty("entityId") String entityId,
-            @JsonProperty("confidence") Double confidence
+            @JsonProperty("confidence") Double confidence,
+            @JsonProperty("salience") Double salience,
+            @JsonProperty("linkingConfidence") Double linkingConfidence
     ) {
         //
     }

json/src/test/data/EntitiesResponse.json

@@ -5,7 +5,10 @@
       "indocChainId": 0, 
       "mention": "Samsung", 
       "normalized": "Samsung", 
-      "type": "ORGANIZATION"
+      "type": "ORGANIZATION",
+      "salience": 1.0,
+      "confidence": 1.0,
+      "linkingConfidence": 1.0
     }
   ]
 }

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

@@ -32,6 +32,7 @@ public final class EntityMention {
     private final String entityId;
     private final Double confidence;
     private final Double salience;
+    private final Double linkingConfidence;
 
     /**
      * constructor for {@code EntityMention}
@@ -61,6 +62,7 @@ public EntityMention(
         this.entityId = entityId;
         this.confidence = confidence;
         this.salience = null;
+        this.linkingConfidence = null;
     }
 
     /**
@@ -88,6 +90,7 @@ public EntityMention(
         this.count = count;
         this.confidence = confidence;
         this.salience = null;
+        this.linkingConfidence = null;
     }
 
     /**
@@ -117,6 +120,40 @@ public EntityMention(
         this.count = count;
         this.confidence = confidence;
         this.salience = salience;
+        this.linkingConfidence = null;
+    }
+
+    /**
+     * constructor for {@code EntityMention}
+     * @param indocChainId in-document entity chain id
+     * @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
+     */
+    @Deprecated
+    public EntityMention(
+        Integer indocChainId,
+        String type,
+        String mention,
+        String normalized,
+        Integer count,
+        String entityId,
+        Double confidence,
+        Double salience,
+        Double linkingConfidence
+    ) {
+        this.indocChainId = indocChainId;
+        this.type = type;
+        this.mention = mention;
+        this.normalized = normalized;
+        this.count = count;
+        this.entityId = entityId;
+        this.confidence = confidence;
+        this.salience = salience;
+        this.linkingConfidence = linkingConfidence;
     }
 
     /**
@@ -180,12 +217,20 @@ public Double getConfidence() {
 
     /**
      * get the salience score for the entity.
-     * @return the salience score  (0.0-1.0)
+     * @return the salience score  (0.0 or 1.0)
      */
     public Double getSalience() {
         return salience;
     }
 
+    /**
+     * get the linking confidence score for the entity.
+     * @return the linking confidence score  (0.0-1.0)
+     */
+    public Double getLinkingConfidence() {
+        return linkingConfidence;
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) {
@@ -202,11 +247,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(salience, that.salience)
+                && Objects.equals(linkingConfidence, that.linkingConfidence);
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(indocChainId, type, mention, normalized, count, entityId, confidence, salience);
+        return Objects.hash(indocChainId, type, mention, normalized, count, entityId, confidence, salience, linkingConfidence);
     }
 }