Merge pull request #169 from rosette-api/ws-2161-event-endpoint-for-Rosette-Server

WS-2161 event endpoint for rosette server

Author: Katsuya-Tomioka

common/src/main/java/com/basistech/rosette/api/common/AbstractRosetteAPI.java

@@ -54,6 +54,7 @@ public abstract class AbstractRosetteAPI implements AutoCloseable {
     public static final String INFO_SERVICE_PATH = "/info";
     public static final String PING_SERVICE_PATH = "/ping";
     public static final String SUPPORTED_LANGUAGES_SUBPATH = "/supported-languages";
+    public static final String EVENTS_SERVICE_PATH = "/events";
 
     public static final Set<String> DOC_ENDPOINTS = new HashSet<>(Arrays.asList(
         LANGUAGE_SERVICE_PATH,
@@ -74,7 +75,8 @@ public abstract class AbstractRosetteAPI implements AutoCloseable {
         SIMILAR_TERMS_SERVICE_PATH,
         SYNTAX_DEPENDENCIES_SERVICE_PATH,
         TRANSLITERATION_SERVICE_PATH,
-        TOPICS_SERVICE_PATH
+        TOPICS_SERVICE_PATH,
+        EVENTS_SERVICE_PATH
     ));
 
     public static final Set<String> NAMES_ENDPOINTS = new HashSet<>(Arrays.asList(

examples/src/main/java/com/basistech/rosette/examples/EventsExample.java

@@ -0,0 +1,50 @@
+/*
+* Copyright 2021 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.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+package com.basistech.rosette.examples;
+
+import com.basistech.rosette.api.HttpRosetteAPI;
+import com.basistech.rosette.apimodel.DocumentRequest;
+import com.basistech.rosette.apimodel.EventsOptions;
+import com.basistech.rosette.apimodel.EventsResponse;
+import com.basistech.util.LanguageCode;
+
+/**
+ * Example which demonstrates the events API.
+ */
+public class EventsExample extends ExampleBase {
+    public static void main(String[] args) {
+        try {
+            new EventsExample().run();
+        } catch (Exception e) {
+            e.printStackTrace();
+            System.exit(1);
+        }
+    }
+
+    private void run() throws Exception {
+        String topicsData = "I am looking for flights to Super Bowl 2022 in Inglewood, LA.";
+        HttpRosetteAPI rosetteApi = new HttpRosetteAPI.Builder()
+                .key(getApiKeyFromSystemProperty())
+                .url(getAltUrlFromSystemProperty())
+                .build();
+        DocumentRequest<EventsOptions> request = DocumentRequest.<EventsOptions>builder()
+                .language(LanguageCode.ENGLISH)
+                .content(topicsData)
+                .build();
+        EventsResponse resp = rosetteApi.perform(HttpRosetteAPI.EVENTS_SERVICE_PATH, request, EventsResponse.class);
+        System.out.println(responseToJson(resp));
+    }
+}

json/src/test/java/com/basistech/rosette/apimodel/PolymorphicRequestTest.java

@@ -36,7 +36,11 @@ public void init() {
     @Test
     public void testRequestTypes() throws Exception {
         String json = "{\"content\": \"what is my type\", \"language\": \"eng\", \"options\": {\"calculateConfidence\": true}}";
-        Request request = mapper.readValue(json, new TypeReference<DocumentRequest<EntitiesOptions>>() { });
+        Request request = mapper.readValue(json, new TypeReference<DocumentRequest<EventsOptions>>() { });
+        assertTrue(request instanceof DocumentRequest);
+
+        json = "{\"content\": \"what is my type\", \"language\": \"eng\", \"options\": {\"calculateConfidence\": true}}";
+        request = mapper.readValue(json, new TypeReference<DocumentRequest<EntitiesOptions>>() { });
         assertTrue(request instanceof DocumentRequest);
 
         json = "{\"content\": \"what is my type\", \"language\": \"eng\", \"options\": {\"includeDBpediaType\": true, \"calculateConfidence\": true}}";

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

@@ -0,0 +1,42 @@
+/*
+* Copyright 2021 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.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+package com.basistech.rosette.apimodel;
+
+import com.basistech.rosette.annotations.JacksonMixin;
+import lombok.Builder;
+import lombok.Value;
+
+import java.util.List;
+
+/**
+ * Event
+ */
+@Value
+@Builder
+@JacksonMixin
+public class Event {
+
+    /**
+     * @return the event type
+     */
+    private final String type;
+
+    /**
+     * @return the confidence score for the event (0.0-1.0)
+     */
+    private final Double confidence;
+}

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

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2021 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.basistech.rosette.apimodel;
+
+import com.basistech.rosette.annotations.JacksonMixin;
+import lombok.Builder;
+import lombok.Value;
+
+/**
+ * Events options
+ */
+@Value
+@Builder
+@JacksonMixin
+public class EventsOptions extends Options {
+    /**
+     * Default options
+     */
+    public static final EventsOptions DEFAULT = EventsOptions.builder()
+            .calculateConfidence(false)
+            .modelType("stubModel")
+            .build();
+
+    /**
+     * @return the calculateConfidence flag.
+     */
+    private final Boolean calculateConfidence;
+
+    /**
+     * @return the modelType to use.
+     */
+    private final String modelType;
+}

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

@@ -0,0 +1,39 @@
+/*
+* Copyright 2021 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.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+package com.basistech.rosette.apimodel;
+
+import com.basistech.rosette.annotations.JacksonMixin;
+import lombok.Builder;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+
+import java.util.List;
+
+/** 
+ * Simple api response data model for events
+ */
+@Getter
+@EqualsAndHashCode
+@Builder
+@JacksonMixin
+public final class EventsResponse extends Response {
+
+    /**
+     * @return the list of events
+     */
+    private final List<Event> events;
+}