Merge pull request #451 from impresso/develop

Release v3.0.5

Author: theorm

src/schema/schemas/ContentItem.json

@@ -110,7 +110,7 @@
       "items": { "type": "string" }
     },
     "collections": {
-      "oneOf": [
+      "anyOf": [
         { "type": "array", "items": { "type": "string" } },
         { "type": "array", "items": { "$ref": "./Collection.json" } }
       ]

src/schema/schemas/ImpressoNerRequest.json

@@ -10,6 +10,12 @@
       "minLength": 1,
       "maxLength": 3999,
       "description": "Text to be processed for named entity recognition"
+    },
+    "method": {
+      "type": "string",
+      "enum": ["ner", "ner-nel", "nel"],
+      "default": "ner",
+      "description": "NER method to be used: `ner` (default), `ner-nel` (named entity recognition with named entity linking) and `nel` (linking only - enclose entities in [START] [END] tags)."
     }
   },
   "required": ["text"]

src/services/impresso-ner/impresso-ner.class.ts

@@ -3,6 +3,7 @@ import axios, { AxiosResponse } from 'axios'
 
 export interface RequestPayload {
   text: string
+  method: 'ner' | 'ner-nel'
 }
 
 interface DownstreamRequestBody {
@@ -93,20 +94,25 @@ export interface ImpressoNerResponse {
 }
 
 export interface ImpressoNerServiceOptions {
-  impressoNerServiceUrl: string
+  impressoNerServiceBaseUrl: string
 }
 
+const MethodToUrl = { ner: 'ner', 'ner-nel': 'ner-nel', nel: 'nel' }
+
 export class ImpressoNerService {
-  url: string
+  baseUrl: string
 
   constructor(options: ImpressoNerServiceOptions) {
-    this.url = options.impressoNerServiceUrl
+    this.baseUrl = options.impressoNerServiceBaseUrl
   }
 
   async create(data: RequestPayload, params: Params) {
-    const { text } = data
+    const { text, method } = data
+
+    const url = `${this.baseUrl}/${MethodToUrl[method]}/`
+
     const response = await axios.post<DownstreamResponse, AxiosResponse<DownstreamResponse>, DownstreamRequestBody>(
-      this.url,
+      url,
       { data: text }
     )
     if (response.status !== 200) {

src/services/impresso-ner/impresso-ner.schema.ts

@@ -2,12 +2,12 @@ import type { ServiceSwaggerOptions } from 'feathers-swagger'
 import { getRequestBodyContent, getStandardResponses } from '../../util/openapi'
 
 export const docs: ServiceSwaggerOptions = {
-  description: 'Impresso Named Entity Recognition',
+  description: 'Various tools',
   securities: ['create'],
   operations: {
     create: {
       operationId: 'performNer',
-      description: 'Perform Named Entity Recognition of a text',
+      description: 'Perform named entity recognition (and optional named entity linking) of a text',
       requestBody: {
         content: getRequestBodyContent('ImpressoNerRequest'),
       },

src/services/impresso-ner/impresso-ner.service.ts

@@ -6,8 +6,8 @@ import hooks from './impresso-ner.hooks'
 import { docs } from './impresso-ner.schema'
 
 export default (app: ImpressoApplication) => {
-  const url = app.get('impressoNerServiceUrl') ?? 'https://impresso-annotation.epfl.ch/api/ner/'
-  const service = new ImpressoNerService({ impressoNerServiceUrl: url })
+  const url = app.get('impressoNerServiceUrl') ?? 'https://impresso-annotation.epfl.ch/api'
+  const service = new ImpressoNerService({ impressoNerServiceBaseUrl: url })
 
   app.use('/tools/ner', service, {
     events: [],