node-stanford-corenlp

A simple node.js wrapper for Stanford CoreNLP and implemented in ES6.

What is Stanford CoreNLP?

Stanford CoreNLP provides a set of natural language analysis tools which can take raw English language text input and give the base forms of words, their parts of speech, whether they are names of companies, people, etc., normalize dates, times, and numeric quantities, and mark up the structure of sentences in terms of phrases and word dependencies, and indicate which noun phrases refer to the same entities. Stanford CoreNLP is an integrated framework, which make it very easy to apply a bunch of language analysis tools to a piece of text. Starting from plain text, you can run all the tools on it with just two lines of code. Its analyses provide the foundational building blocks for higher-level and domain-specific text understanding applications.

Stanford CoreNLP integrates all our NLP tools, including the part-of-speech (POS) tagger, the named entity recognizer (NER), the parser, and the coreference resolution system, and provides model files for analysis of English. The goal of this project is to enable people to quickly and painlessly get complete linguistic annotations of natural language texts. It is designed to be highly flexible and extensible. With a single option you can change which tools should be enabled and which should be disabled.

The Stanford CoreNLP code is written in Java and licensed under the GNU General Public License (v2 or later). Source is included. Note that this is the full GPL, which allows many free uses, but not its use in distributed proprietary software. The download is 214 MB and requires Java 1.6+.

Installation

node-stanford-simple-nlp depends on Stanford CoreNLP v3.5.2. And don't forget to set proper environment variables like JAVA_HOME in your system.

$ npm install stanford-corenlp

Dependencies

To run this module, you will need to download and install the CoreNLP framework from Stanford. For example, during testing, I did the following to install the lib.

cd /usr/local/src/
wget -N http://nlp.stanford.edu/software/stanford-corenlp-full-2015-04-20.zip
unzip stanford-corenlp-full-2015-04-20.zip
mv stanford-corenlp-full-2015-04-20 /opt/standford-corenlp

JAVA_HOME

Be sure JAVA_HOME is set to avoid issues. Below is an example of how to do this in a Mac OSX environment:

JAVA_HOME="$(/usr/libexec/java_home)" mocha test/test-standford-nlp.js

Configuration

Configuration is in ./config/default.json. Important things to note about the configuration file is the version of CoreNLP you've installed, the install location (path) and the annotators you want to load.

Usage

// allow us to mutate the config if all options wasn't set
process.env['ALLOW_CONFIG_MUTATIONS']=true

let config = require('config');
let nlp = new NLP(config.get('corenlp'));

nlp
  .loadPipeline()
  .then(function() {
      nlp.process(txt).then(function(result) {
        nlp.sentiment(result).
          then(function(tone) {
            console.log('Sentiment: ', tone)
          }).catch(function(e) {
            console.log('Error: ', e);
          })
      }).catch(function(e) {
        console.log(e);
      });
  });

Errors

If you are getting error Error: Could not create class edu.stanford.nlp.pipeline.StanfordCoreNLP java.lang.UnsupportedClassVersionError: edu/stanford/nlp/pipeline/StanfordCoreNLP : Unsupported major.minor version 52.0

That's possibly the class was compiled with a version different than what node-java is using. When you compiled node-java was your java home the same?

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

This license also applies to the included Stanford CoreNLP files.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

kirk7880/node-stanford-corenlp