WIP.
diff --git a/built-in-entity-parser.html b/built-in-entity-parser.html
index d918d20..0ab5dee 100644
--- a/built-in-entity-parser.html
+++ b/built-in-entity-parser.html
@@ -78,7 +78,7 @@
<h2 class="section-title">NLP Parser<a href="#"><i class="top-link fas fa-fw fa-angle-double-up"></i></a></h2>
<p>
- <a href="apis/latest/org/apache/nlpcraft/nlp/parsers/NCNLPEntityParser.html">NCNLPEntityParser</a> converts NLP tokens into entities with four mandatory properties:
+ <a href="apis/latest/org/apache/nlpcraft/nlp/parsers/NCOpenNLPTokenParser.html">NCOpenNLPTokenParser</a> converts NLP tokens into entities with four mandatory properties:
<code>nlp:token:text</code>, <code>nlp:token:index</code>, <code>nlp:token:startCharIndex</code> and
<code>nlp:token:endCharIndex</code>. However, if any other properties were added into
processed tokens by <a href="apis/latest/org/apache/nlpcraft/NCTokenEnricher.html">NCTokenEnricher</a> components, they will be copied also with names
diff --git a/examples/calculator.html b/examples/calculator.html
index 0d6be7a..251b922 100644
--- a/examples/calculator.html
+++ b/examples/calculator.html
@@ -55,8 +55,8 @@
<p><b>NOTE: </b>use the latest versions of Scala and ScalaTest.</p>
<p>Create the following files so that resulting project structure would look like the following:</p>
<ul>
- <li><code>CalculatorModel.scala</code> - Scala class, model implementation.</li>
- <li><code>CalculatorModelSpec.scala</code> - Scala tests class, which allows to test your model.</li>
+ <li><code>CalculatorModel.scala</code> - Model implementation</li>
+ <li><code>CalculatorModelSpec.scala</code> - Test that allows to test your model.</li>
</ul>
<pre class="brush: plain, highlight: [8, 12]">
| build.sbt
@@ -164,15 +164,18 @@
</li>
<li>
<code>Line 14</code> defines model pipeline based on three built-in components.
- <code>Line 21</code> defines Stanford token parser <code>NCStanfordNLPTokenParser</code>
+ <code>Line 21</code> defines Stanford token parser
+ <a href="NCStanfordNLPTokenParser">NCStanfordNLPTokenParser</a>
(we use Stanford NLP components in this example).
</li>
<li>
- <code>Line 22</code> declares entity parser <code>NCNLPEntityParser</code>
+ <code>Line 22</code> declares entity parser
+ <a href="../apis/latest/org/apache/nlpcraft/nlp/parsers/NCNLPEntityParser.html">NCNLPEntityParser</a>
which allows to find arithmetic operations notations.
</li>
<li>
- <code>Line 23</code> defines entity parser <code>NCStanfordNLPEntityParser</code>,
+ <code>Line 23</code> defines entity parser
+ <a href="NCStanfordNLPEntityParser">NCStanfordNLPEntityParser</a>,
which allows to find numerics in the text input.
</li>
<li>
diff --git a/examples/light_switch.html b/examples/light_switch.html
index 24ebdc9..201ce0a 100644
--- a/examples/light_switch.html
+++ b/examples/light_switch.html
@@ -57,9 +57,9 @@
<p><b>NOTE: </b>use the latest versions of Scala and ScalaTest.</p>
<p>Create the following files so that resulting project structure would look like the following:</p>
<ul>
- <li><code>lightswitch_model.yaml</code> - YAML configuration file, which contains model description.</li>
- <li><code>LightSwitchModel.scala</code> - Scala class, model implementation.</li>
- <li><code>LightSwitchModelSpec.scala</code> - Scala tests class, which allows to test your model.</li>
+ <li><code>lightswitch_model.yaml</code> - YAML configuration file which contains model description.</li>
+ <li><code>LightSwitchModel.scala</code> - Model implementation.</li>
+ <li><code>LightSwitchModelSpec.scala</code> - Test that allows to test your model.</li>
</ul>
<pre class="brush: plain, highlight: [7, 10, 14]">
| build.sbt
@@ -82,7 +82,7 @@
<h2 class="section-title">Data Model<a href="#"><i class="top-link fas fa-fw fa-angle-double-up"></i></a></h2>
<p>
We are going to start with declaring the static part of our model using YAML which we will later load using
- <code>NCModelAdapter</code> in our Scala-based model implementation.
+ <a href="../apis/latest/org/apache/nlpcraft/NCModelAdapter.html">NCModelAdapter</a> in our Scala-based model implementation.
Open <code>src/main/resources/<b>light_switch.yaml</b></code>
file and replace its content with the following YAML:
</p>
@@ -181,7 +181,7 @@
</p>
<ul>
<li>
- On <code>line 5</code> our class extends <code>NCModelAdapter</code> that allows us to pass
+ On <code>line 5</code> our class extends <a href="../apis/latest/org/apache/nlpcraft/NCModelAdapter.html">NCModelAdapter</a> that allows us to pass
prepared configuration and pipeline into model.
</li>
<li>
diff --git a/examples/light_switch_fr.html b/examples/light_switch_fr.html
index 3c1e41f..a87446f 100644
--- a/examples/light_switch_fr.html
+++ b/examples/light_switch_fr.html
@@ -104,7 +104,7 @@
<h2 class="section-title">Data Model<a href="#"><i class="top-link fas fa-fw fa-angle-double-up"></i></a></h2>
<p>
We are going to start with declaring the static part of our model using YAML which we will later load using
- <code>NCModelAdapter</code> in our Scala-based model implementation.
+ <a href="../apis/latest/org/apache/nlpcraft/NCModelAdapter.html">NCModelAdapter</a> in our Scala-based model implementation.
Open <code>src/main/resources/<b>light_switch_fr.yaml</b></code>
file and replace its content with the following YAML:
</p>
@@ -210,7 +210,7 @@
</p>
<ul>
<li>
- On <code>line 11</code> our class extends <code>NCModelAdapter</code> that allows us to pass
+ On <code>line 11</code> our class extends <a href="../apis/latest/org/apache/nlpcraft/NCModelAdapter.html">NCModelAdapter</a> that allows us to pass
prepared configuration and pipeline into model.
</li>
<li>
diff --git a/examples/light_switch_ru.html b/examples/light_switch_ru.html
index 109da51..ad9f1dd 100644
--- a/examples/light_switch_ru.html
+++ b/examples/light_switch_ru.html
@@ -104,7 +104,7 @@
<h2 class="section-title">Data Model<a href="#"><i class="top-link fas fa-fw fa-angle-double-up"></i></a></h2>
<p>
We are going to start with declaring the static part of our model using YAML which we will later load using
- <code>NCModelAdapter</code> in our Scala-based model implementation.
+ <a href="../apis/latest/org/apache/nlpcraft/NCModelAdapter.html">NCModelAdapter</a> in our Scala-based model implementation.
Open <code>src/main/resources/<b>light_switch_ru.yaml</b></code>
file and replace its content with the following YAML:
</p>
@@ -207,7 +207,7 @@
</p>
<ul>
<li>
- On <code>line 11</code> our class extends <code>NCModelAdapter</code> that allows us to pass
+ On <code>line 11</code> our class extends <a href="../apis/latest/org/apache/nlpcraft/NCModelAdapter.html">NCModelAdapter</a> that allows us to pass
prepared configuration and pipeline into model.
</li>
<li>
diff --git a/examples/pizzeria.html b/examples/pizzeria.html
index 687343b..6fb9401 100644
--- a/examples/pizzeria.html
+++ b/examples/pizzeria.html
@@ -59,8 +59,8 @@
<li><code>PizzeriaModel.scala</code> - Model implementation.</li>
<li><code>PizzeriaOrder.scala</code> - Pizza order state representation.</li>
<li><code>PizzeriaModelPipeline.scala</code> - Model pipeline definition class.</li>
- <li><code>PizzeriaOrderMapper.scala</code> - <code>NCEntityMapper</code> custom implementation.</li>
- <li><code>PizzeriaOrderValidator.scala</code> - <code>NCEntityValidator</code> custom implementation.</li>
+ <li><code>PizzeriaOrderMapper.scala</code> - <a href="../apis/latest/org/apache/nlpcraft/NCEntityMapper.html">NCEntityMapper</a> custom implementation.</li>
+ <li><code>PizzeriaOrderValidator.scala</code> - <a href="../apis/latest/org/apache/nlpcraft/NCEntityValidator.html">NCEntityValidator</a>> custom implementation.</li>
<li><code>PizzeriaModelSpec.scala</code> - Test that allows to test your model.</li>
</ul>
<pre class="brush: plain, highlight: [7, 11, 12, 13, 14, 15, 19]">
@@ -89,7 +89,7 @@
<h2 class="section-title">Data Model<a href="#"><i class="top-link fas fa-fw fa-angle-double-up"></i></a></h2>
<p>
We are going to start with declaring the static part of our model using YAML which we will later load using
- <code>NCModelAdapter</code> in our Scala-based model implementation.
+ <a href="../apis/latest/org/apache/nlpcraft/NCModelAdapter.html">NCModelAdapter</a> custom implementation.</li> in our Scala-based model implementation.
Open <code>src/main/resources/<b>pizzeria_model.yaml</b></code>
file and replace its content with the following YAML:
</p>
@@ -391,14 +391,14 @@
<ul>
<li>
<code>Line 12</code> declares <code>PizzeriaExtractors</code> helper object which provides
- conversion methods from <code>NCEntity</code> objects and model data objects.
+ conversion methods from <a href="../apis/latest/org/apache/nlpcraft/NCEntity.html">NCEntity</a> objects and model data objects.
</li>
<li>
<code>Line 27</code> defines <code>PizzeriaModel</code> companion object which contains
static content and helper methods.
</li>
<li>
- On <code>line 114</code> our class <code>PizzeriaModel</code> extends <code>NCModelAdapter</code> that allows us to pass
+ On <code>line 114</code> our class <code>PizzeriaModel</code> extends <a href="../apis/latest/org/apache/nlpcraft/NCModelAdapter.html">NCModelAdapter</a> that allows us to pass
prepared configuration and pipeline into the model.
</li>
<li>
@@ -467,7 +467,7 @@
</pre>
<p>
- <code>PizzeriaOrderValidator</code> is implementation of <code>NCEntityValidator</code>.
+ <code>PizzeriaOrderValidator</code> is implementation of <a href="../apis/latest/org/apache/nlpcraft/NCEntityValidator.html">NCEntityValidator</a>.
It is designed for validation order content that allows to reject invalid orders right away.
<p>
@@ -540,7 +540,7 @@
</pre>
<p>
- <code>PizzeriaOrderMapper</code> is implementation of <code>NCEntityMapper</code>.
+ <code>PizzeriaOrderMapper</code> is implementation of <a href="../apis/latest/org/apache/nlpcraft/NCEntityMapper.html">NCEntityMapper</a>.
It is designed for complex compound entities building based on another entities.
<p>
<ul>
@@ -549,7 +549,7 @@
helper methods.
</li>
<li>
- <code>Line 25</code> defines <code>PizzeriaOrderMapper</code> model which implements <code>NCEntityMapper</code>.
+ <code>Line 25</code> defines <code>PizzeriaOrderMapper</code> model which implements <a href="../apis/latest/org/apache/nlpcraft/NCEntityMapper.html">NCEntityMapper</a>.
</li>
<li>
<code>Line 30</code> defines helper method <code>map()</code> which clones <code>destEn</code> entity,
@@ -619,7 +619,7 @@
<code>Line 14</code> defines the pipeline.
</li>
<li>
- <code>Line 30</code> declares <code>NCSemanticEntityParser</code>
+ <code>Line 30</code> declares <a href="../apis/latest/org/apache/nlpcraft/nlp/parsers/NCSemanticEntityParser.html">NCSemanticEntityParser</a>
which is based on YAM model definition <code>pizzeria_model.yaml</code>.
</li>
<li>
diff --git a/examples/time.html b/examples/time.html
index 5b57a63..e854521 100644
--- a/examples/time.html
+++ b/examples/time.html
@@ -62,7 +62,7 @@
<li><code>GeoManager.scala</code> - Helper service which provides cities timezones information for user request.</li>
<li><code>TimeModelSpec.scala</code> - Test that allows to test your model.</li>
</ul>
- <pre class="brush: plain, highlight: [7, 10, 14]">
+ <pre class="brush: plain, highlight: [7, 8, 13, 15, 16, 20]">
| build.sbt
+--project
| build.properties
@@ -89,11 +89,11 @@
<h2 class="section-title">Data Model<a href="#"><i class="top-link fas fa-fw fa-angle-double-up"></i></a></h2>
<p>
We are going to start with declaring the static part of our model using YAML which we will later load using
- <code>NCModelAdapter</code> in our Scala-based model implementation.
+ <a href="../apis/latest/org/apache/nlpcraft/NCModelAdapter.html">NCModelAdapter</a> in our Scala-based model implementation.
Open <code>src/main/resources/<b>time.yaml</b></code>
file and replace its content with the following YAML:
</p>
- <pre class="brush: js, highlight: [1, 10, 17, 25]">
+ <pre class="brush: js, highlight: [1, 6]">
macros:
"<OF>": "{of|for|per}"
"<CUR>": "{current|present|now|local}"
@@ -114,7 +114,7 @@
</li>
<li>
<code>Line 6</code> defines <code>x:time</code> model element which
- will be used in our intent, defined in <code>TimeModel</code> class. Note that this model
+ is used in our intent defined in <code>TimeModel</code> class. Note that this model
element is defined mostly through macros we have defined above.
</li>
</ul>
@@ -213,7 +213,7 @@
</p>
<ul>
<li>
- On <code>line 19</code> our class extends <code>NCModelAdapter</code> that allows us to pass
+ On <code>line 19</code> our class extends <a href="../apis/latest/org/apache/nlpcraft/NCModelAdapter.html">NCModelAdapter</a> that allows us to pass
prepared configuration and pipeline into model.
</li>
<li>
@@ -227,10 +227,12 @@
<code>Line 20</code> creates model configuration with most default parameters.
</li>
<li>
- <code>Line 21</code> creates pipeline based on built-in components.
+ <code>Line 21</code> creates pipeline based on built-in components:
<ul>
- <li>This pipeline is based on built-in EN semantic entity enricher configured with <code>time_model.yaml</code>.</li>
- <li>Also there is entity parser <code>NCOpenNLPEntityParser</code>
+ <li>Built-in English language
+ <a href="../apis/latest/org/apache/nlpcraft/nlp/parsers/NCSemanticEntityParser.html">NCSemanticEntityParser</a>
+ configured with <code>time_model.yaml</code>.</li>
+ <li>Entity parser <a href="../apis/latest/org/apache/nlpcraft/nlp/parsers/NCOpenNLPTokenParser.html">NCOpenNLPTokenParser</a>
configured by <code>opennlp/en-ner-location.bin</code> for GEO locations detection.
</li>
</ul>
@@ -300,7 +302,7 @@
You can run this test via SBT task <code>executeTests</code> or using IDE.
</p>
<pre class="brush: scala, highlight: []">
- PS C:\apache\incubator-nlpcraft-examples\time> sbt executeTests
+ sbt executeTests
</pre>
</section>
<section>
