Merge pull request #254 from aodn/feature/7979-add-ai-param-vocabs

Feature/7979 add ai param vocabs

Author: utas-raymondng

server/src/main/java/au/org/aodn/ogcapi/server/core/mapper/Converter.java

@@ -231,6 +231,10 @@ default <D extends StacCollectionModel> Collection getCollection(D m, Filter fil
             if (m.getSummaries().getParameterVocabs() != null && !m.getSummaries().getParameterVocabs().isEmpty()) {
                 collection.getProperties().put(CollectionProperty.parameterVocabs, m.getSummaries().getParameterVocabs());
             }
+
+            if (m.getSummaries().getAiParameterVocabs() != null && !m.getSummaries().getAiParameterVocabs().isEmpty()) {
+                collection.getProperties().put(CollectionProperty.aiParameterVocabs, m.getSummaries().getAiParameterVocabs());
+            }
         }
 
         return collection;

server/src/main/java/au/org/aodn/ogcapi/server/core/model/ConceptModel.java

@@ -1,5 +1,7 @@
 package au.org.aodn.ogcapi.server.core.model;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Data;
@@ -14,4 +16,8 @@ public class ConceptModel {
     protected String url;
     protected String description;
     protected String title;
+
+    @JsonInclude(JsonInclude.Include.NON_NULL)
+    @JsonProperty("ai:description")
+    protected String aiDescription;
 }

server/src/main/java/au/org/aodn/ogcapi/server/core/model/SummariesModel.java

@@ -51,4 +51,7 @@ public class SummariesModel {
 
     @JsonProperty("parameter_vocabs")
     protected List<String> parameterVocabs;
+
+    @JsonProperty("ai:parameter_vocabs")
+    protected List<String> aiParameterVocabs;
 }

server/src/main/java/au/org/aodn/ogcapi/server/core/model/enumeration/CQLFields.java

@@ -149,6 +149,18 @@ public enum CQLFields implements CQLFieldsInterface {
             null,
             null
     ),
+    ai_parameter_vocabs(
+            StacSummeries.AiParameterVocabs.searchField,
+            StacSummeries.AiParameterVocabs.displayField,
+            null,
+            null
+    ),
+    ai_platform_vocabs(
+            StacSummeries.AiPlatformVocabs.searchField,
+            StacSummeries.AiPlatformVocabs.displayField,
+            null,
+            null
+    ),
     organisation_vocabs(
             StacBasicField.OrganisationVocabs.searchField,
             StacBasicField.OrganisationVocabs.displayField,

server/src/main/java/au/org/aodn/ogcapi/server/core/model/enumeration/CollectionProperty.java

@@ -25,7 +25,8 @@ public enum CollectionProperty {
     aiDescription("ai:description"),
     aiUpdateFrequency("ai:update_frequency"),
     scope("scope"),
-    parameterVocabs("parameter_vocabs");
+    parameterVocabs("parameter_vocabs"),
+    aiParameterVocabs("ai:parameter_vocabs");
 
     private final String value;
 

server/src/main/java/au/org/aodn/ogcapi/server/core/model/enumeration/StacSummeries.java

@@ -16,7 +16,9 @@ public enum StacSummeries {
     Status("summaries.status", "summaries.status"),
     Statement("summaries.statement", "summaries.statement"),
     Credits("summaries.credits", "summaries.credits"),
-    Scope("summaries.scope", "summaries.scope")
+    Scope("summaries.scope", "summaries.scope"),
+    AiParameterVocabs("summaries.ai:parameter_vocabs", "summaries.ai:parameter_vocabs"),
+    AiPlatformVocabs("summaries.ai:platform_vocabs", "summaries.ai:platform_vocabs")
     ;
 
     public final String sortField;

server/src/test/java/au/org/aodn/ogcapi/server/common/RestApiTest.java

@@ -712,6 +712,7 @@ public void verifyAssetSummarySearchWorks() throws IOException {
         assertEquals("35234913-aa3c-48ec-b9a4-77f822f66ef8", Objects.requireNonNull(collections.getBody()).getCollections().get(0).getId(), "asset.summary exist 35234913-aa3c-48ec-b9a4-77f822f66ef8");
     }
 
+    @Test
     public void verifyAiUpdateFrequencyWorks() throws IOException {
         super.insertJsonToElasticRecordIndex("caf7220a-19e0-4a7f-9af6-eade6c79a47a.json"); // this record is assumed to have a delayed mode with AI enhanced ai:update_frequency field
         ResponseEntity<Collections> collections = testRestTemplate.exchange(
@@ -721,6 +722,7 @@ public void verifyAiUpdateFrequencyWorks() throws IOException {
                 new ParameterizedTypeReference<>() {});
 
         assertEquals(1, Objects.requireNonNull(collections.getBody()).getCollections().size(), "hit 1");
+        assertEquals("caf7220a-19e0-4a7f-9af6-eade6c79a47a", Objects.requireNonNull(collections.getBody()).getCollections().get(0).getId(), "ai:update_frequency exist caf7220a-19e0-4a7f-9af6-eade6c79a47a");
 
         collections = testRestTemplate.exchange(
                 getBasePath() + "/collections?filter=(ai_update_frequency='real-time')",
@@ -730,6 +732,26 @@ public void verifyAiUpdateFrequencyWorks() throws IOException {
 
 
         assertEquals(0, Objects.requireNonNull(collections.getBody()).getCollections().size(), "no real-time records found");
-        assertEquals("caf7220a-19e0-4a7f-9af6-eade6c79a47a", Objects.requireNonNull(collections.getBody()).getCollections().get(0).getId(), "ai:update_frequency exist caf7220a-19e0-4a7f-9af6-eade6c79a47a");
+        }
+
+    @Test
+    public void verifyAiParameterVocabsWorks() throws IOException {
+        super.insertJsonToElasticRecordIndex("e26d0a56-5603-4413-911d-7b359a533a75.json"); // this record is assumed to have predicted keyword with AI enhanced ai:parameter_vocabs field
+        ResponseEntity<Collections> collections = testRestTemplate.exchange(
+                getBasePath() + "/collections?filter=(parameter_vocabs='ocean biota' OR ai_parameter_vocabs='ocean biota')",
+                HttpMethod.GET,
+                null,
+                new ParameterizedTypeReference<>() {});
+
+        assertEquals(1, Objects.requireNonNull(collections.getBody()).getCollections().size(), "hit 1");
+
+        collections = testRestTemplate.exchange(
+                getBasePath() + "/collections?filter=(platform_vocabs='glider' OR ai_platform_vocabs='glider')",
+                HttpMethod.GET,
+                null,
+                new ParameterizedTypeReference<>() {});
+
+
+        assertEquals(0, Objects.requireNonNull(collections.getBody()).getCollections().size(), "no records found for glider platform");
     }
 }

server/src/test/resources/databag/e26d0a56-5603-4413-911d-7b359a533a75.json

@@ -54,6 +54,11 @@
     "revision": "2019-10-14T00:00:00",
     "dataset_group": ["aims"],
     "update_frequency": "completed",
+    "ai:update_frequency": "completed",
+    "ai:parameter_vocabs": [
+      "ocean biota"
+    ],
+    "ai:platform_vocabs": [],
     "proj:geometry": {
       "geometries": [
         {
@@ -152,8 +157,10 @@
         "end": "1986-02-28T12:59:59Z"
       }
     ],
-    "parameter_vocabs": [],
-    "platform_vocabs": [],
+    "parameter_vocabs_sayt": [
+      "ocean biota"
+    ],
+    "platform_vocabs_sayt": [],
     "organisation_vocabs": [
       "Australian Institute of Marine Science (AIMS)"
     ]
@@ -442,7 +449,18 @@
       ]
     }
   ],
-  "themes": [],
+  "themes": [{
+    "concepts": [
+      {
+        "id": "Abundance of biota",
+        "url": "http://vocab.aodn.org.au/def/discovery_parameter/entity/488",
+        "title": "AODN Discovery Parameter Vocabulary",
+        "description": "",
+        "ai:description": "This is the prediction provided by AI model."
+      }
+    ],
+    "scheme": "theme"
+  }],
   "id": "e26d0a56-5603-4413-911d-7b359a533a75",
   "search_suggestions": {
     "abstract_phrases": [

server/src/test/resources/portal_records_index_schema.json

@@ -25,6 +25,7 @@
             "et_al_stop",
             "english_stop",
             "length_filter",
+            "token_limit",
             "shingle_filter",
             "unique"
           ]
@@ -56,6 +57,10 @@
           "pattern": "\\b\\d+\\b",
           "replacement": ""
         },
+        "token_limit" : {
+          "type": "limit",
+          "max_token_count": 350
+        },
         "length_filter": {
           "type": "length",
           "min": 2
@@ -195,6 +200,15 @@
             "type": "keyword",
             "index": false
           },
+          "ai:update_frequency": {
+            "type": "keyword"
+          },
+          "ai:parameter_vocabs": {
+            "type": "keyword"
+          },
+          "ai:platform_vocabs": {
+            "type": "keyword"
+          },
           "score": {
             "type": "long"
           },