WIP: Feat/natlog and open ie

package.json

@@ -18,9 +18,9 @@
     "build": "gulp build",
     "build:browser": "gulp build:browser",
     "prepublish": "npm run lint && npm run test && npm run compile",
-    "lint": "eslint 'src/**/*.js' 'test/*.js'",
+    "lint": "eslint \"src/**/*.js\" \"test/*.js\"",
     "lint:fix": "npm run lint -- --fix",
-    "test": "nyc --reporter=html --reporter=text mocha test/setup.js --sort 'src/**/*.spec.js' --compilers js:babel-core/register --timeout 30000",
+    "test": "nyc --reporter=html --reporter=text mocha test/setup.js --sort \"src/**/*.spec.js\" --compilers js:babel-core/register --timeout 30000",
     "test:watch": "npm run test -- --watch",
     "doc": "DEBUG=gulp-jsdoc3 gulp doc"
   },

src/index.js

@@ -5,6 +5,8 @@ import Expression from './simple/expression';
 import Annotable from './simple/annotable';
 import Annotator from './simple/annotator';
 import TokenizerAnnotator from './simple/annotator/tokenize';
+import NaturalLogicAnnotator from './simple/annotator/natlog';
+import OpenIEAnnotator from './simple/annotator/openie';
 import WordsToSentenceAnnotator from './simple/annotator/ssplit';
 import POSTaggerAnnotator from './simple/annotator/pos';
 import MorphaAnnotator from './simple/annotator/lemma';
@@ -58,6 +60,8 @@ export default {
       RelationExtractorAnnotator,
       RegexNERAnnotator,
       CorefAnnotator,
+      NaturalLogicAnnotator,
+      OpenIEAnnotator,
     },
   },
   /**

src/index.spec.js

@@ -10,6 +10,8 @@ import Token from './simple/token';
 import Annotable from './simple/annotable';
 import Annotator from './simple/annotator';
 import TokenizerAnnotator from './simple/annotator/tokenize';
+import OpenIEAnnotator from './simple/annotator/openie';
+import NaturalLogicAnnotator from './simple/annotator/natlog';
 import WordsToSentenceAnnotator from './simple/annotator/ssplit';
 import POSTaggerAnnotator from './simple/annotator/pos';
 import MorphaAnnotator from './simple/annotator/lemma';
@@ -73,6 +75,8 @@ describe('CoreNLP Library entry point', () => {
             RelationExtractorAnnotator,
             RegexNERAnnotator,
             CorefAnnotator,
+            NaturalLogicAnnotator,
+            OpenIEAnnotator,
           });
         });
       });

src/pipeline.js

@@ -2,6 +2,8 @@ import difference from 'lodash.difference';
 import Service from './service';
 import ConnectorServer from './connector/connector-server';
 import tokenize from './simple/annotator/tokenize';
+import natlog from './simple/annotator/natlog';
+import openie from './simple/annotator/openie';
 import ssplit from './simple/annotator/ssplit';
 import pos from './simple/annotator/pos';
 import lemma from './simple/annotator/lemma';
@@ -30,6 +32,8 @@ const ANNOTATORS_BY_KEY = {
   relation,
   regexner,
   coref,
+  natlog,
+  openie,
 };
 
 const LANGUAGE_TO_ISO2 = {

src/simple/annotator/natlog.js

@@ -0,0 +1,40 @@
+import Annotator from '../annotator';
+import TokenizerAnnotator from './tokenize';
+import WordsToSentenceAnnotator from './ssplit';
+import POSTaggerAnnotator from './pos';
+import MorphaAnnotator from './lemma';
+import DependencyParseAnnotator from './depparse';
+
+/**
+ * @class
+ * @classdesc Class representing an Natural Logic Annotator.
+ * @extends Annotator
+ * @memberof CoreNLP/simple/annotator
+ * @requires tokenize, ssplit, pos, lemma, depparse (Can also use parse)
+ * @see {@link https://stanfordnlp.github.io/CoreNLP/natlog.html|NaturalLogicAnnotator}
+ */
+class NaturalLogicAnnotator extends Annotator {
+  /**
+   * Create an Annotator
+   * @param {Object} [options] a key-value map of options, without the annotator prefix
+   */
+  constructor(options = {}) {
+    super(
+      'natlog',
+      {
+        // dopolarity: True by default. If set to false, the annotator will only annotate
+        //            quantifiers and quantifier scopes, and not annotate the polarity of each token
+        ...options,
+      },
+      [
+        new TokenizerAnnotator(),
+        new WordsToSentenceAnnotator(),
+        new POSTaggerAnnotator(),
+        new MorphaAnnotator(),
+        new DependencyParseAnnotator(),
+      ],
+    );
+  }
+}
+
+export default NaturalLogicAnnotator;

src/simple/annotator/natlog.spec.js

@@ -0,0 +1,20 @@
+import NaturalLogicAnnotator from './natlog';
+
+describe('Annotator', () => {
+  let annotator;
+
+  describe('NaturalLogicAnnotator', () => {
+    beforeEach(() => {
+      annotator = new NaturalLogicAnnotator();
+    });
+
+    it('should have a proper pipeline', () => {
+      expect(annotator.pipeline()).to.deep.equal(['tokenize', 'ssplit', 'pos', 'lemma', 'depparse', 'natlog']);
+    });
+
+    it('should have the proper default options', () => {
+      expect(annotator.options()).to.deep.equal({
+      });
+    });
+  });
+});

src/simple/annotator/openie.js

@@ -0,0 +1,51 @@
+import Annotator from '../annotator';
+import NaturalLogicAnnotator from './natlog';
+import DependencyParseAnnotator from './depparse';
+import CorefAnnotator from './coref';
+
+// TODO: Requirements are missing here https://stanfordnlp.github.io/CoreNLP/annotators.html, verify.
+
+/**
+ * @class
+ * @classdesc Class representing an OpenIE Annotator.
+ * @extends Annotator
+ * @memberof CoreNLP/simple/annotator
+ * @requires natlog
+ * @see {@link https://stanfordnlp.github.io/CoreNLP/openie.html|OpenIEAnnotator}
+ */
+class OpenIEAnnotator extends Annotator {
+  /**
+   * Create an Annotator
+   * @param {Object} [options] a key-value map of options, without the annotator prefix
+   */
+  constructor(options = {}) {
+    super(
+      'openie',
+      {
+        // format (Enum) default   One of {reverb, ollie, default, qa_srl}. Changes the output form
+        // filelist (filepath) null   A path to a file, which contains files to annotate.
+        // threads (integer) number   of cores   The number of threads to run on.
+        // max_entailments_per_clause   (integer)   1000  The maximum number of entailments to prod
+        resolve_coref: false, //   (boolean)   false     If true, run coreference (and consequently
+        // ignore_affinity   (boolean)   false     Whether to ignore the affinity model for preposi
+        // affinity_probability_cap   (double)   1  /3   The affinity value above which confidence
+        // triple.strict   (boolean)   true     If true, extract triples only if they consume the e
+        triple: { all_nominals: false }, //     If true, extract nominal relations always and not o
+        // splitter.model   (filepath)       You   can override the default location of the clause
+        // splitter.nomodel   (boolean)   false     Run without a clause splitting model – that is,
+        // splitter.disable   (boolean)   false     Don’t split clauses at all, and only extract re
+        // affinity_models   (filepath)
+        ...options,
+      },
+      options.resolve_coref
+        ? [
+          new CorefAnnotator(),
+          new DependencyParseAnnotator(),
+          new NaturalLogicAnnotator(),
+        ]
+        : [new NaturalLogicAnnotator()],
+    );
+  }
+}
+
+export default OpenIEAnnotator;

src/simple/annotator/openie.spec.js

@@ -0,0 +1,32 @@
+import OpenIEAnnotator from './openie';
+
+describe('Annotator', () => {
+  let annotator;
+
+  describe('OpenIEAnnotator', () => {
+    beforeEach(() => {
+      annotator = new OpenIEAnnotator();
+    });
+
+    it('should have a proper pipeline', () => {
+      expect(annotator.pipeline()).to.deep.equal([
+        'tokenize',
+        'ssplit',
+        'pos',
+        'lemma',
+        'depparse',
+        'natlog',
+        'openie',
+      ]);
+    });
+
+    it('should have the proper default options', () => {
+      expect(annotator.options()).to.deep.equal({
+        resolve_coref: false,
+        triple: {
+          all_nominals: false,
+        },
+      });
+    });
+  });
+});

src/simple/sentence.js

@@ -2,6 +2,7 @@ import head from 'lodash.head';
 import Annotable from './annotable';
 import TokenizerAnnotator from './annotator/tokenize';
 import ParserAnnotator from './annotator/parse';
+import OpenIEAnnotator from './annotator/openie';
 import DependencyParseAnnotator from './annotator/depparse';
 import Token from './token';
 import Governor from './governor';
@@ -30,6 +31,8 @@ class Sentence extends Annotable {
     super(text);
     this._tokens = [];
     this._governors = [];
+    this._openie = [];
+    this._natLogPolarities = [];
   }
 
   /**
@@ -186,18 +189,45 @@ class Sentence extends Annotable {
   }
 
   // TODO
-  // eslint-disable-next-line class-methods-use-this
+  // eslint-disable-next-line class-methods-use-this, no-unused-vars
   natlogPolarities() {
+    // if (!this.hasAnnotator(NaturalLogicAnnotator)) {
+    //   throw new Error(
+    // 'Asked for PolarityAnnotation on Sentence, but there are unmet annotator dependencies.'
+    // );
+    // }
+    // return this._natLogPolarities;
   }
 
   // TODO
   // eslint-disable-next-line class-methods-use-this, no-unused-vars
   natlogPolarity(index) {
+    // if (!this.hasAnnotator(NaturalLogicAnnotator)) {
+    //   throw new Error(
+    // 'Asked for a PolarityAnnotation on Sentence, but there are unmet annotator dependencies.'
+    // );
+    // }
+    // return this._natLogPolarities[index];
   }
 
-  // TODO
-  // eslint-disable-next-line class-methods-use-this
+  /**
+   * Extract open-domain relation triples.
+   * @requires {@link OpenIEAnnotator}
+   * @throws {Error} in case the require annotator was not applied to the sentence
+   * @returns {Array.<OpenIETriple>} OpenIE-Triples
+   */
   openie() {
+    // TODO: Create OpenIE-Triples:
+    // object:"Constantin Hütterer"
+    // objectSpan:Array(2) [3, 5]
+    // relation:"is"
+    // relationSpan:Array(2) [2, 3]
+    // subject:"My name"
+    // subjectSpan:Array(2) [0, 2]
+    if (!this.hasAnnotator(OpenIEAnnotator)) {
+      throw new Error('Asked for a OpenIE-Annotation on Sentence, but there are unmet annotator dependencies.');
+    }
+    return this._openie;
   }
 
   // TODO
@@ -287,6 +317,10 @@ class Sentence extends Annotable {
       this.addAnnotator(ParserAnnotator);
       this._parse = sentence.parse;
     }
+    if (sentence.openie) {
+      this.addAnnotator(OpenIEAnnotator);
+      this._openie = sentence.openie;
+    }
     if (sentence.basicDependencies) {
       this.addAnnotator(DependencyParseAnnotator);
       this._governors = sentence.basicDependencies.map(gov =>