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 2021/01/04 04:10:04 UTC
[incubator-nlpcraft-website] branch master updated: Various fixes.
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-website.git
The following commit(s) were added to refs/heads/master by this push:
new 54bf63b Various fixes.
54bf63b is described below
commit 54bf63b5c16ca0d7a8e689b6c78e69dd9db0616b
Author: Aaron Radzinski <ar...@datalingvo.com>
AuthorDate: Sun Jan 3 20:09:52 2021 -0800
Various fixes.
---
community.html | 21 +++----
data-model.html | 139 +++++++++++++++++++++++------------------------
docs.html | 2 +-
index.html | 13 +++--
integrations.html | 33 +++++------
intent-matching.html | 62 ++++++++++++++++++---
metrics-and-tracing.html | 14 ++---
7 files changed, 166 insertions(+), 118 deletions(-)
diff --git a/community.html b/community.html
index bbb2866..16396c2 100644
--- a/community.html
+++ b/community.html
@@ -31,7 +31,8 @@ layout: interior
<li><a href="/docs.html">Overview</a></li>
<li><a href="/installation.html">Installation</a></li>
<li><a href="/getting-started.html">Getting Started</a></li>
- <li class="side-nav-title"><img src="{{ 'images/asf_logo.png' | relative_url }}" alt="" height="36px"></li>
+ <li class="side-nav-title"><!--suppress CheckImageSize -->
+ <img src="/images/asf_logo.png" alt="" height="36px"></li>
<li><a target="asf" href="https://www.apache.org/">Foundation</a></li>
<li><a target="asf" href="https://www.apache.org/licenses/">License</a></li>
<li><a target="asf" href="https://www.apache.org/security">Security</a></li>
@@ -259,7 +260,7 @@ layout: interior
</p>
</section>
<section id="pmc">
- <h2 class="section-title">Committers <amp>&</amp> PMC</h2>
+ <h2 class="section-title">Committers <span class="amp">&</span> PMC</h2>
<p>
Visit the <a target="github" href="https://github.com/apache/incubator-nlpcraft/graphs/contributors">Apache NLPCraft Contributors</a> page to
see a list of top contributors and committers for the main project.
@@ -288,27 +289,27 @@ layout: interior
<tr>
<td>Evans Ye</td>
<td>Trend Micro</td>
- <td><center><i class="fas fa-check"></i></center></td>
+ <td style="text-align: center;"><i class="fas fa-check"></i></td>
</tr>
<tr>
<td>Konstantin Boudnik</td>
<td>Apache Software Foundation</td>
- <td><center><i class="fas fa-check-double"></i></center></td>
+ <td style="text-align: center;"><i class="fas fa-check-double"></i></td>
</tr>
<tr>
<td>Furkan Kamaci</td>
<td></td>
- <td><center><i class="fas fa-check"></i></center></td>
+ <td style="text-align: center;"><i class="fas fa-check"></i></td>
</tr>
<tr>
<td>Nikita Ivanov</td>
<td>GridGain Systems, Apache Ignite</td>
- <td><center><i class="fas fa-check"></i></center></td>
+ <td style="text-align: center;"><i class="fas fa-check"></i></td>
</tr>
<tr>
<td>Paul King</td>
<td></td>
- <td><center><i class="fas fa-check"></i></center></td>
+ <td style="text-align: center;"><i class="fas fa-check"></i></td>
</tr>
<tr>
<td>Sergey Makov</td>
@@ -318,7 +319,7 @@ layout: interior
<tr>
<td>Roman Shaposhnik</td>
<td>Pivotal</td>
- <td><center><i class="fas fa-check"></i></center></td>
+ <td style="text-align: center;"><i class="fas fa-check"></i></td>
</tr>
<tr>
<td>Sergey Kamov</td>
@@ -328,7 +329,7 @@ layout: interior
<tr>
<td>Dave Fisher</td>
<td></td>
- <td><center><i class="fas fa-check"></i></center></td>
+ <td style="text-align: center;"><i class="fas fa-check"></i></td>
</tr>
<tr>
<td>Gleb Ifropc</td>
@@ -391,7 +392,7 @@ layout: interior
<ul class="side-nav">
<li class="side-nav-title">On This Page</li>
<li><a href="#start">Start Contributing</a></li>
- <li><a href="#pmc">Committers <amp>&</amp> PMC</a></li>
+ <li><a href="#pmc">Committers <span class="amp">&</span> PMC</a></li>
<li><a href="#resources">Resources</a></li>
{% include quick-links.html %}
</ul>
diff --git a/data-model.html b/data-model.html
index 695530f..b2a6e85 100644
--- a/data-model.html
+++ b/data-model.html
@@ -245,9 +245,9 @@ public class AlarmModel extends NCModelFileAdapter {
defaults for most of its methods. These are the only methods that need to be implemented by its sub-class:
</p>
<ul>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getId--">getId()</a></li>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getName--">getName()</a></li>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getVersion--">getVersion()</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getId()">getId()</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getName()">getName()</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getVersion()">getVersion()</a></li>
</ul>
<p>
You can either implement <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModel.html">NCModel</a>
@@ -290,49 +290,49 @@ public class AlarmModel extends NCModelFileAdapter {
</p>
<h3 class="section-title">Callbacks</h3>
<p>
- There are two callbacks on
+ There are two lifecycle callbacks on
<a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModel.html">NCModel</a> interface
- (by way of extending <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCLifecycle.html">NCLifecycle</a> interface) that you can optionally override to affect the the default lifecycle behavior:
+ (by way of extending <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCLifecycle.html">NCLifecycle</a> interface) that you can override to affect the the default lifecycle behavior:
</p>
<ul>
<li>
- <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCLifecycle.html#onInit--">onInit()</a> - called
+ <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCLifecycle.html#onInit()">onInit()</a> - called
right after the model was loaded and deployed.
</li>
<li>
- <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCLifecycle.html#onDiscard--">onDiscard()</a> - called to
+ <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCLifecycle.html#onDiscard()">onDiscard()</a> - called to
discard the data model when and only when data probe is orderly shutting down.
</li>
</ul>
<p>
- Note that there are also several callbacks that you can override to affect model behavior
+ There are also several callbacks that you can override to affect model behavior during intent matching
to perform logging, debugging, statistic or usage collection, explicit update or initialization of
conversation context, security audit or validation:
</p>
<ul>
<li>
<a target="javadoc"
- href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onParsedVariant-org.apache.nlpcraft.model.NCVariant-">onParsedVariant(...)</a>
+ href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onParsedVariant(org.apache.nlpcraft.model.NCVariant)">onParsedVariant(...)</a>
</li>
<li>
<a target="javadoc"
- href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onContext-org.apache.nlpcraft.model.NCContext-">onContext(...)</a>
+ href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onContext(org.apache.nlpcraft.model.NCContext)">onContext(...)</a>
</li>
<li>
<a target="javadoc"
- href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onMatchedIntent-org.apache.nlpcraft.model.NCIntentMatch-">onMatchedIntent(...)</a>
+ href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onMatchedIntent(org.apache.nlpcraft.model.NCIntentMatch)">onMatchedIntent(...)</a>
</li>
<li>
<a target="javadoc"
- href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onResult-org.apache.nlpcraft.model.NCIntentMatch-org.apache.nlpcraft.model.NCResult-">onResult(...)</a>
+ href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onResult(org.apache.nlpcraft.model.NCIntentMatch,org.apache.nlpcraft.model.NCResult)">onResult(...)</a>
</li>
<li>
<a target="javadoc"
- href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onError-org.apache.nlpcraft.model.NCContext-java.lang.Throwable-">onError(...)</a>
+ href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onError(org.apache.nlpcraft.model.NCContext,java.lang.Throwable)">onError(...)</a>
</li>
<li>
<a target="javadoc"
- href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onRejection-org.apache.nlpcraft.model.NCIntentMatch-org.apache.nlpcraft.model.NCRejection-">onRejection(...)</a>
+ href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onRejection(org.apache.nlpcraft.model.NCIntentMatch,org.apache.nlpcraft.model.NCRejection)">onRejection(...)</a>
</li>
</ul>
<div class="bq info">
@@ -340,9 +340,9 @@ public class AlarmModel extends NCModelFileAdapter {
<p>
Callbacks
<a target="javadoc"
- href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onContext-org.apache.nlpcraft.model.NCContext-">onContext(...)</a> and
+ href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onContext(org.apache.nlpcraft.model.NCContext)">onContext(...)</a> and
<a target="javadoc"
- href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onMatchedIntent-org.apache.nlpcraft.model.NCIntentMatch-">onMatchedIntent(...)</a>
+ href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onMatchedIntent(org.apache.nlpcraft.model.NCIntentMatch)">onMatchedIntent(...)</a>
are especially handy to perform a soft reset on the conversation context. Read their Javadoc documentation
to understand these callbacks protocol.
</p>
@@ -355,48 +355,45 @@ public class AlarmModel extends NCModelFileAdapter {
the probe or server configuration the lifecycle components will be called
during various stages of the probe or server startup or shutdown procedures. These callbacks can be used
to control lifecycle of external libraries and systems that the data probe or the server rely on, i.e.
- <a href="metrics-and-tracing.html">OpenCensus exporters</a>,
- security environment, devops hooks, etc.
+ <a href="metrics-and-tracing.html">OpenCensus exporters</a>, security environment, devops hooks, etc.
</p>
<p>
- See server and probe <a href="">configuration</a> as well as <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCProbeLifecycle.html">NCProbeLifecycle</a>
- interface for more details.
+ See server and probe <a href="">configuration</a>.
</p>
</div>
</section>
<section id="config">
<h2 class="section-title">Model Configuration</h2>
<p>
- Apart from mandatory model <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getId--">ID</a>,
- <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getName--">name</a> and
- <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getVersion--">version</a>
+ Apart from mandatory model <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getId()">ID</a>,
+ <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getName()">name</a> and
+ <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getVersion()">version</a>
there is a number of static model configurations that you can set. All of these properties have sensible
defaults that you can override, when required, in either sub-classes or via external JSON/YAML declaration:
</p>
<ul>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getAdditionalStopWords--">getAdditionalStopWords</a></li>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getEnabledBuiltInTokens--">getEnabledBuiltInTokens</a></li>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getExamples--">getExamples</a></li>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getExcludedStopWords--">getExcludedStopWords</a></li>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getJiggleFactor--">getJiggleFactor</a></li>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getMaxFreeWords--">getMaxFreeWords</a></li>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getMaxSuspiciousWords--">getMaxSuspiciousWords</a></li>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getMaxTokens--">getMaxTokens</a></li>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getMaxTotalSynonyms--">getMaxTotalSynonyms</a></li>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getMaxUnknownWords--">getMaxUnknownWords</a></li>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getMaxWords--">getMaxWords</a></li>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getMetadata--">getMetadata</a></li>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getMinNonStopwords--">getMinNonStopwords</a></li>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getMinTokens--">getMinTokens</a></li>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getMinWords--">getMinWords</a></li>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getSuspiciousWords--">getSuspiciousWords</a></li>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#isDupSynonymsAllowed--">isDupSynonymsAllowed</a></li>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#isNonEnglishAllowed--">isNonEnglishAllowed</a></li>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#isNoNounsAllowed--">isNoNounsAllowed</a></li>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#isNotLatinCharsetAllowed--">isNotLatinCharsetAllowed</a></li>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#isNoUserTokensAllowed--">isNoUserTokensAllowed</a></li>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#isPermutateSynonyms--">isPermutateSynonyms</a></li>
- <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#isSwearWordsAllowed--">isSwearWordsAllowed</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getAdditionalStopWords()">getAdditionalStopWords</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getEnabledBuiltInTokens()">getEnabledBuiltInTokens</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getExcludedStopWords()">getExcludedStopWords</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getJiggleFactor()">getJiggleFactor</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getMaxFreeWords()">getMaxFreeWords</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getMaxSuspiciousWords()">getMaxSuspiciousWords</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getMaxTokens()">getMaxTokens</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getMaxTotalSynonyms()">getMaxTotalSynonyms</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getMaxUnknownWords()">getMaxUnknownWords</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getMaxWords()">getMaxWords</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getMetadata()">getMetadata</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getMinNonStopwords()">getMinNonStopwords</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getMinTokens()">getMinTokens</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getMinWords()">getMinWords</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getSuspiciousWords()">getSuspiciousWords</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#isDupSynonymsAllowed()">isDupSynonymsAllowed</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#isNonEnglishAllowed()">isNonEnglishAllowed</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#isNoNounsAllowed()">isNoNounsAllowed</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#isNotLatinCharsetAllowed()">isNotLatinCharsetAllowed</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#isNoUserTokensAllowed()">isNoUserTokensAllowed</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#isPermutateSynonyms()">isPermutateSynonyms</a></li>
+ <li><a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#isSwearWordsAllowed()">isSwearWordsAllowed</a></li>
</ul>
<h3 class="section-title">External JSON/YAML Declaration</h3>
<p>
@@ -480,7 +477,7 @@ intents:
<p>
Model element is an implementation of <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCElement.html">NCElement</a>
interface. <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModel.html">NCModel</a> provides
- its elements via <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getElements--">getElements()</a> method.
+ its elements via <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getElements()">getElements()</a> method.
Typically, you create model elements by either:
</p>
<ul>
@@ -599,7 +596,7 @@ intents:
...
</pre>
<p>
- During synonym matching NLPCraft uses <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getJiggleFactor--">jiggle factor</a> to rearrange (or "jiggle")
+ During synonym matching NLPCraft uses <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getJiggleFactor()">jiggle factor</a> to rearrange (or "jiggle")
the individual words in the user input in attempt to match a given synonym. Jiggle factor is a measure of
how much sparsity is allowed when user input words are reordered in attempt to match the multi-word
synonyms. Zero means no reordering is allowed. One means that a word can move only one
@@ -641,7 +638,7 @@ intents:
together with option groups allow for significant simplification of this process.
Macros let you give a name to an often used set of words or option groups and reuse it without
repeating those words or option groups again and again. A model provides a list of macros via
- <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getMacros--">getMacros()</a> method on
+ <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getMacros()">getMacros()</a> method on
<a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html">NCModelView</a> interface. Each macro
has a name in a form of <code><X></code> where <code>X</code>
is just any string, and a string value. Note that macros can be nested (but not recursive), i.e. macro value can include
@@ -824,7 +821,7 @@ intents:
(backslash).
</p>
<p>
- For example, the following synonym:
+ For example, the following synonym:
</p>
<pre class="brush: js">
"synonyms": [
@@ -854,7 +851,7 @@ intents:
When a model element is recognized it is made available to the model's matching logic as an instance of
the <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCToken.html">NCToken</a> interface.
This interface has a method
- <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCToken.html#getValue--">getValue()</a> which
+ <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCToken.html#getValue()">getValue()</a> which
returns the name of the value, if any, by which
that model element was recognized. That value name can be further used in intent matching.
</p>
@@ -916,7 +913,7 @@ intents:
<span id="groups" class="section-sub-title">Element Groups</span>
<p>
Each model element belongs to one or more groups. Model element provides its groups via
- <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelElement.html#getGroups--">getGroups()</a> method.
+ <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCElement.html#getGroups()">getGroups()</a> method.
By default, if element group is not specified, the element ID will act as its default group ID.
</p>
<p>
@@ -942,7 +939,7 @@ intents:
<span id="parent" class="section-sub-title">Element Parent</span>
<p>
Each model element can form an optional hierarchical relationship with other element by specifying its
- parent element ID via <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelElement.html#getParnetId--">getParentID()</a> method. The main idea here is that sometimes model elements can act not only individually but
+ parent element ID via <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCElement.html#getParentId()">getParentID()</a> method. The main idea here is that sometimes model elements can act not only individually but
their place in the hierarchy can be important too for token and intent DSL.
</p>
<p>
@@ -1158,7 +1155,7 @@ intents:
<td><code>id</code></td>
<td>
<p>
- Token <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCToken.html#getId--">ID</a> as
+ Token <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCToken.html#getId()">ID</a> as
a <code>java.lang.String</code> object.
</p>
<p>
@@ -1171,7 +1168,7 @@ intents:
<td><code>groups</code></td>
<td>
<p>
- Token <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCToken.html#getGroups--">groups</a>
+ Token <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCToken.html#getGroups()">groups</a>
as <code>java.util.Collection</code> of token IDs.
</p>
<p>
@@ -1184,7 +1181,7 @@ intents:
<td><code>aliases</code></td>
<td>
<p>
- Token <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCToken.html#getAliases--">aliases</a>
+ Token <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCToken.html#getAliases()">aliases</a>
as <code>java.util.Collection</code> of token aliases.
</p>
<p>
@@ -1197,7 +1194,7 @@ intents:
<td><code>startidx</code></td>
<td>
<p>
- Token start character <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCToken.html#getStartCharIndex--">index</a> in the original text.
+ Token start character <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCToken.html#getStartCharIndex()">index</a> in the original text.
</p>
<p>
<b>Example:</b><br/>
@@ -1209,7 +1206,7 @@ intents:
<td><code>endidx</code></td>
<td>
<p>
- Token end character <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCToken.html#getStartCharIndex--">index</a> in the original text.
+ Token end character <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCToken.html#getStartCharIndex()">index</a> in the original text.
</p>
<p>
<b>Example:</b><br/>
@@ -1221,7 +1218,7 @@ intents:
<td><code>parent</code></td>
<td>
<p>
- <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCToken.html#getParentId--">ID</a> of
+ <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCToken.html#getParentId()">ID</a> of
the parent token as a <code>java.lang.String</code> object.
</p>
<p>
@@ -1234,7 +1231,7 @@ intents:
<td><code>ancestors</code></td>
<td>
<p>
- <code>java.util.List</code> of all token <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCToken.html#getParentId--">parent ID</a>
+ <code>java.util.List</code> of all token <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCToken.html#getParentId()">parent ID</a>
from the current one to the root. List can be empty if current token has no parent ID.
</p>
<p>
@@ -1247,7 +1244,7 @@ intents:
<td><code>value</code></td>
<td>
<p>
- Token <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCToken.html#getValue--">value</a>
+ Token <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCToken.html#getValue()">value</a>
as a <code>java.lang.String</code> object.
</p>
<p>
@@ -1260,7 +1257,7 @@ intents:
<td><code>~propName</code></td>
<td>
<p>
- Token <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCToken.html#getMetadata--">metadata</a>
+ Token <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCMetadata.html#getMetadata()">metadata</a>
property for given <code>propName</code>.
</p>
<p>
@@ -1273,7 +1270,7 @@ intents:
<td><code>~propName[key]</code></td>
<td>
<p>
- Token <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCToken.html#getMetadata--">metadata</a>
+ Token <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCMetadata.html#getMetadata()">metadata</a>
property for given <code>propName</code>
of type <code>java.util.List</code> or <code>java.util.Map</code>.
Returns indexed or keyed value. Note that <code>key</code> should be integer
@@ -1720,7 +1717,7 @@ intents:
</p>
<ul>
<li>
- Model provides its custom parsers via <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getParsers--">getParsers()</a> method.
+ Model provides its custom parsers via <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getParsers()">getParsers()</a> method.
</li>
<li>
Custom parser is defined by the following classes:
@@ -1793,18 +1790,18 @@ intents:
</li>
<li>
List of parsing variants provided
- by <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCContext.html#getVariants--">getVariants()</a>
+ by <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCContext.html#getVariants()">getVariants()</a>
method. When the user sentence gets parsed into individual tokens (i.e. detected model elements) there is generally
more than one way to do it. This ambiguity is perfectly fine because only the data model has all the
necessary information to select one parsing variant that fits that model the best. Without the data model
there isn't enough context to determine which variant is the best fitting.
- Method <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCContext.html#getVariants--">getVariants()</a>
+ Method <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCContext.html#getVariants()">getVariants()</a>
returns list of all parsing variants for a given user input.
</li>
</ul>
<h3 class="section-title">Interface <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCRequest.html">NCRequest</a></h3>
<p>
- <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCSentence.html">NCRequest</a> interface
+ <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCRequest.html">NCRequest</a> interface
is one of the several important entities in Data Model API that you as a model developer will be working with. You
should review its <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCRequest.html">Javadoc</a> but
here is an outline of the information it provides:
@@ -1829,7 +1826,7 @@ intents:
</p>
<p>
Most of the token's information is stored in map-based metadata accessible via
- <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCToken.html#getMetadata--">getMetadata()</a> method.
+ <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCMetadata.html#getMetadata()">getMetadata()</a> method.
Depending on the token ID each token will have different set of <a href="#meta">metadata properties</a>. Some common NLP properties
are always present for tokens of all types.
</p>
@@ -1851,7 +1848,7 @@ intents:
<p>
Built-in tokens have to be explicitly enabled on both the REST server and in the model. See
<code>nlpcraft.server.tokenProviders</code> configuration property and
- <a target="javadoc" href="apis/latest/org/apache/nlpcraft/model/NCModelView.html#getEnabledBuiltInTokens--">NCModelView#getEnabledBuiltInTokens()</a>
+ <a target="javadoc" href="apis/latest/org/apache/nlpcraft/model/NCModelView.html#getEnabledBuiltInTokens()">NCModelView#getEnabledBuiltInTokens()</a>
method for more details. By default, only NLPCraft tokens are enabled (token ID
starting with <code>nlpcraft</code>).
</p>
@@ -2208,7 +2205,7 @@ intents:
<td>
Whether this token represents an English word. Note that this only checks that token's text
consists of characters of English alphabet, i.e. the text doesn't have to be necessary a
- known valid English word. See <a href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#isNonEnglishAllowed--" target="javadoc">NCModelView.isNonEnglishAllowed()</a> method
+ known valid English word. See <a href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#isNonEnglishAllowed()" target="javadoc">NCModelView.isNonEnglishAllowed()</a> method
for corresponding model configuration.
</td>
</tr>
@@ -2258,7 +2255,7 @@ intents:
<td><code>java.lang.Boolean</code></td>
<td>
Whether or not this token is a swear word. NLPCraft has built-in list of common English swear words.
- See <a href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#isSwearWordsAllowed--" target="javadoc">NCModelView.isSwearWordsAllowed()</a> for corresponding model configuration
+ See <a href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#isSwearWordsAllowed()" target="javadoc">NCModelView.isSwearWordsAllowed()</a> for corresponding model configuration
</td>
</tr>
<tr>
diff --git a/docs.html b/docs.html
index b1d5733..952b77a 100644
--- a/docs.html
+++ b/docs.html
@@ -25,7 +25,7 @@ id: overview
<section id="overview">
<h2 class="section-title">Overview</h2>
<p>
- Apache NLPCraft is a Java-based <a href="/legal.html">open source</a> library for adding a natural language
+ Apache NLPCraft is a Java-based <a target=_blank href="https://www.apache.org/licenses/">open source</a> library for adding a natural language
interface to any applications. It can work with
any private or public data source, and has no hardware or software lock-in.
You can build models and intents for NLPCraft using any JVM-based languages like Java, Scala, Kotlin, Groovy, etc. NLPCraft
diff --git a/index.html b/index.html
index cb11257..5b86832 100644
--- a/index.html
+++ b/index.html
@@ -19,6 +19,7 @@ layout: default
limitations under the License.
-->
+<!--suppress CheckImageSize -->
<div id="banner-box" class="bottom-arrow">
<div id="inner-banner-box">
<div id="banner">
@@ -71,7 +72,7 @@ layout: default
<a href="https://github.com/apache/incubator-nlpcraft" target="github">
<img
class="quick-link-img"
- src="{{ 'images/github_logo.png' | relative_url }}" alt="">
+ src="/images/github_logo.png" alt="">
</a>
<div class="gh-btn">
<a
@@ -90,16 +91,16 @@ layout: default
</div>
<div class="quick-link" >
<a href="/apis/latest/index.html" target="_">
- <img alt="" class="quick-link-img" src="{{ 'images/java.png' | relative_url }}">
+ <img alt="" class="quick-link-img" src="/images/java.png">
<span class="txt">Latest </span>
<a target="_" href="https://javadoc.io/doc/org.apache.nlpcraft/nlpcraft"><img src="https://javadoc.io/badge/org.apache.nlpcraft/nlpcraft.svg" alt="Javadocs"></a>
</a>
<a href="https://app.swaggerhub.com/apis-docs/Apache-NLPCraft/apache-nlpcraft/{{site.latest_version}}" target="swaggerhub" style="margin-left: 20px">
- <img alt="" class="quick-link-img" src="{{ 'images/swagger.png' | relative_url }}"><span class="txt">REST API</span>
+ <img alt="" class="quick-link-img" src="/images/swagger.png"><span class="txt">REST API</span>
</a>
</div>
<div class="quick-link">
- <img alt="" class="quick-link-img" src="{{ 'images/apache_20_logo2.png' | relative_url }}">
+ <img alt="" class="quick-link-img" src="/images/apache_20_logo2.png">
<a target="asf" href="https://www.apache.org/licenses/"><span class="txt">License</span></a>
<span class="sep">•</span>
<a target="asf" href="https://www.apache.org/security"><span class="txt">Security</span></a>
@@ -264,7 +265,7 @@ layout: default
</div>
<div class="col-6">
<center>
- <img class="img-fluid" src="{{ 'images/homepage-fig1.1.png' | relative_url}}" alt="">
+ <img class="img-fluid" src="/images/homepage-fig1.1.png" alt="">
</center>
</div>
</div>
@@ -314,7 +315,7 @@ layout: default
<div id="about-container" class="row">
<div class="col-7" style="margin-top: 50px;">
<p>
- <a href="https://www.apache.org/licenses/LICENSE-2.0" target=_><img src="{{ 'images/asf20.jpg' | relative_url}}" height="64px" alt=""></a>
+ <a href="https://www.apache.org/licenses/LICENSE-2.0" target=_><img src="/images/asf20.jpg" height="64px" alt=""></a>
</p>
<p>
Apache NLPCraft is an effort undergoing incubation at The Apache Software Foundation (ASF),
diff --git a/integrations.html b/integrations.html
index 7363c91..43c30ab 100644
--- a/integrations.html
+++ b/integrations.html
@@ -21,6 +21,7 @@ id: integrations
limitations under the License.
-->
+<!--suppress CheckImageSize -->
<div id="integrations" class="col-md-8 second-column">
<section>
<span id="overview" class="section-title">Overview</span>
@@ -67,28 +68,28 @@ id: integrations
<tbody>
<tr>
<td>NLPCraft</td>
- <td><center><i class="fas fa-times"></i></center></td>
- <td><center><i class="fas fa-check-double"></i></center></td>
+ <td style="text-align: center;"><i class="fas fa-times"></i></td>
+ <td style="text-align: center;"><i class="fas fa-check-double"></i></td>
</tr>
<tr>
<td><a href="#opennlp">OpenNLP</a></td>
- <td><center><i class="fas fa-check-double"></i></center></td>
- <td><center><i class="fas fa-check"></i></center></td>
+ <td style="text-align: center;"><i class="fas fa-check-double"></i></td>
+ <td style="text-align: center;"><i class="fas fa-check"></i></td>
</tr>
<tr>
<td><a href="#google">Google Natural Language</a></td>
- <td><center><i class="fas fa-times"></i></center></td>
- <td><center><i class="fas fa-check"></i></center></td>
+ <td style="text-align: center;"><i class="fas fa-times"></i></td>
+ <td style="text-align: center;"><i class="fas fa-check"></i></td>
</tr>
<tr>
<td><a href="#stanford">Stanford CoreNLP</a></td>
- <td><center><i class="fas fa-check"></i></center></td>
- <td><center><i class="fas fa-check"></i></center></td>
+ <td style="text-align: center;"><i class="fas fa-check"></i></td>
+ <td style="text-align: center;"><i class="fas fa-check"></i></td>
</tr>
<tr>
<td><a href="#spacy">spaCy</a></td>
- <td><center><i class="fas fa-times"></i></center></td>
- <td><center><i class="fas fa-check"></i></center></td>
+ <td style="text-align: center;"><i class="fas fa-times"></i></td>
+ <td style="text-align: center;"><i class="fas fa-check"></i></td>
</tr>
</tbody>
</table>
@@ -104,7 +105,7 @@ id: integrations
<p>
REST server configuration property <code>tokenProvides</code> provides the list of enabled token providers. See its
<a href="/server-and-probe.html">documentation</a> for more details. Data model provides its required tokens via
- <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getEnabledBuiltInTokens--">NCModelView.getEnabledBuiltInTokens()</a> method.
+ <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getEnabledBuiltInTokens()">NCModelView.getEnabledBuiltInTokens()</a> method.
</p>
</div>
</section>
@@ -313,7 +314,7 @@ id: integrations
</li>
<li>
Make sure to also properly configure required tokens in you model configuration via
- <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getEnabledBuiltInTokens--">NCModelView.getEnabledBuiltInTokens()</a> method.
+ <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getEnabledBuiltInTokens()">NCModelView.getEnabledBuiltInTokens()</a> method.
</li>
</ul>
</section>
@@ -401,7 +402,7 @@ id: integrations
</li>
<li>
Make sure to properly configure required tokens in you model configuration via
- <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getEnabledBuiltInTokens--">NCModelView.getEnabledBuiltInTokens()</a> method.
+ <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getEnabledBuiltInTokens()">NCModelView.getEnabledBuiltInTokens()</a> method.
</li>
</ul>
</section>
@@ -441,7 +442,7 @@ id: integrations
</li>
<li>
Make sure to also properly configure required tokens in you model configuration via
- <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getEnabledBuiltInTokens--">NCModelView.getEnabledBuiltInTokens()</a> method.
+ <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getEnabledBuiltInTokens()">NCModelView.getEnabledBuiltInTokens()</a> method.
</li>
</ul>
</section>
@@ -558,7 +559,7 @@ id: integrations
</li>
<li>
Make sure to also properly configure required tokens in you model configuration via
- <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getEnabledBuiltInTokens--">NCModelView.getEnabledBuiltInTokens()</a> method.
+ <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getEnabledBuiltInTokens()">NCModelView.getEnabledBuiltInTokens()</a> method.
</li>
</ul>
</section>
@@ -686,7 +687,7 @@ if __name__ == '__main__':
</li>
<li>
Make sure to also properly configure required tokens in you model configuration via
- <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getEnabledBuiltInTokens--">NCModelView.getEnabledBuiltInTokens()</a> method.
+ <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelView.html#getEnabledBuiltInTokens()">NCModelView.getEnabledBuiltInTokens()</a> method.
</li>
</ul>
</section>
diff --git a/intent-matching.html b/intent-matching.html
index d52e50d..8706a49 100644
--- a/intent-matching.html
+++ b/intent-matching.html
@@ -633,7 +633,7 @@ id: intent_matching
user-provided cross-cutting concerns into a standard intent matching workflow of NLPCraft. Usage of these callbacks
is completely optional, yet they provide convenient joint points for logging, statistic collections, security
audit and validation, explicit conversation context management, model metadata updates, and many other aspects
- that depend on the standard intent matching workflow:
+ that may depend on the standard intent matching workflow:
</p>
<table class="gradient-table">
<thead>
@@ -644,7 +644,7 @@ id: intent_matching
</thead>
<tbody>
<tr>
- <td><a href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onParsedVariant(org.apache.nlpcraft.model.NCVariant)"><code>NCModel#onParsedVariant(...)</code></a></td>
+ <td><a href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onParsedVariant(org.apache.nlpcraft.model.NCVariant)"><code>NCModel#<b>onParsedVariant(...)</b></code></a></td>
<td>
<p>
A callback to accept or reject a parsed variant. This callback is called before any other
@@ -658,7 +658,7 @@ id: intent_matching
</td>
</tr>
<tr>
- <td><a href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onContext(org.apache.nlpcraft.model.NCContext)"><code>NCModel#onContext(...)</code></a></td>
+ <td><a href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onContext(org.apache.nlpcraft.model.NCContext)"><code>NCModel#<b>onContext(...)</b></code></a></td>
<td>
<p>
A callback that is called when a fully assembled query context is ready. This callback is called
@@ -671,12 +671,60 @@ id: intent_matching
</td>
</tr>
<tr>
- <td><a href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onMatchedIntent(org.apache.nlpcraft.model.NCIntentMatch)"><code>onMatchedIntent(...)</code></a></td>
+ <td><a href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onMatchedIntent(org.apache.nlpcraft.model.NCIntentMatch)"><code>NCModel#<b>onMatchedIntent(...)</b></code></a></td>
<td>
<p>
- A callback that is called when intent was successfully matched but right before its callback is called. This callback is called after onContext(NCContext) is called and may be called multiple times depending on its return value. If true is returned than the default workflow will continue and the matched intent's callback will be called. However, if false is returned than the entire existing set of parsing variants will be matched against all declared intents again [...]
-
- Note that this callback may not be called at all based on the return value of onContext(NCContext) callback. Typical use case for this callback is to perform logging, debugging, statistic or usage collection, explicit update or initialization of conversation context, security audit or validation, etc.
+ A callback that is called when intent was successfully matched but right before its callback is called.
+ This callback is called after <a href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onContext(org.apache.nlpcraft.model.NCContext)"><code>onContext(...)</code></a>
+ is called and may be called multiple times depending on its return value. If <code>true</code> is
+ returned than the default workflow will continue and the matched intent's callback will be called.
+ However, if <code>false</code> is returned than the entire existing set of parsing variants will be
+ matched against all declared intents again. Returning false allows this method to alter the state
+ of the model (like soft-reset conversation or change metadata) and force the full re-evaluation
+ of the parsing variants against all declared intents. Note that user logic should be careful not
+ to induce infinite loop in this behavior.
+ </p>
+ <p>
+ Note that this callback may not be called at all based on the return value of
+ <a href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onContext(org.apache.nlpcraft.model.NCContext)"><code>onContext(...)</code></a> callback.
+ Typical use case for this callback is to perform logging, debugging, statistic or usage collection,
+ explicit update or initialization of conversation context, security audit or validation, etc.
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onResult(org.apache.nlpcraft.model.NCIntentMatch,org.apache.nlpcraft.model.NCResult)"><code>NCModel#<b>onResult(...)</b></code></a></td>
+ <td>
+ <p>
+ A callback that is called when successful result is obtained from the intent callback and right
+ before sending it back to the caller. This callback is called after
+ <a href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onMatchedIntent(org.apache.nlpcraft.model.NCIntentMatch)"><code>onMatchedIntent(...)</code></a> is called.
+ Note that this callback may not be called at all, and if called - it's called only once. Typical
+ use case for this callback is to perform logging, debugging, statistic or usage collection,
+ explicit update or initialization of conversation context, security audit or validation, etc.
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onRejection(org.apache.nlpcraft.model.NCIntentMatch,org.apache.nlpcraft.model.NCRejection)"><code>NCModel#<b>onRejection(...)</b></code></a></td>
+ <td>
+ <p>
+ A callback that is called when intent callback threw <a href="/apis/latest/org/apache/nlpcraft/model/NCRejection.html"><code>NCRejection</code></a> exception.
+ This callback is called after <a href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onMatchedIntent(org.apache.nlpcraft.model.NCIntentMatch)"><code>onMatchedIntent(...)</code></a> is called.
+ Note that this callback may not be called at all, and if called - it's called only once. Typical
+ use case for this callback is to perform logging, debugging, statistic or usage collection,
+ explicit update or initialization of conversation context, security audit or validation, etc.
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="/apis/latest/org/apache/nlpcraft/model/NCModel.html#onError(org.apache.nlpcraft.model.NCContext,java.lang.Throwable)"><code>NCModel#<b>onError(...)</b></code></a></td>
+ <td>
+ <p>
+ A callback that is called when intent callback failed with unexpected exception. Note that this
+ callback may not be called at all, and if called - it's called only once. Typical use case for
+ this callback is to perform logging, debugging, statistic or usage collection, explicit update
+ or initialization of conversation context, security audit or validation, etc.
</p>
</td>
</tr>
diff --git a/metrics-and-tracing.html b/metrics-and-tracing.html
index 9e78116..3f8c537 100644
--- a/metrics-and-tracing.html
+++ b/metrics-and-tracing.html
@@ -50,7 +50,7 @@ id: metrics
Probe:
<a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/opencensus/NCJaegerExporter.html">org.apache.nlpcraft.model.opencensus.NCJaegerExporter</a>
</td>
- <td><center>Trace</center></td>
+ <td style="text-align: center;">Trace</td>
</tr>
<tr>
<td>
@@ -63,7 +63,7 @@ id: metrics
Server: <code>org.apache.nlpcraft.server.lifecycle.opencensus.NCZipkinExporter</code><br>
Probe: <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/opencensus/NCZipkinExporter.html">org.apache.nlpcraft.model.opencensus.NCZipkinExporter</a>
</td>
- <td><center>Trace</center></td>
+ <td style="text-align: center;">Trace</td>
</tr>
<tr>
<td>
@@ -76,7 +76,7 @@ id: metrics
Server: <code>org.apache.nlpcraft.server.lifecycle.opencensus.NCPrometheusExporter</code><br>
Probe: <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/opencensus/NCPrometheusExporter.html">org.apache.nlpcraft.model.opencensus.NCPrometheusExporter</a>
</td>
- <td><center>Stats</center></td>
+ <td style="text-align: center;">Stats</td>
</tr>
<tr>
<td>
@@ -89,7 +89,7 @@ id: metrics
Server: <code>org.apache.nlpcraft.server.lifecycle.opencensus.NCPrometheusExporter</code><br>
Probe: <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/opencensus/NCPrometheusExporter.html">org.apache.nlpcraft.model.opencensus.NCPrometheusExporter</a>
</td>
- <td><center>Stats</center></td>
+ <td style="text-align: center;">Stats</td>
</tr>
<tr>
<td>
@@ -102,7 +102,7 @@ id: metrics
Server: <code>org.apache.nlpcraft.server.lifecycle.opencensus.NCStackdriverStatsExporter</code><br>
Probe: <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/opencensus/NCStackdriverStatsExporter.html">org.apache.nlpcraft.model.opencensus.NCStackdriverStatsExporter</a>
</td>
- <td><center>Stats</center></td>
+ <td style="text-align: center;">Stats</td>
</tr>
<tr>
<td>
@@ -115,7 +115,7 @@ id: metrics
Server: <code>org.apache.nlpcraft.server.lifecycle.opencensus.NCStackdriverTraceExporter</code><br>
Probe: <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/opencensus/NCStackdriverTraceExporter.html">org.apache.nlpcraft.model.opencensus.NCStackdriverTraceExporter</a>
</td>
- <td><center>Trace</center></td>
+ <td style="text-align: center;">Trace</td>
</tr>
</tbody>
</table>
@@ -165,7 +165,7 @@ nlpcraft {
<p>
Just like on the REST server OpenCensus exporters for the data probe are lifecycle components. Probe lifecycle
components are the implementations
- of <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCProbeLifecycle.html">org.apache.nlpcraft.model.NCLifecycle</a>
+ of <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCLifecycle.html">org.apache.nlpcraft.model.NCLifecycle</a>
interface. Lifecycle components get callbacks for various stages of the data probe
lifecycle and thus can register and unregister "primordial" components such as OpenCensus exporters. For example, using
file based configuration: