Stanford CoreNLP HTTP Server

About

This software offers the functionality of the Stanford CoreNLP as a HTTP Server. This avoids the time-consuming initialization every time CoreNLP is started. It is very similar to projects like this Python wrapper.

This is a fork (of a fork) from the original StanfordCoreNLPXMLServer with the followign differences:

• No longer limited to XML - serves JSON/XML depending on the requesting 'Accept' header
• Packaged to run as a server on Debian
  • Listening Interface:Port configured in /etc/defaults/corenlphttp
  • Loads configuration from /etc/corenlphttp/*.properties

Example

The server will be listening at http://localhost:8080. The text you want to analyze needs to be POSTed as field text:

 curl --data 'text=Hello world!' http://localhost:8080

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet href="CoreNLP-to-HTML.xsl" type="text/xsl"?>
<root>
  <document>
    <sentences>
      <sentence id="1">
        <tokens>
          <token id="1">
            <word>Hello</word>
            <lemma>hello</lemma>
            <CharacterOffsetBegin>0</CharacterOffsetBegin>
            <CharacterOffsetEnd>5</CharacterOffsetEnd>
            <POS>UH</POS>
            <NER>O</NER>
          </token>
          <token id="2">
            <word>world</word>
            <lemma>world</lemma>
            <CharacterOffsetBegin>6</CharacterOffsetBegin>
            <CharacterOffsetEnd>11</CharacterOffsetEnd>
            <POS>NN</POS>
            <NER>O</NER>
          </token>
          <token id="3">
            <word>!</word>
            <lemma>!</lemma>
            <CharacterOffsetBegin>11</CharacterOffsetBegin>
            <CharacterOffsetEnd>12</CharacterOffsetEnd>
            <POS>.</POS>
            <NER>O</NER>
          </token>
        </tokens>
        <parse>(ROOT (S (VP (NP (INTJ (UH Hello)) (NP (NN world)))) (. !))) </parse>
        <dependencies type="basic-dependencies">
          <dep type="root">
            <governor idx="0">ROOT</governor>
            <dependent idx="2">world</dependent>
          </dep>
          <dep type="discourse">
            <governor idx="2">world</governor>
            <dependent idx="1">Hello</dependent>
          </dep>
        </dependencies>
        <dependencies type="collapsed-dependencies">
          <dep type="root">
            <governor idx="0">ROOT</governor>
            <dependent idx="2">world</dependent>
          </dep>
          <dep type="discourse">
            <governor idx="2">world</governor>
            <dependent idx="1">Hello</dependent>
          </dep>
        </dependencies>
        <dependencies type="collapsed-ccprocessed-dependencies">
          <dep type="root">
            <governor idx="0">ROOT</governor>
            <dependent idx="2">world</dependent>
          </dep>
          <dep type="discourse">
            <governor idx="2">world</governor>
            <dependent idx="1">Hello</dependent>
          </dep>
        </dependencies>
      </sentence>
    </sentences>
  </document>
</root>

Note you can also try this online at Stanford University. Choose XML or JSON as the ouput format to see something close to how Stanford CoreNLP HTTP Server would respond (with appropriate Accept request header)

Installation

1. Clone the repository:

    git clone https://github.com/nlohmann/StanfordCoreNLPXMLServer.git
   

2. Download and install the third party libraries:

    cd StanfordCoreNLPHTTPServer
    ant libs
   

3. Compile the JAR file:

    ant jar
   

4. Run the server:

    ant run
   

5. The server is now waiting on http://localhost:8080 for HTTP POST requests. Note the initialization can take a few minutes, because several modules and resources of Stanford CoreNLP need to be loaded.

   You can also choose a port:

    ant run -Dport=9000
   

Prerequisites

• Oracle JDK or OpenJDK version 8 or later
• Apache Ant

Third Party Libraries

The Stanford CoreNLP HTTP Server Server uses the following third party libraries:

• Stanford CoreNLP, a suite of core NLP tools
• Simple, a Java based HTTP engine

Stanford CoreNLP is now quired as an external dependency. This is handled automatically by the Debian package. Simple can be downloaded and set up using the ant target libs (see Installation).

License

• Stanford CoreNLP is licensed under the GNU General Public License (v2 or later).
• Simple is licensed under the Apache License, Version 2.0

Due to compatibility issues (see GNU.org and Apache.org), the Stanford CoreNLP HTTP Server is licensed under the GNU General Public License Version 3.