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 1a02059 WIP.
1a02059 is described below
commit 1a02059573fa620e48df7fd01cd00c84db8e364f
Author: skhdl <[email protected]>
AuthorDate: Sat Oct 22 10:12:03 2022 +0400
WIP.
---
api-review.html | 32 ++++++++++++++++++++++++++++----
1 file changed, 28 insertions(+), 4 deletions(-)
diff --git a/api-review.html b/api-review.html
index 5532f56..4aa04d1 100644
--- a/api-review.html
+++ b/api-review.html
@@ -27,11 +27,10 @@ id: overview
<p>
NlpCraft library contains two base elements: <code>Model</code>
and <code>Client</code>.
+ When you work with the system - you should prepare model,
configuring its parameters and defining its components.
+ After you just communicate with this model via client's methods.
</p>
- </section>
- <section id="model-client">
- <h2 class="section-title">Model and client <a href="#"><i
class="top-link fas fa-fw fa-angle-double-up"></i></a></h2>
<ul>
<li>
<code>Model</code> is domain specific object which responsible
for user input interpretation. Model contains intents, defined via NlpCraft IDL
with related code callbacks. Intent is user defined callback and rule,
according to which this callback should be called. Rule is most often some
template, based on expected set of entities in user input, but it can be more
flexible.
@@ -70,7 +69,33 @@ id: overview
<code>Pipeline</code> can be based on standard and custom user
defined components.
</li>
</ul>
+
+ <p>
+ Base client methods:
+ </p>
+ <ul>
+ <li>
+ <code>ask</code> - sends user input to the model and receives
triggered callback result or
+ rejection exception if there isn't any winning intents.
+ </li>
+ <li>
+ <code>debugAsk</code>> - sends user input to the model and
receives callback and its parameters or
+ rejection exception if there isn't any winning intents.
+ Main difference from <code>ask</code> that callback of
triggered intent is not called.
+ This method can be useful for tests scenarios.
+ </li>
+ <li>
+ <code>clearStm</code> - clears STM state. Read more .. TODO
+ </li>
+ <li>
+ <code>clearDialog</code> - clears dialog state. Read more ..
TODO
+ </li>
+ <li>
+ <code>close</code> - Closes client.
+ </li>
+ </ul>
</section>
+
<section id="model-configuration">
<h2 class="section-title">Model configuration <a href="#"><i
class="top-link fas fa-fw fa-angle-double-up"></i></a></h2>
</section>
@@ -152,7 +177,6 @@ id: overview
<ul class="side-nav">
<li class="side-nav-title">On This Page</li>
<li><a href="#overview">Overview</a></li>
- <li><a href="#model-client">Model and client</a></li>
<li><a href="#model-configuration">Model configuration</a></li>
<li><a href="#model-pipeline">Model pipeline</a></li>
<li><a href="#model-intents">Model intents and callbacks</a></li>
