WIP.
diff --git a/examples/light_switch.html b/examples/light_switch.html
index 201ce0a..6f586b6 100644
--- a/examples/light_switch.html
+++ b/examples/light_switch.html
@@ -181,18 +181,18 @@
</p>
<ul>
<li>
- On <code>line 5</code> our class extends <a href="../apis/latest/org/apache/nlpcraft/NCModelAdapter.html">NCModelAdapter</a> that allows us to pass
+ On <code>line 6</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>
- On <code>line 6</code> created model configuration with most default parameters.
+ <code>Line 7</code> creates model configuration with most default parameters.
</li>
<li>
- On <code>line 7</code> created pipeline, based on semantic model definition,
+ <code>Line 8</code> creates pipeline, based on semantic model definition,
described in <code>lightswitch_model.yaml</code> file.
</li>
<li>
- <code>Lines 10 and 11</code> annotates intents <code>ls</code> and its callback method <code>onMatch()</code>.
+ <code>Lines 10 and 11</code> annotate intents <code>ls</code> and its callback method <code>onMatch()</code>.
Intent <code>ls</code> requires one action (a token belonging to the group <code>act</code>) and optional list of light locations
(zero or more tokens with ID <code>ls:loc</code>) - by default we assume the entire house as a default location.
</li>
@@ -255,7 +255,8 @@
<code>Line 9</code> creates the client for our model.
</li>
<li>
- <code>Line 11</code> calls a special method <code>debugAsk()</code>.
+ <code>Line 11</code> calls a special method
+ <a href="../apis/latest/org/apache/nlpcraft/NCModelClient.html#debugAsk-fffff96c">debugAsk()</a>.
It allows to check the winning intent and its callback parameters without actually
calling the intent.
</li>
diff --git a/examples/light_switch_fr.html b/examples/light_switch_fr.html
index a87446f..db408f0 100644
--- a/examples/light_switch_fr.html
+++ b/examples/light_switch_fr.html
@@ -53,7 +53,7 @@
libraryDependencies += "org.apache.nlpcraft" % "nlpcraft" % "{{site.latest_version}}",
libraryDependencies += "org.apache.lucene" % "lucene-analyzers-common" % "8.11.2",
libraryDependencies += "org.languagetool" % "languagetool-core" % "5.8",
- libraryDependencies += "org.languagetool" % "language-fr" % "5.8"
+ libraryDependencies += "org.languagetool" % "language-fr" % "5.8",
libraryDependencies += "org.scalatest" %% "scalatest" % "3.2.14" % "test"
)
</pre>
@@ -67,10 +67,26 @@
<ul>
<li><code>lightswitch_model_fr.yaml</code> - YAML configuration file which contains model description.</li>
<li><code>LightSwitchFrModel.scala</code> - Model implementation.</li>
- <li><code>NCFrSemanticEntityParser.scala</code> - Semantic entity parser, custom implementation for French language.</li>
- <li><code>NCFrLemmaPosTokenEnricher.scala</code> - Lemma and point of speech token enricher, custom implementation for French language.</li>
- <li><code>NCFrStopWordsTokenEnricher.scala</code> - Stop-words token enricher, custom implementation for French language.</li>
- <li><code>NCFrTokenParser.scala</code> - Token parser, custom implementation for French language.</li>
+ <li>
+ <code>NCFrSemanticEntityParser.scala</code> - Semantic entity parser, custom implementation of
+ <a href="../apis/latest/org/apache/nlpcraft/nlp/parsers/NCSemanticEntityParser.html">NCSemanticEntityParser</a>
+ for French language.
+ </li>
+ <li>
+ <code>NCFrLemmaPosTokenEnricher.scala</code> - Lemma and point of speech token enricher, custom implementation of
+ <a href="../apis/latest/org/apache/nlpcraft/NCTokenEnricher.html">NCTokenEnricher</a>
+ for French language.
+ </li>
+ <li>
+ <code>NCFrStopWordsTokenEnricher.scala</code> - Stop-words token enricher token enricher, custom implementation of
+ <a href="../apis/latest/org/apache/nlpcraft/NCTokenEnricher.html">NCTokenEnricher</a>
+ for French language.
+ </li>
+ <li>
+ <code>NCFrTokenParser.scala</code> - Token parser, custom implementation of
+ <a href="../apis/latest/org/apache/nlpcraft/NCTokenParser.html">NCTokenParser</a>
+ for French language.
+ </li>
<li><code>LightSwitchFrModelSpec.scala</code> - Test that allows to test your model.</li>
</ul>
<pre class="brush: plain, highlight: [7, 10, 14, 17, 18, 20, 24]">
@@ -105,7 +121,7 @@
<p>
We are going to start with declaring the static part of our model using YAML which we will later load using
<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>
+ Open <code>src/main/resources/<b>lightswitch_model_fr.yaml</b></code>
file and replace its content with the following YAML:
</p>
<pre class="brush: js, highlight: [1, 10, 17, 25]">
@@ -449,7 +465,8 @@
<code>Line 9</code> creates the client for our model.
</li>
<li>
- <code>Line 11</code> calls a special method <code>debugAsk()</code>.
+ <code>Line 11</code> calls a special method
+ <a href="../apis/latest/org/apache/nlpcraft/NCModelClient.html#debugAsk-fffff96c">debugAsk()</a>.
It allows to check the winning intent and its callback parameters without actually
calling the intent.
</li>
@@ -483,10 +500,4 @@
<li><a href="#testing">Testing</a></li>
{% include quick-links.html %}
</ul>
-</div>
-
-
-
-
-
-
+</div>
\ No newline at end of file
diff --git a/examples/light_switch_ru.html b/examples/light_switch_ru.html
index ad9f1dd..61c5d6d 100644
--- a/examples/light_switch_ru.html
+++ b/examples/light_switch_ru.html
@@ -53,7 +53,7 @@
libraryDependencies += "org.apache.nlpcraft" % "nlpcraft" % "{{site.latest_version}}",
libraryDependencies += "org.apache.lucene" % "lucene-analyzers-common" % "8.11.2",
libraryDependencies += "org.languagetool" % "languagetool-core" % "5.8",
- libraryDependencies += "org.languagetool" % "language-ru" % "5.8"
+ libraryDependencies += "org.languagetool" % "language-ru" % "5.8",
libraryDependencies += "org.scalatest" %% "scalatest" % "3.2.14" % "test"
)
</pre>
@@ -67,10 +67,26 @@
<ul>
<li><code>lightswitch_model_ru.yaml</code> - YAML configuration file which contains model description.</li>
<li><code>LightSwitchRuModel.scala</code> - Model implementation.</li>
- <li><code>NCRuSemanticEntityParser.scala</code> - Semantic entity parser, custom implementation for Russian language.</li>
- <li><code>NCRuLemmaPosTokenEnricher.scala</code> - Lemma and point of speech token enricher, custom implementation for Russian language.</li>
- <li><code>NCRuStopWordsTokenEnricher.scala</code> - Stop-words token enricher, custom implementation for Russian language.</li>
- <li><code>NCRuTokenParser.scala</code> - Token parser, custom implementation for Russian language.</li>
+ <li>
+ <code>NCRuSemanticEntityParser.scala</code> - Semantic entity parser, custom implementation of
+ <a href="../apis/latest/org/apache/nlpcraft/nlp/parsers/NCSemanticEntityParser.html">NCSemanticEntityParser</a>
+ for Russian language.
+ </li>
+ <li>
+ <code>NCRuLemmaPosTokenEnricher.scala</code> - Lemma and point of speech token enricher, custom implementation of
+ <a href="../apis/latest/org/apache/nlpcraft/NCTokenEnricher.html">NCTokenEnricher</a>
+ for Russian language.
+ </li>
+ <li>
+ <code>NCRuStopWordsTokenEnricher.scala</code> - Stop-words token enricher token enricher, custom implementation of
+ <a href="../apis/latest/org/apache/nlpcraft/NCTokenEnricher.html">NCTokenEnricher</a>
+ for Russian language.
+ </li>
+ <li>
+ <code>NCRuTokenParser.scala</code> - Token parser, custom implementation of
+ <a href="../apis/latest/org/apache/nlpcraft/NCTokenParser.html">NCTokenParser</a>
+ for Russian language.
+ </li>
<li><code>LightSwitchRuModelSpec.scala</code> - Test that allows to test your model.</li>
</ul>
<pre class="brush: plain, highlight: [7, 10, 14, 17, 18, 20, 24]">
@@ -105,7 +121,7 @@
<p>
We are going to start with declaring the static part of our model using YAML which we will later load using
<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>
+ Open <code>src/main/resources/<b>lightswitch_model_ru.yaml</b></code>
file and replace its content with the following YAML:
</p>
<pre class="brush: js, highlight: [1, 8, 13, 21]">
@@ -443,7 +459,8 @@
<code>Line 9</code> creates the client for our model.
</li>
<li>
- <code>Line 11</code> calls a special method <code>debugAsk()</code>.
+ <code>Line 11</code> calls a special method
+ <a href="../apis/latest/org/apache/nlpcraft/NCModelClient.html#debugAsk-fffff96c">debugAsk()</a>.
It allows to check the winning intent and its callback parameters without actually
calling the intent.
</li>
diff --git a/examples/time.html b/examples/time.html
index 22303af..4ccdcd1 100644
--- a/examples/time.html
+++ b/examples/time.html
@@ -296,7 +296,8 @@
<code>Line 9</code> creates the client for our model.
</li>
<li>
- <code>Line 11</code> calls a special method <code>debugAsk()</code>.
+ <code>Line 11</code> calls a special method
+ <a href="../apis/latest/org/apache/nlpcraft/NCModelClient.html#debugAsk-fffff96c">debugAsk()</a>.
It allows to check the winning intent and its callback parameters without actually
calling the intent.
</li>
diff --git a/first-example.html b/first-example.html
index a92212b..f1ae623 100644
--- a/first-example.html
+++ b/first-example.html
@@ -263,7 +263,8 @@
<code>Line 9</code> creates the client for our model.
</li>
<li>
- <code>Line 11</code> calls a special method <code>debugAsk()</code>.
+ <code>Line 11</code> calls a special method
+ <a href="apis/latest/org/apache/nlpcraft/NCModelClient.html#debugAsk-fffff96c">debugAsk()</a>.
It allows to check the winning intent and its callback parameters without actually
calling the intent.
</li>
