You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nlpcraft.apache.org by ar...@apache.org on 2020/12/01 21:15:17 UTC

[incubator-nlpcraft] branch master updated: "semantic" word clarification.

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 c03a04a  "semantic" word clarification.
c03a04a is described below

commit c03a04ae5a9498dd1afa3c5f646a77bfcd97c86d
Author: Aaron Radzinski <ar...@datalingvo.com>
AuthorDate: Tue Dec 1 13:15:00 2020 -0800

    "semantic" word clarification.
---
 README.md                                               | 17 ++++++++---------
 .../scala/org/apache/nlpcraft/model/NCCustomParser.java |  2 +-
 .../main/scala/org/apache/nlpcraft/model/NCElement.java |  2 +-
 .../main/scala/org/apache/nlpcraft/model/NCModel.java   |  2 +-
 .../scala/org/apache/nlpcraft/model/NCModelView.java    |  4 ++--
 5 files changed, 13 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 49ce72b..575b741 100644
--- a/README.md
+++ b/README.md
@@ -24,8 +24,7 @@
 [![Gitter](https://badges.gitter.im/apache-nlpcraft/community.svg)](https://gitter.im/apache-nlpcraft/community)
 
 ## What is Apache NLPCraft?
-[Apache NLPCraft](https://nlpcraft.apache.org/) is an open source library for adding a natural language interface to any applications. 
-Based on semantic modelling it allows rapid implementation and requires no model training or pre-existing text corpora:
+[Apache NLPCraft](https://nlpcraft.apache.org/) is an open source library for adding a natural language interface for modern applications: 
 
  * Download, Maven/Grape/Gradle/SBT, installation [instructions](https://nlpcraft.apache.org/download.html) 
  * Read [documentation](https://nlpcraft.apache.org/docs.html)
@@ -41,11 +40,11 @@ Natural Language Interface (NLI) enables users to explore any type of data sourc
 There is no learning curve, no special rules or UI to master, no cumbersome syntax or terms to remember - just a natural language that your users already speak.
  
 ## Key Features
-### Semantic Modeling
-Advanced semantic modelling and intent-based matching enables deterministic natural language understanding without requiring deep learning training or pre-existing text corpora.
+### Programmable Intents
+Fully programmable, advanced intent DSL with deterministic matching provides easy to use and expressive mechanism for a complex intent logic.
 
-### Any Data Source
-Any data source, device, or service - public or private. From databases and SaaS systems, to smart home devices, voice assistants and chatbots.
+### Short-Term-Memory
+Advanced out-of-the-box support for maintaining and managing conversational context that is fully integrated with intent matching.
  
 ### English Focused
 NLPCraft focuses on processing English language delivering the ease of use and unparalleled comprehension for the language spoken by more than a billion people.
@@ -53,9 +52,9 @@ NLPCraft focuses on processing English language delivering the ease of use and u
 ### By Devs - For Devs
 Built with a singular focus - provide developers with unprecedented productivity and efficiency when building  modern NLI applications.
 
-### Advanced NLP Toolset
-Combines ease-of-use and development productivity with state-of-the-art NLP capabilities like short-term-memory (STM) support, advanced intent DSL with deterministic matching, and composable NEs.
-                        
+### Composable Named Entities
+Compose new reusable Named Entities out of existing internal or external ones, build new ones and mix and match using comprehensive DSL.
+                       
 ### Java-First
 REST API and Java-based implementation natively supports the world's largest ecosystem of development tools, multiple programming languages, frameworks and services.
 
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCCustomParser.java b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCCustomParser.java
index 3f539d7..f096ce0 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCCustomParser.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCCustomParser.java
@@ -24,7 +24,7 @@ import java.util.*;
  * Named Entity Recognizer (NER) implementation in cases when the standard declarative methods are not expressive
  * enough. Instance of the parser should be made available in the model via {@link NCModel#getParsers()} method.
  * <p>
- * By default the semantic data model detects its elements by their declarative synonyms. However,
+ * By default the data model detects its elements by their declarative synonyms. However,
  * in some cases this is not expressive enough. In such cases, one or more user-defined parsers can be defined
  * for the model that would allow the user to define its own NER logic to detect the model elements in the user
  * input programmatically. Note that there can be multiple custom parsers per model and each one can detect
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCElement.java b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCElement.java
index 39de184..cfb0506 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCElement.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCElement.java
@@ -268,7 +268,7 @@ public interface NCElement extends NCMetadata, Serializable {
     }
 
     /**
-     * Gets the list of synonyms by which this semantic element will be recognized by. Read more about
+     * Gets the list of synonyms by which this model element will be recognized by. Read more about
      * many different forms of synonyms in <a target=_ href="https://nlpcraft.apache.org/data-model.html">Data Model</a> section
      * and review <a target=_ href="https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/">examples</a>.
      * <p>
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCModel.java b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCModel.java
index 7d01f2d..7b4c39b 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCModel.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCModel.java
@@ -18,7 +18,7 @@
 package org.apache.nlpcraft.model;
 
 /**
- * User-defined semantic data model.
+ * User-defined data model.
  * <p>
  * Data model is a central concept in NLPCraft defining an interface to your data sources
  * like a database or a SaaS application. NLPCraft employs model-as-a-code approach where entire data model
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCModelView.java b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCModelView.java
index 26b142a..f82a0ce 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCModelView.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCModelView.java
@@ -811,7 +811,7 @@ public interface NCModelView extends NCMetadata {
      * Gets optional user-defined model element parsers for custom NER implementations. Note that order of the parsers
      * is important as they will be invoked in the same order they are returned.
      * <p>
-     * By default the semantic data model detects its elements by their synonyms, regexp or DSL expressions. However,
+     * By default the data model detects its elements by their synonyms, regexp or DSL expressions. However,
      * in some cases these methods are not expressive enough. In such cases, a user-defined parser can be defined
      * for the model that would allow the user to define its own NER logic to detect the model elements in the user
      * input programmatically. Note that there can be only one custom parser per model and it can detect any number
@@ -839,7 +839,7 @@ public interface NCModelView extends NCMetadata {
     /**
      * Gets a set of model elements or named entities. Model can have zero or more user defined elements.
      * <p>
-     * An element is the main building block of the semantic model. Data model element defines a named entity
+     * An element is the main building block of the model. Data model element defines a named entity
      * that will be automatically recognized in the user input. See also {@link NCModel#getParsers()} method on how
      * to provide programmatic named entity recognizer (NER) implementations.
      * <p>