This is an automated email from the ASF dual-hosted git repository.
aradzinski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft.git
The following commit(s) were added to refs/heads/master by this push:
new 67a9a1e WIP.
67a9a1e is described below
commit 67a9a1e48671111f9794c35973828a7a75de2797
Author: Aaron Radzinski <[email protected]>
AuthorDate: Mon Oct 4 21:39:18 2021 -0700
WIP.
---
README.md | 197 +-----------------------------------------------------
openapi/README.md | 1 +
pom.xml | 2 +-
3 files changed, 3 insertions(+), 197 deletions(-)
diff --git a/README.md b/README.md
index b85a766..31b4ebe 100644
--- a/README.md
+++ b/README.md
@@ -26,7 +26,7 @@
## What is Apache NLPCraft?
[Apache NLPCraft](https://nlpcraft.apache.org/) is an open source library for
adding a natural language interface
for modern applications. It enables people to interact with your products
using voice
-or text:
+or text. Make sure to use stable branch **master-0.9.1**:
* [Instructions](https://nlpcraft.apache.org/download.html) for download,
Maven/Grape/Gradle/SBT, build and installation
* Read [documentation](https://nlpcraft.apache.org/docs.html), latest
[Javadoc](https://nlpcraft.apache.org/apis/latest/index.html) and [REST
APIs](https://nlpcraft.apache.org/using-rest.html)
@@ -35,201 +35,6 @@ or text:
* Post a question at [Stack
Overflow](https://stackoverflow.com/questions/ask) using <code>nlpcraft</code>
tag
* Join project developers on
[[email protected]](mailto:[email protected])
-## Why Natural Language?
-Natural Language Interface enables users to interact with any type of products
-using natural language augmenting existing UI/UX with fidelity and simplicity
of a familiar spoken language.
-Natural Language has no learning curve, no special rules or UI to master, no
cumbersome syntax or
-terms to remember - it's just a natural interface that your users already know.
-
-## Key Features
-### Intent Definition Language
-Advanced Intent Definition Language (IDL) coupled with deterministic intent
matching
-provide ease of use and unprecedented expressiveness for designing real-life,
non-trivial intents.
-
-### Composable Named Entities
-Easily compose, mix and match new named entities out of built-in or external
ones, creating new
-reusable named entity recognizers on the fly.
-
-### Short-Term-Memory
-Advanced out-of-the-box support for maintaining and managing conversational
context that is fully integrated with intent matching.
-
-### Model-As-A-Code
-Everything you do with NLPCraft is part of your source code. No more awkward
web UIs
-splitting your logic across different incompatible places. Model-as-a-code is
built by
-engineers, and it reflects how engineers work.
-
-### By Devs - For Devs
-Built with a singular focus - provide state-of-the-art developers with
unprecedented productivity and efficiency when building
-modern natural language applications.
-
-### Java-First
-REST API and Java-based implementation natively supports the world's largest
ecosystem of development tools, multiple programming languages, frameworks and
services.
-
-<a target=_ href="https://www.oracle.com/java/";><img
src="https://nlpcraft.apache.org/images/java2.png"; height="32px" alt=""></a>
-<a target=_ href="https://scala-lang.org/";><img
src="https://nlpcraft.apache.org/images/scala-logo.png"; height="24px"
alt=""></a>
-<a target=_ href="https://groovy-lang.org/";><img
src="https://nlpcraft.apache.org/images/groovy.png"; height="32px" alt=""></a>
-<a target=_ href="https://kotlinlang.org/";><img
src="https://nlpcraft.apache.org/images/kotlin.png"; height="32px" alt=""></a>
-
-### Out-Of-The-Box Integration
-NLPCraft natively integrates with 3rd party libraries for base NLP processing
and named entity recognition:
-
-<a target=_ href="https://opennlp.apache.org";><img
src="https://nlpcraft.apache.org/images/opennlp-logo.png"; height="32px"
alt=""></a>
-<a target=_ href="https://cloud.google.com/natural-language/";><img
src="https://nlpcraft.apache.org/images/google-cloud-logo-small.png";
height="32px" alt=""></a>
-<a target=_ href="https://stanfordnlp.github.io/CoreNLP";><img
src="https://nlpcraft.apache.org/images/corenlp-logo.gif"; height="48px"
alt=""></a>
-<a target=_ href="https://spacy.io";><img
src="https://nlpcraft.apache.org/images/spacy-logo.png"; height="32px"
alt=""></a>
-
-[Learn more >](https://nlpcraft.apache.org/docs.html)
-
-## How It Works
-When using NLPCraft you will be dealing with three main components:
-
-<img src="https://nlpcraft.apache.org/images/homepage-fig1.1.png"; alt="ASF
Logo">
-
-**Data model** specifies how to interpret user input, how to query a data
source, and how to format the result back. Developers use model-as-a-code
approach to build models using any JVM language like Java, Scala, Groovy or
Kotlin.
-
-**Data probe** is a DMZ-deployed application designed to securely deploy and
manage data models. Each probe can manage multiple models, and you can have
many probes.
-
-**REST server** provides REST endpoint for user applications to securely query
data sources using NLI via data models deployed in data probes.
-
-[Learn more >](https://nlpcraft.apache.org/docs.html)
-
-## Example
-As a quick example let's consider a very simple implementation for NLI-powered
light switch. Our app should understand something like
-``Turn the lights off in the entire house`` or ``Switch on the illumination in
the master bedroom closet``. You can easily
-modify intent callbacks in the model implementation below to perform the
actual light switching using HomeKit or Arduino-based controllers.
-
-### Add NLPCraft
-Add NLPCraft dependency to your project:
-```xml
-<dependencies>
- <dependency>
- <groupId>org.apache.nlpcraft</groupId>
- <artifactId>nlpcraft</artifactId>
- <version>0.9.0</version>
- </dependency>
-</dependencies>
-```
-NOTE: **0.9.0** should be the latest NLPCraft version.
-
-### Define Data Model
-Declare the static part of the data model using YAML which we will later load
in our model implementation. You can declare entire
-model in the code - but doing it with JSON or YAML is usually more productive:
-```yaml
-id: "nlpcraft.lightswitch.ex"
-name: "Light Switch Example Model"
-version: "1.0"
-description: "NLI-powered light switch example model."
-macros:
- - name: "<ACTION>"
- macro: "{turn|switch|dial|let|set|get|put}"
- - name: "<KILL>"
- macro: "{shut|kill|stop|eliminate}"
- - name: "<ENTIRE_OPT>"
- macro: "{entire|full|whole|total|_}"
- - name: "<FLOOR_OPT>"
- macro: "{upstairs|downstairs|{1st|2nd|3rd|4th|5th|top|ground} floor|_}"
- - name: "<TYPE>"
- macro: "{room|closet|attic|loft|{store|storage} {room|_}}"
- - name: "<LIGHT>"
- macro: "{all|_} {it|them|light|illumination|lamp|lamplight}"
-enabledBuiltInTokens: [] # This example doesn't use any built-in tokens.
-
-#
-# Allows for multi-word synonyms in this entire model
-# to be sparse and permutate them for better detection.
-# These two properties generally enable a free-form
-# natural language comprehension.
-#
-permutateSynonyms: true
-sparse: true
-
-elements:
- - id: "ls:loc"
- description: "Location of lights."
- synonyms:
- - "<ENTIRE_OPT> <FLOOR_OPT>
{kitchen|library|closet|garage|office|playroom|{dinning|laundry|play} <TYPE>}"
- - "<ENTIRE_OPT> <FLOOR_OPT> {master|kid|children|child|guest|_}
{bedroom|bathroom|washroom|storage} {<TYPE>|_}"
- - "<ENTIRE_OPT> {house|home|building|{1st|first} floor|{2nd|second} floor}"
-
- - id: "ls:on"
- groups:
- - "act"
- description: "Light switch ON action."
- synonyms:
- - "<ACTION> {on|up|_} <LIGHT> {on|up|_}"
- - "<LIGHT> {on|up}"
-
- - id: "ls:off"
- groups:
- - "act"
- description: "Light switch OFF action."
- synonyms:
- - "<ACTION> <LIGHT> {off|out}"
- - "{<ACTION>|<KILL>} {off|out} <LIGHT>"
- - "<KILL> <LIGHT>"
- - "<LIGHT> <KILL>"
- - "no <LIGHT>"
-
-intents:
- - "intent=ls term(act)={has(tok_groups, 'act')} term(loc)={# == 'ls:loc'}*"
-```
-
-### Model Implementation
-Once we have model declaration we can provide implementation for intent
callbacks. We'll use Scala to
-implement the data model, but you can use any JVM-based language like Java,
Groovy, or Kotlin:
-```scala
-package org.apache.nlpcraft.examples.lightswitch
-
-import org.apache.nlpcraft.model.{NCIntentTerm, _}
-
-class LightSwitchScalaModel extends
NCModelFileAdapter("lightswitch_model.yaml") {
- @NCIntentRef("ls")
- @NCIntentSample(Array(
- "Turn the lights off in the entire house.",
- "Turn off all lights now",
- "Switch on the illumination in the master bedroom closet.",
- "Get the lights on.",
- "Lights up in the kitchen.",
- "Please, put the light out in the upstairs bedroom.",
- "Set the lights on in the entire house.",
- "Turn the lights off in the guest bedroom.",
- "Could you please switch off all the lights?",
- "Dial off illumination on the 2nd floor.",
- "Please, no lights!",
- "Kill off all the lights now!",
- "No lights in the bedroom, please.",
- "Light up the garage, please!",
- "Kill the illumination now!"
- ))
- def onMatch(
- @NCIntentTerm("act") actTok: NCToken,
- @NCIntentTerm("loc") locToks: List[NCToken]
- ): NCResult = {
- val status = if (actTok.getId == "ls:on") "on" else "off"
- val locations =
- if (locToks.isEmpty)
- "entire house"
- else
- locToks.map(_.getOriginalText).mkString(", ")
-
- // Add HomeKit, Arduino or other integration here.
-
- // By default - just return a descriptive action string.
- NCResult.text(s"Lights are [$status] in [${locations.toLowerCase}].")
- }
-}
-
-```
-NOTES:
- - We are loading our static model declaration that we've defined above using
`NCModelFileAdapter` base class.
- - Annotation `@NCIntentRef` references the intent defined in our YAML model
definition.
- - We use `@NCIntentSample` to provide sample sentences that should satisfy
this intent. These
- samples are used for model auto-testing and synonyms analysis.
-
-Done! 👌
-
-[Learn more about this example
>](https://nlpcraft.apache.org/examples/light_switch.html)
-
## Copyright
Copyright (C) 2021 Apache Software Foundation
diff --git a/openapi/README.md b/openapi/README.md
index 3ebeb0d..b29cef3 100644
--- a/openapi/README.md
+++ b/openapi/README.md
@@ -25,6 +25,7 @@
### REST API
For more REST API information:
+ * Make sure to use stable branch **master-0.9.1**:
* Test and explore REST API at
[SwaggerHub](https://app.swaggerhub.com/apis-docs/Apache-NLPCraft/apache-nlpcraft)
* Learn more on how to [use REST
API](https://nlpcraft.apache.org/using-rest.html)
diff --git a/pom.xml b/pom.xml
index 728b3e0..25713ab 100644
--- a/pom.xml
+++ b/pom.xml
@@ -99,7 +99,7 @@
<jline.ver>3.20.0</jline.ver>
<commons.lang3.ver>3.12.0</commons.lang3.ver>
<scala3.ref.ver>1.0.0</scala3.ref.ver>
- <junit.ver>5.7.2</junit.ver>
+ <junit.ver>5.8.1</junit.ver>
<scalatest.ver>3.2.9</scalatest.ver>
<!-- Force specific encoding on text resources. -->
![https://nlpcraft.apache.org/images/java2.png"](https://nlpcraft.apache.org/images/java2.png"){kind=link}
![https://nlpcraft.apache.org/images/scala-logo.png"](https://nlpcraft.apache.org/images/scala-logo.png"){kind=link}
![https://nlpcraft.apache.org/images/groovy.png"](https://nlpcraft.apache.org/images/groovy.png"){kind=link}
![https://nlpcraft.apache.org/images/kotlin.png"](https://nlpcraft.apache.org/images/kotlin.png"){kind=link}
![https://nlpcraft.apache.org/images/opennlp-logo.png"](https://nlpcraft.apache.org/images/opennlp-logo.png"){kind=link}
![https://nlpcraft.apache.org/images/google-cloud-logo-small.png"](https://nlpcraft.apache.org/images/google-cloud-logo-small.png"){kind=link}
![https://nlpcraft.apache.org/images/corenlp-logo.gif"](https://nlpcraft.apache.org/images/corenlp-logo.gif"){kind=link}
![https://nlpcraft.apache.org/images/spacy-logo.png"](https://nlpcraft.apache.org/images/spacy-logo.png"){kind=link}
![https://nlpcraft.apache.org/images/homepage-fig1.1.png"](https://nlpcraft.apache.org/images/homepage-fig1.1.png"){kind=link}