This is an automated email from the ASF dual-hosted git repository.
sergeykamov pushed a commit to branch NLPCRAFT-513
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft-website.git
The following commit(s) were added to refs/heads/NLPCRAFT-513 by this push:
new e234a67 WIP.
e234a67 is described below
commit e234a678111b2fb84ac28b3dc11aaa3b30ee4ba4
Author: skhdl <[email protected]>
AuthorDate: Wed Oct 26 15:37:55 2022 +0400
WIP.
---
_includes/left-side-menu.html | 2 +-
api-components.html | 31 ++++++++++++++++++++-----------
built-in-builder.html | 5 +++--
built-in-entity-parser.html | 2 +-
first-example.html | 4 ++--
5 files changed, 27 insertions(+), 17 deletions(-)
diff --git a/_includes/left-side-menu.html b/_includes/left-side-menu.html
index 8d51d97..ee9388b 100644
--- a/_includes/left-side-menu.html
+++ b/_includes/left-side-menu.html
@@ -32,7 +32,7 @@
{% endif %}
</li>
<li>
- {% if page.id == "installation" %}
+ {% if page.id == "first-example" %}
<a class="active" href="/first-example.html">First Example</a>
{% else %}
<a href="/first-example.html">First Example</a>
diff --git a/api-components.html b/api-components.html
index 9fedad7..c3e82e4 100644
--- a/api-components.html
+++ b/api-components.html
@@ -229,7 +229,7 @@ id: api-components
</thead>
<tbody>
<tr>
- <td><code>ask()</code></td>
+ <td><a
href="apis/latest/org/apache/nlpcraft/NCModelClient.html#ask-fffff9ce">ask()</a></td>
<td>
Passes user text input to the model and receives back
execution
<a
href="apis/latest/org/apache/nlpcraft/NCResult.html">NCResult</a> or
@@ -239,7 +239,7 @@ id: api-components
</td>
</tr>
<tr>
- <td><code>debugAsk()</code></td>
+ <td><a
href="apis/latest/org/apache/nlpcraft/NCModelClient.html#debugAsk-fffff96c">debugAsk()</a></td>
<td>
Passes user text input to the model and receives back
callback and its parameters or
rejection exception if there isn't any triggered intents.
@@ -248,21 +248,23 @@ id: api-components
</td>
</tr>
<tr>
- <td><code>clearStm()</code></td>
+ <td><a
href="apis/latest/org/apache/nlpcraft/NCModelClient.html#clearStm-571">clearStm()</a></td>
<td>
Clears STM state. Memory is cleared wholly or with some
predicate.
Loot at <a href="short-term-memory.html">Conversation</a>
chapter to get more details.
+ Second variant odf given method with another parameters is
here: <a
href="apis/latest/org/apache/nlpcraft/NCModelClient.html#clearStm-1d8">clearStm()</a>.
</td>
</tr>
<tr>
- <td><code>clearDialog()</code></td>
+ <td><a
href="apis/latest/org/apache/nlpcraft/NCModelClient.html#clearDialog-571">clearDialog()</a></td>
<td>
Clears dialog state. Dialog is cleared wholly or with some
predicate.
Loot at <a href="short-term-memory.html">Conversation</a>
chapter to get more details.
+ Second variant odf given method with another parameters is
here: <a
href="apis/latest/org/apache/nlpcraft/NCModelClient.html#clearDialog-1d8">clearDialog()</a>.
</td>
</tr>
<tr>
- <td><code>close()</code></td>
+ <td><a
href="apis/latest/org/apache/nlpcraft/NCModelClient.html#close-94c">close()</a></td>
<td>
Closes client. You can't call another client's methods
after this method was closed.
</td>
@@ -410,8 +412,9 @@ id: api-components
</table>
<p>
- Below <code>Model</code> creation example.
- <code>Pipeline</code> is prepared using
<code>NCPipelineBuilder</code> class helper.
+ Below <a
href="apis/latest/org/apache/nlpcraft/NCModel.html">NCModel</a> creation
example.
+ <a
href="apis/latest/org/apache/nlpcraft/NCPipeline.html">NCPipeline</a> is
prepared using
+ <a
href="apis/latest/org/apache/nlpcraft/NCPipelineBuilder.html">NCPipelineBuilder</a>
class helper.
</p>
<pre class="brush: scala, highlight: []">
@@ -452,25 +455,31 @@ id: api-components
</thead>
<tbody>
<tr>
- <td><code>onMatchedIntent()</code></td>
+ <td><a
href="apis/latest/org/apache/nlpcraft/NCModel.html#onContext-38d">onContext()</a></td>
+ <td>
+ Overriding this method allows to prepare result before
intent matching.
+ </td>
+ </tr>
+ <tr>
+ <td><a
href="apis/latest/org/apache/nlpcraft/NCModel.html#onMatchedIntent-946">onMatchedIntent()</a></td>
<td>
Overriding this method allows to reject matched intent and
continue matching process.
</td>
</tr>
<tr>
- <td><code>onResult()</code></td>
+ <td><a
href="apis/latest/org/apache/nlpcraft/NCModel.html#onResult-fffffaf3">onResult()</a></td>
<td>
Overriding this method allows to replace callback method
execution result.
</td>
</tr>
<tr>
- <td><code>onRejection()</code></td>
+ <td><a
href="apis/latest/org/apache/nlpcraft/NCModel.html#onRejection-4fa">onRejection()</a></td>
<td>
Overriding this method allows to change operation result
when rejection occurs.
</td>
</tr>
<tr>
- <td><code>onError()</code></td>
+ <td><a
href="apis/latest/org/apache/nlpcraft/NCModel.html#onError-fffff759">onError()</a></td>
<td>
Overriding this method allows to change operation result
when any error occurs.
</td>
diff --git a/built-in-builder.html b/built-in-builder.html
index a8d9420..cc9ba8a 100644
--- a/built-in-builder.html
+++ b/built-in-builder.html
@@ -1,7 +1,7 @@
---
active_crumb: Docs
layout: documentation
-id: built-in-overview
+id: built-in-builder
---
<!--
@@ -28,7 +28,8 @@ id: built-in-overview
<p>
<a
href="apis/latest/org/apache/nlpcraft/NCPipelineBuilder.html">NCPipelineBuilder</a>
class
is designed for simplifying preparing <a
href="apis/latest/org/apache/nlpcraft/NCPipeline.html">NCPipeline</a> instance.
- It contains a number of methods <code>withSemantic()</code> which
allow to prepare pipeline instance based on
+ It contains a number of methods <a
href="apis/latest/org/apache/nlpcraft/NCPipelineBuilder.html#withSemantic-fffff4b0">withSemantic()</a>
+ which allow to prepare pipeline instance based on
<a
href="apis/latest/org/apache/nlpcraft/nlp/parsers/NCSemanticEntityParser">NCSemanticEntityParser</a>
and configured language.
Currently only English language is supported.
It also adds following English built-in components into pipeline:
diff --git a/built-in-entity-parser.html b/built-in-entity-parser.html
index 400f4a9..d918d20 100644
--- a/built-in-entity-parser.html
+++ b/built-in-entity-parser.html
@@ -1,7 +1,7 @@
---
active_crumb: Docs
layout: documentation
-id: built-in-token-enricher
+id: built-in-entity-parser
---
<!--
diff --git a/first-example.html b/first-example.html
index 00fbd89..a92212b 100644
--- a/first-example.html
+++ b/first-example.html
@@ -1,7 +1,7 @@
---
-active_crumb: First Example
+active_crumb: Docs
layout: documentation
-id: first_example
+id: first-example
---
<!--
