WS-1693: Add PermID to Simple Response.

Author: seth-mg

api/src/test/java/com/basistech/rosette/api/RosetteAPITest.java

@@ -1,5 +1,5 @@
 /*
-* Copyright 2014 Basis Technology Corp.
+* Copyright 2014-2019 Basis Technology Corp.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -280,6 +280,20 @@ public void testGetEntityLinked() throws IOException {
         }
     }
 
+
+    @Test
+    public void testGetEntityPermId() throws IOException {
+        if (testFilename.endsWith("-entities_permid.json")) {
+            DocumentRequest<?> request = readValue(DocumentRequest.class);
+            try {
+                EntitiesResponse response = api.perform(AbstractRosetteAPI.ENTITIES_SERVICE_PATH, request, EntitiesResponse.class);
+                verifyEntity(response);
+            } catch (HttpRosetteAPIException e){
+                verifyException(e);
+            }
+        }
+    }
+
     @Test
     public void testIgnoredUnknownField() throws IOException {
         if ("unknown-field-entities.json".equals(testFilename)) {

api/src/test/mock-data/request/eng-doc-entities_permid.json

@@ -0,0 +1,5 @@
+{
+  "content": "Virgin Galactic said that it will merge with Social Capital Hedosophia allowing the company to become publicly traded.",
+  "language": "eng",
+  "options": {"includePermID":  true}
+}

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

@@ -0,0 +1,34 @@
+{
+  "entities": [
+    {
+      "type": "PERSON",
+      "mention": "Virgin Galactic",
+      "normalized": "Virgin Galactic",
+      "count": 1,
+      "mentionOffsets": [
+        {
+          "startOffset": 16,
+          "endOffset": 31
+        }
+      ],
+      "entityId": "T0",
+      "confidence": 0.21180975,
+      "permId": "https://permid.org/1-5000950848"
+    },
+    {
+      "type": "ORGANIZATION",
+      "mention": "Social Capital Hedosophia",
+      "normalized": "Social Capital Hedosophia",
+      "count": 1,
+      "mentionOffsets": [
+        {
+          "startOffset": 61,
+          "endOffset": 86
+        }
+      ],
+      "entityId": "T1",
+      "confidence": 0.04323018,
+      "permId": "https://permid.org/1-5057796824"
+    }
+  ]
+}

api/src/test/mock-data/response/eng-doc-entities_permid.status

@@ -0,0 +1 @@
+200

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

@@ -1,5 +1,5 @@
 /*
-* Copyright 2017 Basis Technology Corp.
+* Copyright 2017-2019 Basis Technology Corp.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -58,7 +58,7 @@ public class EntitiesOptions extends Options {
     private final String modelType;
 
     /**
-     * @retrun the includeDBpediaType flag.
+     * @return the includeDBpediaType flag.
      */
     private final Boolean includeDBpediaType;
 

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

@@ -1,5 +1,5 @@
 /*
-* Copyright 2017 Basis Technology Corp.
+* Copyright 2017-2019 Basis Technology Corp.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -87,4 +87,8 @@ public class Entity {
      */
     private final String dbpediaType;
 
+    /**
+     * @return the PermID
+     */
+    private final String permId;
 }