Apache NLPCraft - Natural Language Interface

Support

For any questions, feedback or suggestions:

File a bug or improvement in NLPCraft JIRA
Post a question at Stack Overflow using nlpcraft tag
Access GitHub mirror repository.
Join project developers on dev@nlpcraft.apache.org (subscribe, archive)

By downloading NLPCraft you are agreeing to Apache 2.0 License terms & conditions.

Official Apache Release

Download the NLPCraft release - 0.7.0 is the latest version:

File Name	Version	Release Date	Signatures
apache-nlpcraft-incubating-0.7.0.zip	0.7.0	Sep 29, 2020	SHA256 PGP
apache-nlpcraft-incubating-0.6.2.zip	0.6.2	Jul 19, 2020	SHA256 PGP
apache-nlpcraft-incubating-0.5.0.zip	0.5.0	Apr 29, 2020	SHA256 PGP

NLPCraft v0.7.0+ requires JDK 11 or newer

Starting with version 0.7.0 NLPCraft requires JDK 11+ to compile and run. All development and testing is done on JDK 11. Prior versions only supported JDK 8.

Releases marked with are NOT 100% backward compatible.

The above release files should be verified using the PGP signatures and the project release KEYS. See official ASF verification instructions for a description of using the PGP and KEYS files for verification. A SHA512 checksum is also provided as an alternative verification method.

Binary Release / Docker

Download the NLPCraft binary release - 0.7.0 is the latest version:

File Name	Version	Release Date	Signatures
apache-nlpcraft-incubating-bin-0.7.0.zip	0.7.0	Sep 29, 2020	SHA256 PGP
apache-nlpcraft-incubating-bin-0.6.2.zip	0.6.2	Jul 19, 2020	SHA256 PGP
apache-nlpcraft-incubating-bin-0.5.0.zip	0.5.0	Apr 29, 2020	SHA256 PGP

Apache Release Policy

Binary downloads are provided for the convenience of our users and are not official Apache NLPCraft releases. In order to verify the release, we recommend that you download the official source distribution and verify the signatures of the downloaded files before opening them.

See more information about Apache release policy.

Releases marked with are NOT 100% backward compatible.

Building Binaries

To build binaries from the source release download the source release and run the following commands:

Unpack the source package:

                $ unzip -q apache-nlpcraft-incubating-0.7.0.zip
                $ cd apache-nlpcraft-incubating-0.7.0

Build NLPCraft:

                $ mvn clean package -DskipTests

Built JARs and Javadoc will be located in target sub-folder.

Release Verification

We highly recommend to verify the integrity and authenticity of the ZIP archive by comparing cryptographic signatures. Following instructions assume binary release on Mac OS/Linux environment but the verification steps are similar for Windows.

Mac OS

                    # Run these two commands and compare generated hashes:
                    $ openssl dgst -sha256 apache-nlpcraft-incubating-0.7.0.zip
                    $ cat apache-nlpcraft-incubating-0.7.0.zip.sha256

                    # NOTE: make sure to have GPGTools (gpgtools.org) installed.
                    $ gpg --verify apache-nlpcraft-incubating-0.7.0.zip.asc apache-nlpcraft-incubating-0.7.0.zip

Linux

                    $ sha256sum --check apache-nlpcraft-incubating-0.7.0.zip.sha256

                    $ gpg --verify apache-nlpcraft-incubating-0.7.0.zip.asc apache-nlpcraft-incubating-0.7.0.zip

Maven/Grape/SBT

The easiest way to start using NLPCraft is to add Maven dependency (Grape, SBT, etc.) to your project. NLPCraft project consists of a single module.

                    <dependency>
                        <groupId>org.apache.nlpcraft</groupId>
                        <artifactId>nlpcraft</artifactId>
                        <version>0.7.0</version>
                    </dependency>

                    @Grab ('org.apache.nlpcraft:nlpcraft:0.7.0')

                    dependencies {
                        runtime group: 'org.apache.nlpcraft', name: 'nlpcraft', version: '0.7.0'
                    }

                    libraryDependencies += "org.apache.nlpcraft" % "nlpcraft" % "0.7.0"

Latest Version

0.7.0 is the latest version. You can replace it with a desired version.

See integration section for additional integration with Stanford CoreNLP library that is not part of the official Apache NLPCraft release.

GitHub

If you want to contribute to the project you need to get the full developer snapshot from GitHub mirror:

            $ git clone https://github.com/apache/incubator-nlpcraft.git
            $ mvn clean package

GitHub vs. Apache Release

Note that cloned GitHub repository is NOT an official Apache release and it does not come with the guarantees made by the official Apache release in terms of the licensing. GitHub repository may include content not licensed under ASL 2.0. Only the official Apache source release is guaranteed to be cleanly licensed under ASL 2.0.

Java Client

NLPCraft provides native Java Client for REST APIs. Java Client is hosted as a separate GitHub project and you can add Maven dependency (Grape, SBT, etc.) to your project to start using it:

                    <dependency>
                        <groupId>org.apache.nlpcraft</groupId>
                        <artifactId>nlpcraft-java-client</artifactId>
                        <version>0.5.0</version>
                    </dependency>

                    @Grab ('org.apache.nlpcraft:nlpcraft-java-client:0.5.0')

                    dependencies {
                        runtime group: 'org.apache.nlpcraft', name: 'nlpcraft-java-client', version: '0.5.0'
                    }

                    libraryDependencies += "org.apache.nlpcraft" % "nlpcraft-java-client" % "0.5.0"

Latest Version

0.5.0 is the latest Java Client version. You can replace it with a desired version.