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 f961bf0 WIP.
f961bf0 is described below
commit f961bf014aad23dad540bc5eaa4606bf574b0d8f
Author: Aaron Radzinski <[email protected]>
AuthorDate: Sat Jan 30 22:36:41 2021 -0800
WIP.
---
cheat-sheet.html | 42 ++++++++++++++++++++++++++++++++++--------
images/groovy-h18.png | Bin 0 -> 2206 bytes
images/kotlin-h18.png | Bin 0 -> 2645 bytes
images/scala-logo-h16.png | Bin 0 -> 2196 bytes
server-and-probe.html | 14 +++++++-------
5 files changed, 41 insertions(+), 15 deletions(-)
diff --git a/cheat-sheet.html b/cheat-sheet.html
index 2a3f8fa..9d45fab 100644
--- a/cheat-sheet.html
+++ b/cheat-sheet.html
@@ -140,9 +140,16 @@ id: cheat_sheet
</nav>
<div class="tab-content">
<div class="tab-pane fade show active"
id="nav-srv-script" role="tabpanel">
+ <p></p>
+ <p>
+ Start the server:
+ </p>
<pre class="brush: bash">
$ bin/nlpcraft.sh start-server # Start server.
</pre>
+ <p>
+ Stop the server:
+ </p>
<pre class="brush: bash">
$ bin/nlpcraft.sh stop-server # Stop server.
$ bin/nlpcraft.sh stop # Stop both server and
probe.
@@ -167,7 +174,7 @@ id: cheat_sheet
</p>
<ul>
<li>
- Make sure to provide correct path to
<code>apache-nlpcraft-incubating-{{site.latest_version}}-all-deps.jar</code>
file.
+ Make sure to provide correct path to
<code>apache-nlpcraft-incubating-<b>{{site.latest_version}}</b>-all-deps.jar</code>
file.
</li>
<li>
Class
<code>org.apache.nlpcraft.NCStart</code> is a common entry point for all
NLPCraft runtime components.
@@ -190,7 +197,7 @@ id: cheat_sheet
<dd>
<em>Optional</em> parameter to provide
configuration file path.
Server will automatically look for
<code>nlpcraft.conf</code> configuration file in the same directory
- as
<code>apache-nlpcraft-incubating-{{site.latest_version}}-all-deps.jar</code>
file. If the configuration
+ as
<code>apache-nlpcraft-incubating-<b>{{site.latest_version}}</b>-all-deps.jar</code>
file. If the configuration
file has different name or in different
location use <code>-config=path</code> parameter
where <code>path</code> is an absolute
path to the configuration file. Note that the server and the data
probe can use the same file for their
configuration (like the
@@ -201,7 +208,7 @@ id: cheat_sheet
<em>Optional</em> parameter to provide <a
target=_ href="https://ignite.apache.org/";>Apache Ignite</a> configuration file
path.
Note that Apache Ignite is used as a
cluster computing plane and a default distributed storage.
Server will automatically look for
<code>ignite.xml</code>
- configuration file in the same directory
as <code>apache-nlpcraft-incubating-{{site.latest_version}}-all-deps.jar</code>
file.
+ configuration file in the same directory
as
<code>apache-nlpcraft-incubating-<b>{{site.latest_version}}</b>-all-deps.jar</code>
file.
If the configuration file has different
name or in different location use <code>-igniteConfig=path</code> parameter
where <code>path</code> is an absolute
path to the Ignite configuration file.
</dd>
@@ -238,11 +245,18 @@ id: cheat_sheet
</nav>
<div class="tab-content">
<div class="tab-pane fade show active"
id="nav-probe-script" role="tabpanel">
+ <p></p>
+ <p>
+ Start the probe:
+ </p>
<pre class="brush: bash">
$ bin/nlpcraft.sh start-probe # Start
probe with default config.
$ bin/nlpcraft.sh start-probe
--cfg=~/myapp/nlpcraft.conf --mdls=my.package.Model --cp=~/myapp/target/classes
--jmvOpts="-ea -Xms2048m" --timeoutMins=5
</pre>
- <pre class="brush: bash">
+ <p>
+ Stop the probe:
+ </p>
+ <pre class="brush: bash">
$ bin/nlpcraft.sh stop-probe # Stop probe.
$ bin/nlpcraft.sh stop # Stop server and
probe.
</pre>
@@ -269,7 +283,7 @@ id: cheat_sheet
<code>/my/project</code> directory
contains user-defined model implementation
</li>
<li>
- Make sure to provide correct path to
<code>apache-nlpcraft-incubating-{{site.latest_version}}-all-deps.jar</code>
file.
+ Make sure to provide correct path to
<code>apache-nlpcraft-incubating-<b>{{site.latest_version}}</b>-all-deps.jar</code>
file.
</li>
<li>
Class
<code>org.apache.nlpcraft.NCStart</code> is a common entry point for all
NLPCraft runtime components.
@@ -293,7 +307,7 @@ id: cheat_sheet
<p>
<em>Optional</em> parameter to
provide probe configuration file path.
Data probe will automatically look
for <code>nlpcraft.conf</code> configuration file in the same directory
- as
<code>apache-nlpcraft-incubating-{{site.latest_version}}-all-deps.jar</code>
file. If the configuration
+ as
<code>apache-nlpcraft-incubating-<b>{{site.latest_version}}</b>-all-deps.jar</code>
file. If the configuration
file has different name or in
different location use <code>-config=path</code> parameter
where <code>path</code> is an
absolute path to the data probe configuration file. Note that the server and
the data
probe can use the same file for
their configuration (like the
@@ -422,12 +436,24 @@ id: cheat_sheet
</nav>
<div class="tab-content">
<div class="tab-pane fade show active"
id="nav-rest-script" role="tabpanel">
+ <p></p>
+ <p>
+ Using <code>ask</code> command:
+ </p>
<pre class="brush: bash">
$ bin/nlpcraft.sh ask --txt="User request"
--mdlId=my.model.id # REST 'ask/sync' call.
-
+ </pre>
+ <p>
+ Using <code>call</code> command (for REPL
mode):
+ </p>
+ <pre class="brush: bash">
$ bin/nlpcraft.sh call -p=signin
[email protected] --passwd=admin
$ bin/nlpcraft.sh call --path=ask/sync
--acsTok=qwerty123456 --txt="User request" --mdlId=my.model.id
--data='{"data1": true, "data2": 123, "data3": "some text"}' --enableLog=false
-
+ </pre>
+ <p>
+ Using <code>rest</code> command (for
command line mode):
+ </p>
+ <pre class="brush: bash">
$ bin/nlpcraft.sh rest -p=signin
-j='{"email": "[email protected]", "passwd": "admin"}' # Linux/Unix/MacOS REST
call.
$ bin/nlpcraft.cmd rest --path=signin
--json='{\"email\": \"[email protected]\", \"passwd\": \"admin\"}' # Window REST
call.
</pre>
diff --git a/images/groovy-h18.png b/images/groovy-h18.png
new file mode 100644
index 0000000..8632cee
Binary files /dev/null and b/images/groovy-h18.png differ
diff --git a/images/kotlin-h18.png b/images/kotlin-h18.png
new file mode 100644
index 0000000..8f8d96e
Binary files /dev/null and b/images/kotlin-h18.png differ
diff --git a/images/scala-logo-h16.png b/images/scala-logo-h16.png
new file mode 100644
index 0000000..a89f4e4
Binary files /dev/null and b/images/scala-logo-h16.png differ
diff --git a/server-and-probe.html b/server-and-probe.html
index 91a6efe..46b3551 100644
--- a/server-and-probe.html
+++ b/server-and-probe.html
@@ -59,7 +59,7 @@ id: server_and_probe
</ul>
<p>
Note that if you downloaded the <a
href="/download.html#src">source</a> ZIP you need to run <code
class="script">mvn clean package</code> to
- get the
<code>apache-nlpcraft-incubating-{{site.latest_version}}-all-deps.jar</code>
+ get the
<code>apache-nlpcraft-incubating-<b>{{site.latest_version}}</b>-all-deps.jar</code>
file. It will be located in <code>nlpcraft/target</code>
sub-folder.
</p>
</section>
@@ -114,7 +114,7 @@ id: server_and_probe
</p>
<ul>
<li>
- Make sure to provide correct path to
<code>apache-nlpcraft-incubating-{{site.latest_version}}-all-deps.jar</code>
file.
+ Make sure to provide correct path to
<code>apache-nlpcraft-incubating-<b>{{site.latest_version}}</b>-all-deps.jar</code>
file.
</li>
<li>
Class <code>org.apache.nlpcraft.NCStart</code> is a
common entry point for all NLPCraft runtime components.
@@ -137,7 +137,7 @@ id: server_and_probe
<dd>
<em>Optional</em> parameter to provide configuration
file path.
Server will automatically look for
<code>nlpcraft.conf</code> configuration file in the same directory
- as
<code>apache-nlpcraft-incubating-{{site.latest_version}}-all-deps.jar</code>
file. If the configuration
+ as
<code>apache-nlpcraft-incubating-<b>{{site.latest_version}}</b>-all-deps.jar</code>
file. If the configuration
file has different name or in different location use
<code>-config=path</code> parameter
where <code>path</code> is an absolute path to the
configuration file. Note that the server and the data
probe can use the same file for their configuration
(like the
@@ -148,7 +148,7 @@ id: server_and_probe
<em>Optional</em> parameter to provide <a target=_
href="https://ignite.apache.org/";>Apache Ignite</a> configuration file path.
Note that Apache Ignite is used as a cluster computing
plane and a default distributed storage.
Server will automatically look for
<code>ignite.xml</code>
- configuration file in the same directory as
<code>apache-nlpcraft-incubating-{{site.latest_version}}-all-deps.jar</code>
file.
+ configuration file in the same directory as
<code>apache-nlpcraft-incubating-<b>{{site.latest_version}}</b>-all-deps.jar</code>
file.
If the configuration file has different name or in
different location use <code>-igniteConfig=path</code> parameter
where <code>path</code> is an absolute path to the
Ignite configuration file.
</dd>
@@ -268,7 +268,7 @@ id: server_and_probe
<code>/my/project</code> directory contains
user-defined model implementation
</li>
<li>
- Make sure to provide correct path to
<code>apache-nlpcraft-incubating-{{site.latest_version}}-all-deps.jar</code>
file.
+ Make sure to provide correct path to
<code>apache-nlpcraft-incubating-<b>{{site.latest_version}}</b>-all-deps.jar</code>
file.
</li>
<li>
Class <code>org.apache.nlpcraft.NCStart</code> is a
common entry point for all NLPCraft runtime components.
@@ -292,7 +292,7 @@ id: server_and_probe
<p>
<em>Optional</em> parameter to provide probe
configuration file path.
Data probe will automatically look for
<code>nlpcraft.conf</code> configuration file in the same directory
- as
<code>apache-nlpcraft-incubating-{{site.latest_version}}-all-deps.jar</code>
file. If the configuration
+ as
<code>apache-nlpcraft-incubating-<b>{{site.latest_version}}</b>-all-deps.jar</code>
file. If the configuration
file has different name or in different location
use <code>-config=path</code> parameter
where <code>path</code> is an absolute path to the
data probe configuration file. Note that the server and the data
probe can use the same file for their
configuration (like the
@@ -320,7 +320,7 @@ id: server_and_probe
</ul>
<p>
By default, when REST server or data probe start they look for
<code>nlpcraft.conf</code> configuration file in the same directory
- as
<code>apache-nlpcraft-incubating-{{site.latest_version}}-all-deps.jar</code>
file and the on their classpath. You can change this behavior with
+ as
<code>apache-nlpcraft-incubating-<b>{{site.latest_version}}</b>-all-deps.jar</code>
file and the on their classpath. You can change this behavior with
<code>-config=path</code> parameter.
</p>
<h3 class="section-sub-title">Separate Configurations</h3>
