• Docs
  • Resources
  • Community
  • Use Cases
  • Downloads
  • v.0.9.0
  • GitHub
  1. Home
  2. Docs

Docs

  • Developer Guide
  • Overview
  • Installation
  • First Example
  • Data Model
  • Intent Matching
  • Short-Term Memory
  • Server & Probe
  • Metrics & Tracing
  • Integrations
  • REST API
  • Tools
  • nlpcraft.{sh|cmd}
  • Test Framework
  • Embedded Probe
  • SQL Model Generator
  • Synonyms Tool
  • Examples
  • Alarm Clock
  • Light Switch
  • Weather Bot
  • SQL Model

TL;DR;

Watch this quick video (6:17) on how to download, install and verify your installation:

Installation

Apache NLPCraft requires no special installation operations:

  • If you downloaded binary ZIP archive - verify it and unzip it
  • If you cloned GitHub repository or downloaded source archive - use mvn clean package -P examples to build it
  • If you used Maven/Gradle/SBT - you know what you are doing...

You are done 👍

Minimal Java and Scala versions

Starting with version 0.9.0 NLPCraft requires JDK 11+ and Scala 2.13.
Starting with version 0.7.0 NLPCraft requires JDK 11+ and Scala 2.12.
Prior versions supported JDK 8 and Scala 2.12.

Reset Database

For releases marked with you need to reset the existing database. If you are using the Apache Ignite storage (default configuration for NLPCraft) you can accomplish this by removing ${USER_HOME}/.nlpcraft/ignite folder.

If you are using other storage engines (e.g. Postgres or MySQL) you need to follow their specific procedures to recreate the database using SQL scripts from sql sub-folder in NLPCraft installation directory.

External Configuration

Due to Apache release policy the official Apache release cannot include content that is based on Commons Attribution 4.0 International (CC BY 4.0) license or any binary artifacts regardless of their respective licences. Due to these restrictions the official Apache NLPCraft release does not include certain configuration files that are necessary for its operation. These files will be auto-downloaded upon first star of NLPCraft (hence the internet connection is required for the first start). On subsequent starts the NLPCraft will check for the updates and will re-download these files only if they were changed.

By default, this external configuration is hosted on GitHub (in external_config branch of NLPCraft project) from where it will be automatically downloaded on the first start: https://github.com/apache/incubator-nlpcraft/raw/external_config/external. You can change this location, e.g. move the external configuration behind your firewall or onto your local file system, as well as change other parameters related to auto-download of the external configuration in *.conf file (see nlpcraft.extConfig property).

Apache Ignite 2.x & Java 11+

Starting with NLPCraft 0.7.0, NLPCraft requires JDK 11 as its minimum JDK version. NLPCraft uses Apache Ignite 2.x project as its underlying in-memory distributed storage and cluster computing framework. When running Apache Ignite 2.x on Java 11 you need to follow these instructions which are automatically followed when you use nlpcraft.{sh|cmd} script.

NOTE: It is NOT recommended to change the version of Apache Ignite inside NLPCraft project.


  • On This Page
  • Installation
  • Reset Database
  • External Config
  • Apache Ignite
  • Quick Links
  • Examples
  • Javadoc
  • REST API
  • Download
  • Cheat Sheet
  • News & Events
  • Support
  • JIRA
  • Dev List
  • Stack Overflow
  • GitHub
  • Gitter
  • Twitter
  • YouTube
Copyright © 2021 Apache Software Foundation asf Events • Privacy • News • Docs release: 0.9.0 Gitter Built in: