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 2020/12/01 01:47:08 UTC
[incubator-nlpcraft-website] branch web-site updated: swagger
update.
This is an automated email from the ASF dual-hosted git repository.
aradzinski pushed a commit to branch web-site
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft-website.git
The following commit(s) were added to refs/heads/web-site by this push:
new 977cf67 swagger update.
977cf67 is described below
commit 977cf67d83f9789588c2183538421c4c5dc6a671
Author: Aaron Radzinski <ar...@datalingvo.com>
AuthorDate: Mon Nov 30 17:40:03 2020 -0800
swagger update.
---
basic-concepts.html | 2 +-
blogs.html | 2 +-
blogs/quick_intro_apache_nlpcraft.html | 2 +-
blogs/short_term_memory.html | 2 +-
community.html | 2 +-
data-model.html | 2 +-
docs.html | 2 +-
download.html | 2 +-
examples/alarm_clock.html | 2 +-
examples/light_switch.html | 2 +-
examples/sql_model.html | 2 +-
examples/weather_bot.html | 2 +-
feed.xml | 2 +-
first-example.html | 2 +-
getting-started.html | 2 +-
index.html | 2 +-
installation.html | 2 +-
integrations.html | 2 +-
intent-matching.html | 2 +-
metrics-and-tracing.html | 2 +-
openapi.html | 8399 --------------------------------
relnotes/release-notes-0.5.0.html | 2 +-
relnotes/release-notes-0.6.2.html | 2 +-
relnotes/release-notes-0.7.0.html | 2 +-
relnotes/release-notes-0.7.1.html | 2 +-
relnotes/release-notes-0.7.2.html | 2 +-
server-and-probe.html | 2 +-
tools/embedded_probe.html | 2 +-
tools/script.html | 2 +-
tools/sql_model_gen.html | 2 +-
tools/syn_tool.html | 2 +-
tools/test_framework.html | 2 +-
use-cases.html | 2 +-
using-rest.html | 4 +-
34 files changed, 34 insertions(+), 8433 deletions(-)
diff --git a/basic-concepts.html b/basic-concepts.html
index bda22ee..85c6218 100644
--- a/basic-concepts.html
+++ b/basic-concepts.html
@@ -15,4 +15,4 @@
limitations under the License.
-->
-<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
+<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
diff --git a/blogs.html b/blogs.html
index 730b891..39c1cd0 100644
--- a/blogs.html
+++ b/blogs.html
@@ -15,4 +15,4 @@
limitations under the License.
-->
-<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
+<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
diff --git a/blogs/quick_intro_apache_nlpcraft.html b/blogs/quick_intro_apache_nlpcraft.html
index f888c03..2468001 100644
--- a/blogs/quick_intro_apache_nlpcraft.html
+++ b/blogs/quick_intro_apache_nlpcraft.html
@@ -78,4 +78,4 @@
NCResult.text(s"Lights are [$status] in [${locations.toLowerCase}].")
}
}
- </pre><p><b>NOTES:</b></p><ul><li> We use an <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelFileAdapter.html">NCModelFileAdapter</a> adapter that allows us to load our static model configuration from a YAML file.<li> Method <code>onMatch(...)</code> is a callback function for our intent <code>"ls"</code> (define above in the <code>lightswitch_model.yaml</code> file).<li> Method <code>onMatch(...)</code> has two input parameters:<ul><li>A single token from the [...]
+ </pre><p><b>NOTES:</b></p><ul><li> We use an <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelFileAdapter.html">NCModelFileAdapter</a> adapter that allows us to load our static model configuration from a YAML file.<li> Method <code>onMatch(...)</code> is a callback function for our intent <code>"ls"</code> (define above in the <code>lightswitch_model.yaml</code> file).<li> Method <code>onMatch(...)</code> has two input parameters:<ul><li>A single token from the [...]
diff --git a/blogs/short_term_memory.html b/blogs/short_term_memory.html
index 4a3ad56..a805826 100644
--- a/blogs/short_term_memory.html
+++ b/blogs/short_term_memory.html
@@ -15,4 +15,4 @@
limitations under the License.
-->
-<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
+<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
diff --git a/community.html b/community.html
index 1ff3b9b..b55982b 100644
--- a/community.html
+++ b/community.html
@@ -36,4 +36,4 @@
</pre><li> Each time when you want to update your local <code>master</code> do the following:<pre class="brush: plain">
git pull upstream
git checkout release
- </pre></ul><div class="bq info"><p><b>Branch Naming in Forks</b></p><p> Note that you can use any naming scheme for the branches in your local forks (i.e. you can work in <code>master</code> branch in your local fork). However, when you up-merge from the GitHub mirror you need to make sure to use <code>release</code> branch to get the latest work-in-progress from the upstream.</p></div></ul><p>To make the contribution:</p><ul><li> Fix or implement JIRA ticket [...]
+ </pre></ul><div class="bq info"><p><b>Branch Naming in Forks</b></p><p> Note that you can use any naming scheme for the branches in your local forks (i.e. you can work in <code>master</code> branch in your local fork). However, when you up-merge from the GitHub mirror you need to make sure to use <code>release</code> branch to get the latest work-in-progress from the upstream.</p></div></ul><p>To make the contribution:</p><ul><li> Fix or implement JIRA ticket [...]
diff --git a/data-model.html b/data-model.html
index 876c538..d001015 100644
--- a/data-model.html
+++ b/data-model.html
@@ -337,4 +337,4 @@ intents:
</pre><p> Few notes on token DSL syntax:</p><ul><li> This synonym defines a composed named entity, i.e. named entity that consists of other named entities. In our example, we utilize token <code>nlpcraft:city</code> along with other basic synonym.<li> Token DSL expression always results in one and only one token when matched, however, the synonym can have multiple token DSL expressions.<li> Token DSL expression can have optional alias (<code>[city]</code>) that can be used in oth [...]
{qual}param op value
func({qual}param) op value
- </pre><p> The <code>{qual}param</code> is the left side parameter and it can have optional qualifier (<code>qual</code>). Qualifier allows to reference participant tokens either by their ID or their DSL expression's alias using dot-notation. For example:</p><table class="gradient-table"><thead><tr><th>Qualifier<th>Description<tbody><tr><td> <code><b>partId.</b>groups @@ 'my_grp'</code><td> There must be a participant token (i.e. constituent token) with either token ID or alias of [...]
+ </pre><p> The <code>{qual}param</code> is the left side parameter and it can have optional qualifier (<code>qual</code>). Qualifier allows to reference participant tokens either by their ID or their DSL expression's alias using dot-notation. For example:</p><table class="gradient-table"><thead><tr><th>Qualifier<th>Description<tbody><tr><td> <code><b>partId.</b>groups @@ 'my_grp'</code><td> There must be a participant token (i.e. constituent token) with either token ID or alias of [...]
diff --git a/docs.html b/docs.html
index a46e915..199c857 100644
--- a/docs.html
+++ b/docs.html
@@ -15,4 +15,4 @@
limitations under the License.
-->
-<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
+<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
diff --git a/download.html b/download.html
index 819a240..0383c11 100644
--- a/download.html
+++ b/download.html
@@ -62,4 +62,4 @@
}
</pre></div><div class="tab-pane fade" id="nav-java-client-sbt" role="tabpanel"><pre class="brush: scala">
libraryDependencies += "org.apache.nlpcraft" % "nlpcraft-java-client" % "0.5.0"
- </pre></div></div><div class="bq info"><p> <b>Latest Version</b></p><p> <code>0.5.0</code> is the latest Java Client version. You can replace it with a desired version.</p></div></section></div><div class="col-md-2 third-column"><ul class="side-nav"><li class="side-nav-title">On This Page<li><a href="#src">Source Release</a><li><a href="#zip">Binary Release</a><li><a href="#build">Building Binaries</a><li><a href="#verification">Verification</a><li><a href="#maven">Ma [...]
+ </pre></div></div><div class="bq info"><p> <b>Latest Version</b></p><p> <code>0.5.0</code> is the latest Java Client version. You can replace it with a desired version.</p></div></section></div><div class="col-md-2 third-column"><ul class="side-nav"><li class="side-nav-title">On This Page<li><a href="#src">Source Release</a><li><a href="#zip">Binary Release</a><li><a href="#build">Building Binaries</a><li><a href="#verification">Verification</a><li><a href="#maven">Ma [...]
diff --git a/examples/alarm_clock.html b/examples/alarm_clock.html
index f8794ff..8f59f43 100644
--- a/examples/alarm_clock.html
+++ b/examples/alarm_clock.html
@@ -156,4 +156,4 @@ public class AlarmModel extends NCModelFileAdapter {
timer.cancel();
}
}
- </pre><p> There's a bit of a logic here that deals mostly with taking multiple numeric values and converting them into a single number of milliseconds that the alarm clock needs to be set up for. Let's review it step by step:</p><ul><li> On <code>line 10</code> our class extends <code>NCModelFileAdapter</code> that allows us to load most of the model declaration from the external JSON or YAML file (line 18) and only provide functionality that we couldn't express in declarative po [...]
+ </pre><p> There's a bit of a logic here that deals mostly with taking multiple numeric values and converting them into a single number of milliseconds that the alarm clock needs to be set up for. Let's review it step by step:</p><ul><li> On <code>line 10</code> our class extends <code>NCModelFileAdapter</code> that allows us to load most of the model declaration from the external JSON or YAML file (line 18) and only provide functionality that we couldn't express in declarative po [...]
diff --git a/examples/light_switch.html b/examples/light_switch.html
index bc23789..c3e413f 100644
--- a/examples/light_switch.html
+++ b/examples/light_switch.html
@@ -118,4 +118,4 @@ class LightSwitchModel extends NCModelFileAdapter("org/apache/nlpcraft/examples/
NCResult.text(s"Lights '$status' in '${locations.toLowerCase}'.")
}
}
- </pre><p> The intent callback logic is very simple - we simply return a descriptive confirmation message back (explaining what lights were changed). With action and location detected - you can easily add the actual light switching using HomeKit or Arduino devices. Let's review this implementation step by step:</p><ul><li> On <code>line 5</code> our class extends <code>NCModelFileAdapter</code> that allows us to load most of the model declaration from the external YAML file and on [...]
+ </pre><p> The intent callback logic is very simple - we simply return a descriptive confirmation message back (explaining what lights were changed). With action and location detected - you can easily add the actual light switching using HomeKit or Arduino devices. Let's review this implementation step by step:</p><ul><li> On <code>line 5</code> our class extends <code>NCModelFileAdapter</code> that allows us to load most of the model declaration from the external YAML file and on [...]
diff --git a/examples/sql_model.html b/examples/sql_model.html
index 392e6a2..02939f9 100644
--- a/examples/sql_model.html
+++ b/examples/sql_model.html
@@ -48,4 +48,4 @@
Jul-05|08:40:47|INFO | H2 server start parameters: -baseDir /Users/minkovski/nlpcraft-examples/h2 -tcpPort 9092 -tcpAllowOthers
Jul-05|08:40:47|INFO | H2 server status: TCP server running at tcp://localhost:9092 (others can connect)
Jul-05|08:40:47|INFO | Database 'jdbc:h2:tcp://localhost:9092/nlp2sql' is NOT initialized because data already exists. To re-initialize - delete files in '/Users/minkovski/nlpcraft-examples/h2' folder and start again.
- </pre></section><section id="start_server"><h3 class="section-title">Start REST Server</h3><p> REST server listens for requests from client applications and routes them to the requested data models via connected data probes. REST server starts the same way as the data probe. Configure new Run Configuration in IDEA with the following parameters:</p><ul><li> <b>Main class:</b> <code>org.apache.nlpcraft.NCStart</code><li> <b>Program arguments: </b> <code>-server</code></ul><p> Once [...]
+ </pre></section><section id="start_server"><h3 class="section-title">Start REST Server</h3><p> REST server listens for requests from client applications and routes them to the requested data models via connected data probes. REST server starts the same way as the data probe. Configure new Run Configuration in IDEA with the following parameters:</p><ul><li> <b>Main class:</b> <code>org.apache.nlpcraft.NCStart</code><li> <b>Program arguments: </b> <code>-server</code></ul><p> Once [...]
diff --git a/examples/weather_bot.html b/examples/weather_bot.html
index e13df1a..0b13312 100644
--- a/examples/weather_bot.html
+++ b/examples/weather_bot.html
@@ -234,4 +234,4 @@ public class WeatherModel extends NCModelFileAdapter {
darkSky.stop();
}
}
- </pre><ul><li> <code>Line 146</code> loads the model configuration from the external <code>weather_model.json</code> file.<li> Method <code>preGeo(...)</code> on the <code>line 24</code> handles the geo location processing including IP-based geo-location and resolution of the geographical ambiguity.<li> <code>Line 97</code> defines a callback for the intent defined on the <code>line 71</code>. Note that callback implementation also deals with the temporal ambiguity.<li> <code>Lin [...]
+ </pre><ul><li> <code>Line 146</code> loads the model configuration from the external <code>weather_model.json</code> file.<li> Method <code>preGeo(...)</code> on the <code>line 24</code> handles the geo location processing including IP-based geo-location and resolution of the geographical ambiguity.<li> <code>Line 97</code> defines a callback for the intent defined on the <code>line 71</code>. Note that callback implementation also deals with the temporal ambiguity.<li> <code>Lin [...]
diff --git a/feed.xml b/feed.xml
index 0789e74..4b001fd 100644
--- a/feed.xml
+++ b/feed.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="4.1.1">Jekyll</generator><link href="http://localhost:4000/feed.xml" rel="self" type="application/atom+xml" /><link href="http://localhost:4000/" rel="alternate" type="text/html" /><updated>2020-11-29T21:30:01-08:00</updated><id>http://localhost:4000/feed.xml</id><title type="html">Apache NLPCraft</title></feed>
\ No newline at end of file
+<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="4.1.1">Jekyll</generator><link href="http://localhost:4000/feed.xml" rel="self" type="application/atom+xml" /><link href="http://localhost:4000/" rel="alternate" type="text/html" /><updated>2020-11-30T17:35:14-08:00</updated><id>http://localhost:4000/feed.xml</id><title type="html">Apache NLPCraft</title></feed>
\ No newline at end of file
diff --git a/first-example.html b/first-example.html
index 6a41ac3..f22dc65 100644
--- a/first-example.html
+++ b/first-example.html
@@ -114,4 +114,4 @@ class LightSwitchModel extends NCModelFileAdapter("examples/lightswitch_model.ya
NCResult.text(s"Lights '$status' in '${locations.toLowerCase}'.")
}
}
- </pre><p> Chapter <a href="/data-model.html">Data Model</a> will provide detailed explanation on how data models work. Here are few comments as to what this code does and how it is organized:</p><ul><li> On line 5 we use <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelFileAdapter.html">NCModelFileAdapter</a> to load its configuration from the external <code>examples/lightswitch_model.yaml</code> YAML file.<li> Our data model uses intent-based matching of t [...]
+ </pre><p> Chapter <a href="/data-model.html">Data Model</a> will provide detailed explanation on how data models work. Here are few comments as to what this code does and how it is organized:</p><ul><li> On line 5 we use <a target="javadoc" href="/apis/latest/org/apache/nlpcraft/model/NCModelFileAdapter.html">NCModelFileAdapter</a> to load its configuration from the external <code>examples/lightswitch_model.yaml</code> YAML file.<li> Our data model uses intent-based matching of t [...]
diff --git a/getting-started.html b/getting-started.html
index d03ce4d..b51e6f4 100644
--- a/getting-started.html
+++ b/getting-started.html
@@ -217,4 +217,4 @@
{
"status": "API_OK"
}
- </pre></section></div><div class="col-md-2 third-column"><ul class="side-nav"><li class="side-nav-title">On This Page<li><a href="#getting-started">Getting Started</a><li><a href="#probe-server">Data Probe <span class="amp">&</span> Server</a><li><a href="#querying">Using REST API</a><li class="side-nav-title">Quick Links<li> <i class="fab fa-fw fa-github mr-2"></i><a target="github" href="https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft/src/main/scala/org/ap [...]
+ </pre></section></div><div class="col-md-2 third-column"><ul class="side-nav"><li class="side-nav-title">On This Page<li><a href="#getting-started">Getting Started</a><li><a href="#probe-server">Data Probe <span class="amp">&</span> Server</a><li><a href="#querying">Using REST API</a><li class="side-nav-title">Quick Links<li> <i class="fab fa-fw fa-github mr-2"></i><a target="github" href="https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft/src/main/scala/org/ap [...]
diff --git a/index.html b/index.html
index d3b5338..bbe5934 100644
--- a/index.html
+++ b/index.html
@@ -15,4 +15,4 @@
limitations under the License.
-->
-<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
+<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
diff --git a/installation.html b/installation.html
index 4b10443..b2b860f 100644
--- a/installation.html
+++ b/installation.html
@@ -15,4 +15,4 @@
limitations under the License.
-->
-<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
+<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
diff --git a/integrations.html b/integrations.html
index 60e1c76..6323012 100644
--- a/integrations.html
+++ b/integrations.html
@@ -140,4 +140,4 @@ if __name__ == '__main__':
}
</pre></div><div class="tab-pane fade" id="nav-oracle-sbt" role="tabpanel"><pre class="brush: scala">
libraryDependencies += "org.oracle" % "ojdbc14" % "10.2.0.4.0"
- </pre></div></div><p> Comments:</p><ul><li> Make sure to change <code>10.2.0.4.0</code> version to the latest or required one.<li> Update configuration property <code>nlpcraft.server.database.jdbc</code> with required JDBC driver class and JDBC URL.<li> Use scripts from <code>sql/oracle</code> folder to create database and initialize DB schema.</ul></section><section> <img id="gridgain" class="img-title" src="/images/gridgain-logo.png" width="200px" alt=""><p> NLPCraf [...]
+ </pre></div></div><p> Comments:</p><ul><li> Make sure to change <code>10.2.0.4.0</code> version to the latest or required one.<li> Update configuration property <code>nlpcraft.server.database.jdbc</code> with required JDBC driver class and JDBC URL.<li> Use scripts from <code>sql/oracle</code> folder to create database and initialize DB schema.</ul></section><section> <img id="gridgain" class="img-title" src="/images/gridgain-logo.png" width="200px" alt=""><p> NLPCraf [...]
diff --git a/intent-matching.html b/intent-matching.html
index 07125f0..b6e5b85 100644
--- a/intent-matching.html
+++ b/intent-matching.html
@@ -108,4 +108,4 @@
flow='id1* >> (id1|id2)[1,2]'
term={id == 'mytok' && signum(~score['best']) != -1}
term={(groups @@ 'actors' || groups @@ 'owners') && size(partAlias.~text) > 10}
- </pre><p><b>NOTES:</b></p><ul><li> Intent has ID <code>id2</code>.<li> Intent has dialog flow pattern to match: <code>'id1* >> (id1|id2)[1,2]'</code>. It expect zero or more intents <code>id1</code> to matched immediately prior to this one and either one or two of <code>id1</code> or <code>id2</code> intents before that.<li> Intent has two non-conversational terms. Both terms have to be present only once (their implicit quantifiers are <code>[1,1]</code>).<li> First term should b [...]
+ </pre><p><b>NOTES:</b></p><ul><li> Intent has ID <code>id2</code>.<li> Intent has dialog flow pattern to match: <code>'id1* >> (id1|id2)[1,2]'</code>. It expect zero or more intents <code>id1</code> to matched immediately prior to this one and either one or two of <code>id1</code> or <code>id2</code> intents before that.<li> Intent has two non-conversational terms. Both terms have to be present only once (their implicit quantifiers are <code>[1,1]</code>).<li> First term should b [...]
diff --git a/metrics-and-tracing.html b/metrics-and-tracing.html
index cd1495c..7ca7280 100644
--- a/metrics-and-tracing.html
+++ b/metrics-and-tracing.html
@@ -37,4 +37,4 @@ nlpcraft {
...
}
}
- </pre><p> Just like with server exporters, each probe exporter has default configuration that can be overridden via <a href="server-and-probe.html">configuration</a> properties or environment variables. Note also that all built-in <b>trace exporters</b> use "always" sampling by default that is suitable only for demo or development purposes. For production usage you will need to modify the exporter to provide more effective <a target=_ href="https://opencensus.io/tracing/sampling/ [...]
+ </pre><p> Just like with server exporters, each probe exporter has default configuration that can be overridden via <a href="server-and-probe.html">configuration</a> properties or environment variables. Note also that all built-in <b>trace exporters</b> use "always" sampling by default that is suitable only for demo or development purposes. For production usage you will need to modify the exporter to provide more effective <a target=_ href="https://opencensus.io/tracing/sampling/ [...]
diff --git a/openapi.html b/openapi.html
deleted file mode 100644
index 448a818..0000000
--- a/openapi.html
+++ /dev/null
@@ -1,8399 +0,0 @@
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
--->
-
-<!--
-==================\/\/\/\/\/\/\/\/\/==================
--->
-
-<!DOCTYPE html>
-<!--suppress HtmlUnknownAttribute -->
-<html lang="en">
-<head>
- <!-- Global site tag (gtag.js) - Google Analytics -->
- <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script>
- <script>
- window.dataLayer = window.dataLayer || [];
- function gtag(){dataLayer.push(arguments);}
- gtag('js', new Date());
-
- gtag('config', 'UA-180663034-1');
- </script>
-
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <meta name="viewport" content="width=device-width, initial-scale=1.0, shrink-to-fit=no">
- <meta name="description" content="An open source API to convert natural language into actions.">
- <meta name="author" content="NLPCraft.">
-
- <link rel="apple-touch-icon" sizes="144x144" href="/apple-touch-icon.png">
- <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
- <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
- <link rel="manifest" href="/site.webmanifest">
- <link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5">
-
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/api-html@1.1.6/themes/compact/assets/css/bundle.min.css">
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/api-html@1.1.6/themes/compact/assets/css/style.css">
-
- <style>:root {--color-base: #4298fc; --color-base-light: #4298fc; --color-text: #FFF;}</style>
- <title>Apache NLPCraft API (0.7.2)</title>
- <style>
- body {
- letter-spacing: 0.02em;
- font-family: "Helvetica Neue", Helvetica, sans-serif;
- color: #333;
- }
-
- header {
- background: url(/images/bg-main-box.jpg) bottom center no-repeat;
- }
-
- aside * {z-index: 2;}
- aside div {position: relative;}
- aside::before {
- content: ' ';
- display: block;
- position: fixed;
- left: 0;
- top: 0;
- width: 320px;
- height: 100vh;
- z-index: 1;
- opacity: 0.2;
- background-image: linear-gradient(to bottom, #aaa, rgba(0, 0, 0, 0.2)), url(https://cdn.jsdelivr.net/npm/api-html@1.1.6/themes/compact/assets/img/patterns/5.svg);
- background-position: 50% 0;
- background-size: 500px auto;
- }
- .main-loader {
- position: fixed;
- z-index: 9999;
- top: 0;
- left: 0;
- width: 100vw;
- height: 100vh;
- background: white;
- }
- .main-loader img {
- position: relative;
- width: 150px;
- top: calc(50% - 10px);
- left: calc(50% - 75px);
- }
- .search-result a > strong, .search-result a > span {display: inline-block;}
-
- @media all and (max-width: 1350px) and (min-width: 1050px) {
- aside::before { width: 300px; }
- }
-
- @media all and (max-width: 1050px) {
- aside::before { width: 0; }
- }
- </style>
-
- <style>
- aside .uk-nav .uk-parent > a::after {
- background-image: url('data:image/svg+xml;base64;utf8,PHN2ZyB3aWR0aD0iMTQiIGhlaWdodD0iMTQiIHZpZXdCb3g9IjAgMCAyNCAyNCIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48cGF0aCBmaWxsPSIjRkZGIiBkPSJNMTIuNzI3MDAwNiwzLjY4NjYzNjc5IEMxMy4xMDYyMTk3LDMuMjg1MTI1NDMgMTMuMDg4MTQ4MiwyLjY1MjIxODQgMTIuNjg2NjM2OCwyLjI3Mjk5OTM3IEMxMi4yODUxMjU0LDEuODkzNzgwMzQgMTEuNjUyMjE4NCwxLjkxMTg1MTg1IDExLjI3Mjk5OTQsMi4zMTMzNjMyMSBMMi43NzI2ODg4NiwxMS4zMTMzNjMyIEMyLjQwODcxMDk5LDExLjY5ODczNzUgMi40MDg2ODY4LDEyLjMwMT [...]
- }
-
- aside .uk-nav .uk-parent.uk-open > a::after {
- background-image: url('data:image/svg+xml;base64;utf8,PHN2ZyB3aWR0aD0iMTIiIGhlaWdodD0iMTIiIHZpZXdCb3g9IjAgMCAyNS45MyAyNS45MyIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48cGF0aCBmaWxsPSIjRkZGIiBkPSJNMjUuMzk3LDQuNTU0aC0yLjA0MmwtOS45NzQsMTIuNjQ0Yy0wLjEwMSwwLjEyNC0wLjI1NiwwLjE5Ny0wLjQxNiwwLjE5N2MtMC4xNjQsMC0wLjMxNS0wLjA3My0wLjQxOS0wLjE5N0wyLjU3NSw0LjU1NCAgICAgICAgSDAuNTMyYy0wLjIwNiwwLTAuMzkyLDAuMTE1LTAuNDc5LDAuMjk5Yy0wLjA5LDAuMTg0LTAuMDY0LDAuNDAzLDAuMDYsMC41NjFsMTIuNDM1LDE1Ljc2 [...]
- }
-
- aside .uk-nav .uk-nav-sub .uk-parent > a::after {
- background-image: url('data:image/svg+xml;base64;utf8,PHN2ZyB3aWR0aD0iMTIiIGhlaWdodD0iMTIiIHZpZXdCb3g9IjAgMCAyNS45MyAyNS45MyIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48cGF0aCBmaWxsPSIjRkZGIiBkPSJNMjUuMzk3LDQuNTU0aC0yLjA0MmwtOS45NzQsMTIuNjQ0Yy0wLjEwMSwwLjEyNC0wLjI1NiwwLjE5Ny0wLjQxNiwwLjE5N2MtMC4xNjQsMC0wLjMxNS0wLjA3My0wLjQxOS0wLjE5N0wyLjU3NSw0LjU1NCAgICAgICAgSDAuNTMyYy0wLjIwNiwwLTAuMzkyLDAuMTE1LTAuNDc5LDAuMjk5Yy0wLjA5LDAuMTg0LTAuMDY0LDAuNDAzLDAuMDYsMC41NjFsMTIuNDM1LDE1Ljc2 [...]
- }
-
- div.search {
- color: #fff !important;
- }
-
- span.uk-icon {
- color: #fff !important;
- }
-
- input {
- color: #fff !important;
- }
-
- .uk-search-input::placeholder { /* Chrome, Firefox, Opera, Safari 10.1+ */
- color: #eee;
- opacity: 1; /* Firefox */
- }
-
- .uk-search-input::-ms-input-placeholder { /* Internet Explorer 10-11 */
- color: #eee;
- }
-
- .uk-search-input::-ms-input-placeholder { /* Microsoft Edge */
- color: #eee;
- }
- </style>
-</head>
-
-<!--
-==================\/\/\/\/\/\/\/\/\/==================
--->
-
-<body>
- <div class="main-loader">
- <img src="https://cdn.jsdelivr.net/npm/api-html@1.1.6/themes/compact/assets/img/loader.gif" />
- </div>
- <header>
- <!-- Left Hamburger menu, only visible in small devices -->
- <a class="btn-left-menu" uk-icon="menu"></a>
-
- <!-- Header links started -->
- <div class="links">
-
-
- </div>
- <!-- Header links ended -->
-
- <!-- Search started -->
- <div class="search">
- <!-- Search input form -->
- <form class="uk-search uk-search-default">
- <span class="uk-search-icon-flip" uk-search-icon></span>
- <input class="uk-search-input" type="search" placeholder="Search ...">
- </form>
-
- <!-- Search result started -->
- <div class="search-result"><div></div></div>
- <!-- Search result ended -->
- </div>
- <!-- Search ended -->
-
- <!-- Right side hamburger menu used, only visible in small screens -->
- <a class="btn-right-menu" style="color: #fff;" uk-icon="more-vertical"></a>
- <div uk-dropdown="mode: click; pos: bottom-right">
- <ul class="uk-nav uk-dropdown-nav main-menu-items"></ul>
- </div>
- </header>
-
- <!-- Left sidebar started -->
- <aside>
-
- <!-- Sidebar top section navigation started -->
- <div class="nav-top">
- <ul class="uk-nav-default uk-nav-parent-icon" uk-nav uk-scrollspy-nav="closest: li; scroll: false; offset: 80;">
- <!-- Multi-items left sidebar menu item -->
-
- <li class="uk-parent">
- <a>Authentication</a>
- <ul class="uk-nav-sub">
-
- <li>
- <a href="#signinpost-gGQk1"><span class="api-method api-method-post">post</span> Signs in and obtains new access token.</a>
- </li>
-
- <li>
- <a href="#signoutpost-ITW8o"><span class="api-method api-method-post">post</span> Signs out and releases access token.</a>
- </li>
-
- </ul>
- </li>
-
- <li class="uk-parent">
- <a>User</a>
- <ul class="uk-nav-sub">
-
- <li>
- <a href="#user-getpost-Bi8JE"><span class="api-method api-method-post">post</span> Gets current user information.</a>
- </li>
-
- <li>
- <a href="#user-allpost-eiPsw"><span class="api-method api-method-post">post</span> Gets all users.</a>
- </li>
-
- <li>
- <a href="#user-updatepost-rAkgf"><span class="api-method api-method-post">post</span> Updates regular user.</a>
- </li>
-
- <li>
- <a href="#user-deletepost-B4cL4"><span class="api-method api-method-post">post</span> Deletes user.</a>
- </li>
-
- <li>
- <a href="#user-adminpost-82M3T"><span class="api-method api-method-post">post</span> Updates user admin permissions.</a>
- </li>
-
- <li>
- <a href="#user-passwd-resetpost-5Tfuc"><span class="api-method api-method-post">post</span> Resets password for the user.</a>
- </li>
-
- <li>
- <a href="#user-addpost-0Whaz"><span class="api-method api-method-post">post</span> Adds new user.</a>
- </li>
-
- </ul>
- </li>
-
- <li class="uk-parent">
- <a>Company</a>
- <ul class="uk-nav-sub">
-
- <li>
- <a href="#company-getpost-urb8g"><span class="api-method api-method-post">post</span> Gets current user company information.</a>
- </li>
-
- <li>
- <a href="#company-addpost-ICtdN"><span class="api-method api-method-post">post</span> Adds new company.</a>
- </li>
-
- <li>
- <a href="#company-updatepost-yvd0g"><span class="api-method api-method-post">post</span> Updates company data.</a>
- </li>
-
- <li>
- <a href="#company-deletepost-ETfp1"><span class="api-method api-method-post">post</span> Deletes company.</a>
- </li>
-
- <li>
- <a href="#company-token-resetpost-j8zLx"><span class="api-method api-method-post">post</span> Resets company probe authentication token.</a>
- </li>
-
- </ul>
- </li>
-
- <li class="uk-parent">
- <a>Feedback</a>
- <ul class="uk-nav-sub">
-
- <li>
- <a href="#feedback-addpost-PeKOL"><span class="api-method api-method-post">post</span> Adds feedback.</a>
- </li>
-
- <li>
- <a href="#feedback-deletepost-hd2it"><span class="api-method api-method-post">post</span> Deletes feedback.</a>
- </li>
-
- <li>
- <a href="#feedback-allpost-xVhwK"><span class="api-method api-method-post">post</span> Gets feedback.</a>
- </li>
-
- </ul>
- </li>
-
- <li class="uk-parent">
- <a>Probe</a>
- <ul class="uk-nav-sub">
-
- <li>
- <a href="#probe-allpost-YocJO"><span class="api-method api-method-post">post</span> Gets all probes.</a>
- </li>
-
- </ul>
- </li>
-
- <li class="uk-parent">
- <a>Asking</a>
- <ul class="uk-nav-sub">
-
- <li>
- <a href="#clear-conversationpost-NOTIz"><span class="api-method api-method-post">post</span> Clears conversation STM.</a>
- </li>
-
- <li>
- <a href="#clear-dialogpost-ceth8"><span class="api-method api-method-post">post</span> Clears dialog flow.</a>
- </li>
-
- <li>
- <a href="#checkpost-lG213"><span class="api-method api-method-post">post</span> Gets status and result of submitted requests.</a>
- </li>
-
- <li>
- <a href="#cancelpost-FvCib"><span class="api-method api-method-post">post</span> Cancels a question.</a>
- </li>
-
- <li>
- <a href="#askpost-pJxZW"><span class="api-method api-method-post">post</span> Asks a question.</a>
- </li>
-
- <li>
- <a href="#ask-syncpost-Y4k6v"><span class="api-method api-method-post">post</span> Asks a question in synchronous mode.</a>
- </li>
-
- </ul>
- </li>
-
- <li class="uk-parent">
- <a>Tools</a>
- <ul class="uk-nav-sub">
-
- <li>
- <a href="#healthget-Oc3oL"><span class="api-method api-method-get">get</span> Health ping.</a>
- </li>
-
- <li>
- <a href="#model-sugsynpost-JjSHY"><span class="api-method api-method-post">post</span> Runs model synonym suggestion tool.</a>
- </li>
-
- </ul>
- </li>
-
- </ul>
- </div>
- <!-- Sidebar top section navigation ended -->
-
- <!-- -->
- </aside>
- <!-- Left sidebar ended -->
-
- <main>
- <!-- Tag name or apis chunk header name -->
- <h1 id="project-name"><a href="#project-name">Apache NLPCraft API (0.7.2)</a></h1>
- <p class="project-details">REST API for <a href="https://nlpcraft.apache.org">Apache NLPCraft</a> - an open source library for adding Natural Language Interface to any applications. For Data Model APIs see <a href="https://nlpcraft.apache.org/apis/latest/index.html">Javadoc</a> documentation.</p>
- <div class="encoding-type">
- <a class="encoding-type-name">openapi 2</a>
- <a class="encoding-type-file" href="https://raw.githubusercontent.com/apache/incubator-nlpcraft/master/openapi/nlpcraft_swagger.yml" title="https://raw.githubusercontent.com/apache/incubator-nlpcraft/master/openapi/nlpcraft_swagger.yml" target="_blank">Source url</a>
- </div>
- <hr class="api-divider uk-divider-icon" />
-
-
- <h2 style="margin-bottom: 40px;"><a href="#">Authentication</a></h2>
-
- <div class="path">
- <h3 id="signinpost-gGQk1"><a href="#signinpost-gGQk1">Signs in and obtains new access token.</a></h3>
- <p>Accepts user's email and password and returns a new access token that should be used in all subsequent API calls. An access token can expire or be invalidated on the server side and this call should be used to obtain it again in such cases.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/signin" uk-tooltip="Click to copy">/signin</span>
- <a class="api-path-try-btn" data-id="signinpost-gGQk1">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "email": "",
- "passwd": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>email</b>
- <i class="object-type">String</i>
-
- <i>Description: User sign in email.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>passwd</b>
- <i class="object-type">String</i>
-
- <i>Description: User password.</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "acsTok": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Temporary (session) access token that should be used for further REST calls</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/signin \
- --body '{"email":"","passwd":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/signin', {
- method: 'POST',
- body: {
- "email": "",
- "passwd": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/signin',
- body: {
- "email": "",
- "passwd": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/signin"
-
-headers = {
-
-}
-
-body = {
- "email": "",
- "passwd": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="signoutpost-ITW8o"><a href="#signoutpost-ITW8o">Signs out and releases access token.</a></h3>
- <p>Releases previously obtained access token. After this call given access token is no longer valid for authentication.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/signout" uk-tooltip="Click to copy">/signout</span>
- <a class="api-path-try-btn" data-id="signoutpost-ITW8o">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Previously obtained access token to release.</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/signout \
- --body '{"acsTok":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/signout', {
- method: 'POST',
- body: {
- "acsTok": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/signout',
- body: {
- "acsTok": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/signout"
-
-headers = {
-
-}
-
-body = {
- "acsTok": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
-
- <hr class="api-divider uk-divider-icon" />
-
- <h2 style="margin-bottom: 40px;"><a href="#">User</a></h2>
-
- <div class="path">
- <h3 id="user-getpost-Bi8JE"><a href="#user-getpost-Bi8JE">Gets current user information.</a></h3>
- <p>Gets current user information.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/user/get" uk-tooltip="Click to copy">/user/get</span>
- <a class="api-path-try-btn" data-id="user-getpost-Bi8JE">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "id": "",
- "usrExtId": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>id</b>
- <i class="object-type">Integer</i>
-
- <i>Description: ID of the user. Optional, caller user ID used by default. Getting information about other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: External 'on-behalf-of' ID of the user. Optional, caller user ID used by default. Getting information for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user.</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "id": "",
- "email": "",
- "usrExtId": "",
- "firstName": "",
- "lastName": "",
- "avatarUrl": "",
- "isAdmin": "",
- "properties": {}
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>id</b>
- <i class="object-type">Integer</i>
-
- <i>Description: User ID</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>email</b>
- <i class="object-type">String</i>
-
- <i>Description: User email</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: User external 'on-behalf-of' ID</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>firstName</b>
- <i class="object-type">String</i>
-
- <i>Description: User first or given name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>lastName</b>
- <i class="object-type">String</i>
-
- <i>Description: User last name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>avatarUrl</b>
- <i class="object-type">String</i>
-
- <i>Description: User avatar URL</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>isAdmin</b>
- <i class="object-type">Boolean</i>
-
- <i>Description: Whether or not user has Administrative privileges</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>properties</b>
- <i class="object-type">Object</i>
- </span>
-
- <ul></ul>
-
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/user/get \
- --body '{"acsTok":"","id":"","usrExtId":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/user/get', {
- method: 'POST',
- body: {
- "acsTok": "",
- "id": "",
- "usrExtId": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/user/get',
- body: {
- "acsTok": "",
- "id": "",
- "usrExtId": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/user/get"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "id": "",
- "usrExtId": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="user-allpost-eiPsw"><a href="#user-allpost-eiPsw">Gets all users.</a></h3>
- <p>Gets all users for the current user company. Administrative privileges required.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/user/all" uk-tooltip="Click to copy">/user/all</span>
- <a class="api-path-try-btn" data-id="user-allpost-eiPsw">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "users": {
- "id": "",
- "email": "",
- "usrExtId": "",
- "firstName": "",
- "lastName": "",
- "avatarUrl": "",
- "isAdmin": "",
- "properties": {}
- }
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>users</b>
- <i class="object-type">Array</i>
- </span>
-
- <ul>
- <li>
- <span>
- <b>id</b>
- <i class="object-type">Integer</i>
-
- <i>Description: User ID</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>email</b>
- <i class="object-type">String</i>
-
- <i>Description: User email</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: User external 'on-behalf-of' ID</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>firstName</b>
- <i class="object-type">String</i>
-
- <i>Description: User first or given name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>lastName</b>
- <i class="object-type">String</i>
-
- <i>Description: User last name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>avatarUrl</b>
- <i class="object-type">String</i>
-
- <i>Description: User avatar URL</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>isAdmin</b>
- <i class="object-type">Boolean</i>
-
- <i>Description: Whether or not user has Administrative privileges</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>properties</b>
- <i class="object-type">Object</i>
- </span>
-
- <ul></ul>
-
- </li>
- </ul>
-
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/user/all \
- --body '{"acsTok":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/user/all', {
- method: 'POST',
- body: {
- "acsTok": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/user/all',
- body: {
- "acsTok": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/user/all"
-
-headers = {
-
-}
-
-body = {
- "acsTok": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="user-updatepost-rAkgf"><a href="#user-updatepost-rAkgf">Updates regular user.</a></h3>
- <p>Updates user with given ID or the current user with given parameters. Administrative privileges required for updating other user.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/user/update" uk-tooltip="Click to copy">/user/update</span>
- <a class="api-path-try-btn" data-id="user-updatepost-rAkgf">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "id": "",
- "firstName": "",
- "lastName": "",
- "avatarUrl": "",
- "properties": {}
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>id</b>
- <i class="object-type">Integer</i>
-
- <i>Description: Optional ID of the user to update. Only administrators can provide this parameter. Current user ID is used by default.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>firstName</b>
- <i class="object-type">String</i>
-
- <i>Description: User first or given name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>lastName</b>
- <i class="object-type">String</i>
-
- <i>Description: User last name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>avatarUrl</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional user avatar URL</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>properties</b>
- <i class="object-type">Object</i>
- </span>
-
- <ul></ul>
-
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/user/update \
- --body '{"acsTok":"","id":"","firstName":"","lastName":"","avatarUrl":"","properties":{}}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/user/update', {
- method: 'POST',
- body: {
- "acsTok": "",
- "id": "",
- "firstName": "",
- "lastName": "",
- "avatarUrl": "",
- "properties": {}
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/user/update',
- body: {
- "acsTok": "",
- "id": "",
- "firstName": "",
- "lastName": "",
- "avatarUrl": "",
- "properties": {}
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/user/update"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "id": "",
- "firstName": "",
- "lastName": "",
- "avatarUrl": "",
- "properties": {}
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="user-deletepost-B4cL4"><a href="#user-deletepost-B4cL4">Deletes user.</a></h3>
- <p>Deletes user with given ID or the current user. Administrative privileges required for deleting other user.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/user/delete" uk-tooltip="Click to copy">/user/delete</span>
- <a class="api-path-try-btn" data-id="user-deletepost-B4cL4">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "id": "",
- "usrExtId": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>id</b>
- <i class="object-type">Integer</i>
-
- <i>Description: Optional ID of the user to delete. Only administrators can provide this parameter. Current user ID is used by default. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: External 'on-behalf-of' ID of the user to delete. Optional, caller user ID used by default. Administrative privileges are required to delete other users from the same company. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user.</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/user/delete \
- --body '{"acsTok":"","id":"","usrExtId":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/user/delete', {
- method: 'POST',
- body: {
- "acsTok": "",
- "id": "",
- "usrExtId": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/user/delete',
- body: {
- "acsTok": "",
- "id": "",
- "usrExtId": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/user/delete"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "id": "",
- "usrExtId": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="user-adminpost-82M3T"><a href="#user-adminpost-82M3T">Updates user admin permissions.</a></h3>
- <p>Updates user's permissions with given ID or the current user. Administrative privileges required for this operation.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/user/admin" uk-tooltip="Click to copy">/user/admin</span>
- <a class="api-path-try-btn" data-id="user-adminpost-82M3T">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "id": "",
- "isAdmin": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>id</b>
- <i class="object-type">Integer</i>
-
- <i>Description: Optional ID of the user to update - current user ID is used by default.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>isAdmin</b>
- <i class="object-type">Boolean</i>
-
- <i>Description: Administrative privileges flag to update to</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/user/admin \
- --body '{"acsTok":"","id":"","isAdmin":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/user/admin', {
- method: 'POST',
- body: {
- "acsTok": "",
- "id": "",
- "isAdmin": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/user/admin',
- body: {
- "acsTok": "",
- "id": "",
- "isAdmin": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/user/admin"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "id": "",
- "isAdmin": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="user-passwd-resetpost-5Tfuc"><a href="#user-passwd-resetpost-5Tfuc">Resets password for the user.</a></h3>
- <p>Resets the password for the user. Note that NLPCraft doesn't store password in reversible way and there is no way to retrieve the current password - user can only reset the password.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/user/passwd/reset" uk-tooltip="Click to copy">/user/passwd/reset</span>
- <a class="api-path-try-btn" data-id="user-passwd-resetpost-5Tfuc">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "id": "",
- "newPasswd": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Previously obtained access token to release.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>id</b>
- <i class="object-type">Integer</i>
-
- <i>Description: Optional ID of the user to reset password. Only admins can provide this parameter. Current user ID is used by default.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>newPasswd</b>
- <i class="object-type">String</i>
-
- <i>Description: New user password</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/user/passwd/reset \
- --body '{"acsTok":"","id":"","newPasswd":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/user/passwd/reset', {
- method: 'POST',
- body: {
- "acsTok": "",
- "id": "",
- "newPasswd": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/user/passwd/reset',
- body: {
- "acsTok": "",
- "id": "",
- "newPasswd": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/user/passwd/reset"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "id": "",
- "newPasswd": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="user-addpost-0Whaz"><a href="#user-addpost-0Whaz">Adds new user.</a></h3>
- <p>Adds new user with given parameters to the company of the admin caller. Administrative privileges required.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/user/add" uk-tooltip="Click to copy">/user/add</span>
- <a class="api-path-try-btn" data-id="user-addpost-0Whaz">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "email": "",
- "passwd": "",
- "firstName": "",
- "lastName": "",
- "avatarUrl": "",
- "isAdmin": "",
- "properties": {},
- "usrExtId": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>email</b>
- <i class="object-type">String</i>
-
- <i>Description: User email</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>passwd</b>
- <i class="object-type">String</i>
-
- <i>Description: User password</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>firstName</b>
- <i class="object-type">String</i>
-
- <i>Description: User first or given name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>lastName</b>
- <i class="object-type">String</i>
-
- <i>Description: User last name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>avatarUrl</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional user avatar URL</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>isAdmin</b>
- <i class="object-type">Boolean</i>
-
- <i>Description: Admin flag</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>properties</b>
- <i class="object-type">Object</i>
- </span>
-
- <ul></ul>
-
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional user external 'on-behalf-of' ID. If this field defined, method tries to find and update existing user.</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "id": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>id</b>
- <i class="object-type">Integer</i>
-
- <i>Description: ID of the newly created user</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/user/add \
- --body '{"acsTok":"","email":"","passwd":"","firstName":"","lastName":"","avatarUrl":"","isAdmin":"","properties":{},"usrExtId":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/user/add', {
- method: 'POST',
- body: {
- "acsTok": "",
- "email": "",
- "passwd": "",
- "firstName": "",
- "lastName": "",
- "avatarUrl": "",
- "isAdmin": "",
- "properties": {},
- "usrExtId": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/user/add',
- body: {
- "acsTok": "",
- "email": "",
- "passwd": "",
- "firstName": "",
- "lastName": "",
- "avatarUrl": "",
- "isAdmin": "",
- "properties": {},
- "usrExtId": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/user/add"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "email": "",
- "passwd": "",
- "firstName": "",
- "lastName": "",
- "avatarUrl": "",
- "isAdmin": "",
- "properties": {},
- "usrExtId": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
-
- <hr class="api-divider uk-divider-icon" />
-
- <h2 style="margin-bottom: 40px;"><a href="#">Company</a></h2>
-
- <div class="path">
- <h3 id="company-getpost-urb8g"><a href="#company-getpost-urb8g">Gets current user company information.</a></h3>
- <p>Gets current user company information.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/company/get" uk-tooltip="Click to copy">/company/get</span>
- <a class="api-path-try-btn" data-id="company-getpost-urb8g">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "id": "",
- "name": "",
- "website": "",
- "country": "",
- "region": "",
- "city": "",
- "address": "",
- "postalCode": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>id</b>
- <i class="object-type">Integer</i>
-
- <i>Description: Company ID</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>name</b>
- <i class="object-type">String</i>
-
- <i>Description: Company name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>website</b>
- <i class="object-type">String</i>
-
- <i>Description: Copmany website</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>country</b>
- <i class="object-type">String</i>
-
- <i>Description: Company country</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>region</b>
- <i class="object-type">String</i>
-
- <i>Description: Company region</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>city</b>
- <i class="object-type">String</i>
-
- <i>Description: Company city</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>address</b>
- <i class="object-type">String</i>
-
- <i>Description: Company address</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>postalCode</b>
- <i class="object-type">String</i>
-
- <i>Description: Company postal code</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/company/get \
- --body '{"acsTok":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/company/get', {
- method: 'POST',
- body: {
- "acsTok": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/company/get',
- body: {
- "acsTok": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/company/get"
-
-headers = {
-
-}
-
-body = {
- "acsTok": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="company-addpost-ICtdN"><a href="#company-addpost-ICtdN">Adds new company.</a></h3>
- <p>Adds new company with given parameters. Administrative privileges required.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/company/add" uk-tooltip="Click to copy">/company/add</span>
- <a class="api-path-try-btn" data-id="company-addpost-ICtdN">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "name": "",
- "website": "",
- "country": "",
- "region": "",
- "city": "",
- "address": "",
- "postalCode": "",
- "adminEmail": "",
- "adminPasswd": "",
- "adminFirstName": "",
- "adminLastName": "",
- "adminAvatarUrl": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>name</b>
- <i class="object-type">String</i>
-
- <i>Description: Company name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>website</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional company website address</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>country</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional company country</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>region</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional company region</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>city</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional company city</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>address</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional company address</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>postalCode</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional company postal code</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>adminEmail</b>
- <i class="object-type">String</i>
-
- <i>Description: Admin user email</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>adminPasswd</b>
- <i class="object-type">String</i>
-
- <i>Description: Admin user password</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>adminFirstName</b>
- <i class="object-type">String</i>
-
- <i>Description: Admin user first or given name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>adminLastName</b>
- <i class="object-type">String</i>
-
- <i>Description: Admin user last name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>adminAvatarUrl</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional admin user avatar URL</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "token": "",
- "adminId": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>token</b>
- <i class="object-type">String</i>
-
- <i>Description: Company probes authentication token</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>adminId</b>
- <i class="object-type">Integer</i>
-
- <i>Description: ID of the newly created admin user</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/company/add \
- --body '{"acsTok":"","name":"","website":"","country":"","region":"","city":"","address":"","postalCode":"","adminEmail":"","adminPasswd":"","adminFirstName":"","adminLastName":"","adminAvatarUrl":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/company/add', {
- method: 'POST',
- body: {
- "acsTok": "",
- "name": "",
- "website": "",
- "country": "",
- "region": "",
- "city": "",
- "address": "",
- "postalCode": "",
- "adminEmail": "",
- "adminPasswd": "",
- "adminFirstName": "",
- "adminLastName": "",
- "adminAvatarUrl": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/company/add',
- body: {
- "acsTok": "",
- "name": "",
- "website": "",
- "country": "",
- "region": "",
- "city": "",
- "address": "",
- "postalCode": "",
- "adminEmail": "",
- "adminPasswd": "",
- "adminFirstName": "",
- "adminLastName": "",
- "adminAvatarUrl": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/company/add"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "name": "",
- "website": "",
- "country": "",
- "region": "",
- "city": "",
- "address": "",
- "postalCode": "",
- "adminEmail": "",
- "adminPasswd": "",
- "adminFirstName": "",
- "adminLastName": "",
- "adminAvatarUrl": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="company-updatepost-yvd0g"><a href="#company-updatepost-yvd0g">Updates company data.</a></h3>
- <p>Updates company data with given parameters. Administrative privileges required.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/company/update" uk-tooltip="Click to copy">/company/update</span>
- <a class="api-path-try-btn" data-id="company-updatepost-yvd0g">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "name": "",
- "website": "",
- "country": "",
- "region": "",
- "city": "",
- "address": "",
- "postalCode": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>name</b>
- <i class="object-type">String</i>
-
- <i>Description: Company name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>website</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional company website address</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>country</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional company country</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>region</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional company region</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>city</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional company city</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>address</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional company address</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>postalCode</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional company postal code</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/company/update \
- --body '{"acsTok":"","name":"","website":"","country":"","region":"","city":"","address":"","postalCode":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/company/update', {
- method: 'POST',
- body: {
- "acsTok": "",
- "name": "",
- "website": "",
- "country": "",
- "region": "",
- "city": "",
- "address": "",
- "postalCode": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/company/update',
- body: {
- "acsTok": "",
- "name": "",
- "website": "",
- "country": "",
- "region": "",
- "city": "",
- "address": "",
- "postalCode": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/company/update"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "name": "",
- "website": "",
- "country": "",
- "region": "",
- "city": "",
- "address": "",
- "postalCode": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="company-deletepost-ETfp1"><a href="#company-deletepost-ETfp1">Deletes company.</a></h3>
- <p>Deletes company. Administrative privileges required.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/company/delete" uk-tooltip="Click to copy">/company/delete</span>
- <a class="api-path-try-btn" data-id="company-deletepost-ETfp1">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/company/delete \
- --body '{"acsTok":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/company/delete', {
- method: 'POST',
- body: {
- "acsTok": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/company/delete',
- body: {
- "acsTok": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/company/delete"
-
-headers = {
-
-}
-
-body = {
- "acsTok": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="company-token-resetpost-j8zLx"><a href="#company-token-resetpost-j8zLx">Resets company probe authentication token.</a></h3>
- <p>Sets and returns new company probe authentication token. Administrative privileges required for resetting company token.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/company/token/reset" uk-tooltip="Click to copy">/company/token/reset</span>
- <a class="api-path-try-btn" data-id="company-token-resetpost-j8zLx">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "token": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>token</b>
- <i class="object-type">String</i>
-
- <i>Description: Newly reset company probes authentication token</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/company/token/reset \
- --body '{"acsTok":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/company/token/reset', {
- method: 'POST',
- body: {
- "acsTok": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/company/token/reset',
- body: {
- "acsTok": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/company/token/reset"
-
-headers = {
-
-}
-
-body = {
- "acsTok": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
-
- <hr class="api-divider uk-divider-icon" />
-
- <h2 style="margin-bottom: 40px;"><a href="#">Feedback</a></h2>
-
- <div class="path">
- <h3 id="feedback-addpost-PeKOL"><a href="#feedback-addpost-PeKOL">Adds feedback.</a></h3>
- <p>Adds feedback for processed user request.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/feedback/add" uk-tooltip="Click to copy">/feedback/add</span>
- <a class="api-path-try-btn" data-id="feedback-addpost-PeKOL">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqId": "",
- "score": "",
- "comment": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrId</b>
- <i class="object-type">Integer</i>
-
- <i>Description: User ID.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: External user ID. Note user with given ID will be created if missing</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>srvReqId</b>
- <i class="object-type">String</i>
-
- <i>Description: Server request ID</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>score</b>
- <i class="object-type">Number</i>
-
- <i>Description: Score. Valid range is between 0 and 1, inclusive</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>comment</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional feedback comment</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "id": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>id</b>
- <i class="object-type">Integer</i>
-
- <i>Description: ID of the newly created feedback record</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/feedback/add \
- --body '{"acsTok":"","usrId":"","usrExtId":"","srvReqId":"","score":"","comment":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/feedback/add', {
- method: 'POST',
- body: {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqId": "",
- "score": "",
- "comment": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/feedback/add',
- body: {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqId": "",
- "score": "",
- "comment": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/feedback/add"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqId": "",
- "score": "",
- "comment": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="feedback-deletepost-hd2it"><a href="#feedback-deletepost-hd2it">Deletes feedback.</a></h3>
- <p>Deletes feedback for given record ID. Administrative privileges required for deleting feedback from other users.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/feedback/delete" uk-tooltip="Click to copy">/feedback/delete</span>
- <a class="api-path-try-btn" data-id="feedback-deletepost-hd2it">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "id": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>id</b>
- <i class="object-type">Integer</i>
-
- <i>Description: Feedback record ID to delete.</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/feedback/delete \
- --body '{"acsTok":"","id":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/feedback/delete', {
- method: 'POST',
- body: {
- "acsTok": "",
- "id": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/feedback/delete',
- body: {
- "acsTok": "",
- "id": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/feedback/delete"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "id": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="feedback-allpost-xVhwK"><a href="#feedback-allpost-xVhwK">Gets feedback.</a></h3>
- <p>Gets all request feedback records. Administrative privileges required for getting feedback from other users.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/feedback/all" uk-tooltip="Click to copy">/feedback/all</span>
- <a class="api-path-try-btn" data-id="feedback-allpost-xVhwK">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqId": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrId</b>
- <i class="object-type">Integer</i>
-
- <i>Description: ID of the user to get feedback records for. Optional, caller user ID used by default. Getting feedback for other users requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: External 'on-behalf-of' ID of the user to get feedback records for. Optional, caller user ID used by default. Getting feedback for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user. Note that if only external 'on-behalf-of' user ID is provided and such user doesn't yet exist in NLPCraft - it will be created with this ID.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>srvReqId</b>
- <i class="object-type">String</i>
-
- <i>Description: Server request ID</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "feedbacks": {
- "id": "",
- "srvReqId": "",
- "usrId": "",
- "score": "",
- "comment": "",
- "createTstamp": ""
- }
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>feedbacks</b>
- <i class="object-type">Array</i>
- </span>
-
- <ul>
- <li>
- <span>
- <b>id</b>
- <i class="object-type">Integer</i>
-
- <i>Description: Feedback ID</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>srvReqId</b>
- <i class="object-type">String</i>
-
- <i>Description: Server request ID</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrId</b>
- <i class="object-type">Integer</i>
-
- <i>Description: User ID</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>score</b>
- <i class="object-type">Number</i>
-
- <i>Description: Feedback score</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>comment</b>
- <i class="object-type">String</i>
-
- <i>Description: Feedback comment</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>createTstamp</b>
- <i class="object-type">Integer</i>
-
- <i>Description: Creation UTC/GMT timestamp of the request</i>
-
- </span>
- </li>
- </ul>
-
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/feedback/all \
- --body '{"acsTok":"","usrId":"","usrExtId":"","srvReqId":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/feedback/all', {
- method: 'POST',
- body: {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqId": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/feedback/all',
- body: {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqId": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/feedback/all"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqId": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
-
- <hr class="api-divider uk-divider-icon" />
-
- <h2 style="margin-bottom: 40px;"><a href="#">Probe</a></h2>
-
- <div class="path">
- <h3 id="probe-allpost-YocJO"><a href="#probe-allpost-YocJO">Gets all probes.</a></h3>
- <p>Gets metadata for all active (currently connected) probes. Administrative privileges required.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/probe/all" uk-tooltip="Click to copy">/probe/all</span>
- <a class="api-path-try-btn" data-id="probe-allpost-YocJO">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "probes": {
- "probeToken": "",
- "probeId": "",
- "probeGuid": "",
- "probeApiVersion": "",
- "probeApiDate": "",
- "osVersion": "",
- "osName": "",
- "osArch": "",
- "startTstamp": "",
- "tmzId": "",
- "tmzAbbr": "",
- "tmzName": "",
- "userName": "",
- "javaVersion": "",
- "javaVendor": "",
- "hostName": "",
- "hostAddr": "",
- "macAddr": "",
- "models": {
- "id": "",
- "name": "",
- "version": "",
- "enabledBuiltInTokens": []
- }
- }
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>probes</b>
- <i class="object-type">Array</i>
- </span>
-
- <ul>
- <li>
- <span>
- <b>probeToken</b>
- <i class="object-type">String</i>
-
- <i>Description: Probe token</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>probeId</b>
- <i class="object-type">String</i>
-
- <i>Description: Probe ID (user defined ID)</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>probeGuid</b>
- <i class="object-type">String</i>
-
- <i>Description: Probe GUID (globally unique internal ID)</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>probeApiVersion</b>
- <i class="object-type">String</i>
-
- <i>Description: Probe API version</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>probeApiDate</b>
- <i class="object-type">String</i>
-
- <i>Description: Probe API date</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>osVersion</b>
- <i class="object-type">String</i>
-
- <i>Description: OS version</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>osName</b>
- <i class="object-type">String</i>
-
- <i>Description: OS name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>osArch</b>
- <i class="object-type">String</i>
-
- <i>Description: OS architecture</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>startTstamp</b>
- <i class="object-type">Integer</i>
-
- <i>Description: Start time in UTC.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>tmzId</b>
- <i class="object-type">String</i>
-
- <i>Description: Timezone ID</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>tmzAbbr</b>
- <i class="object-type">String</i>
-
- <i>Description: Timezone abbreviation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>tmzName</b>
- <i class="object-type">String</i>
-
- <i>Description: Timezone name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>userName</b>
- <i class="object-type">String</i>
-
- <i>Description: User name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>javaVersion</b>
- <i class="object-type">String</i>
-
- <i>Description: Java version</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>javaVendor</b>
- <i class="object-type">String</i>
-
- <i>Description: Java vendor</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>hostName</b>
- <i class="object-type">String</i>
-
- <i>Description: Host name</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>hostAddr</b>
- <i class="object-type">String</i>
-
- <i>Description: Host address</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>macAddr</b>
- <i class="object-type">String</i>
-
- <i>Description: MAC address</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>models</b>
- <i class="object-type">Array</i>
- </span>
-
- <ul>
- <li>
- <span>
- <b>id</b>
- <i class="object-type">String</i>
-
- <i>Description: Model ID (unique, immutable ID)</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>name</b>
- <i class="object-type">String</i>
-
- <i>Description: Model name (descriptive name of this model)</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>version</b>
- <i class="object-type">String</i>
-
- <i>Description: Model version</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>enabledBuiltInTokens</b>
- <i class="object-type">Array</i>
- </span>
-
- <ul></ul>
-
- </li>
- </ul>
-
- </li>
- </ul>
-
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/probe/all \
- --body '{"acsTok":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/probe/all', {
- method: 'POST',
- body: {
- "acsTok": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/probe/all',
- body: {
- "acsTok": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/probe/all"
-
-headers = {
-
-}
-
-body = {
- "acsTok": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
-
- <hr class="api-divider uk-divider-icon" />
-
- <h2 style="margin-bottom: 40px;"><a href="#">Asking</a></h2>
-
- <div class="path">
- <h3 id="clear-conversationpost-NOTIz"><a href="#clear-conversationpost-NOTIz">Clears conversation STM.</a></h3>
- <p>Clears conversation for given user and data model. Essentially makes NLPCraft forget about previously stored sentences and the next request will be processed as if at the start of the new conversation.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/clear/conversation" uk-tooltip="Click to copy">/clear/conversation</span>
- <a class="api-path-try-btn" data-id="clear-conversationpost-NOTIz">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "mdlId": "",
- "usrId": "",
- "usrExtId": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>mdlId</b>
- <i class="object-type">String</i>
-
- <i>Description: Data model ID for which to clear conversation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrId</b>
- <i class="object-type">Integer</i>
-
- <i>Description: User ID for which to clear conversation. Optional, caller user ID used by default. Clearing conversation for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: External 'on-behalf-of' user ID for which to clear conversation. Optional, caller user ID used by default. Clearing conversation for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user. Note that if only external 'on-behalf-of' user ID is provided and such user doesn't yet exist in NLPCraft - it will be created with this ID.</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/clear/conversation \
- --body '{"acsTok":"","mdlId":"","usrId":"","usrExtId":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/clear/conversation', {
- method: 'POST',
- body: {
- "acsTok": "",
- "mdlId": "",
- "usrId": "",
- "usrExtId": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/clear/conversation',
- body: {
- "acsTok": "",
- "mdlId": "",
- "usrId": "",
- "usrExtId": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/clear/conversation"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "mdlId": "",
- "usrId": "",
- "usrExtId": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="clear-dialogpost-ceth8"><a href="#clear-dialogpost-ceth8">Clears dialog flow.</a></h3>
- <p>Clears dialog flow for given user and data model by forgetting all previously matched intents. It is an important operation for intents that use dialog flow in their matching logic.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/clear/dialog" uk-tooltip="Click to copy">/clear/dialog</span>
- <a class="api-path-try-btn" data-id="clear-dialogpost-ceth8">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "mdlId": "",
- "usrId": "",
- "usrExtId": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>mdlId</b>
- <i class="object-type">String</i>
-
- <i>Description: Data model ID for which to clear dialog flow</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrId</b>
- <i class="object-type">Integer</i>
-
- <i>Description: User ID for which to clear dialog flow. Optional, caller user ID used by default. Clearing dialog flow for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: External 'on-behalf-of' user ID for which to clear dialog flow. Optional, caller user ID used by default. Clearing dialog flow for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user. Note that if only external 'on-behalf-of' user ID is provided and such user doesn't yet exist in NLPCraft - it will be created with this ID.</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/clear/dialog \
- --body '{"acsTok":"","mdlId":"","usrId":"","usrExtId":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/clear/dialog', {
- method: 'POST',
- body: {
- "acsTok": "",
- "mdlId": "",
- "usrId": "",
- "usrExtId": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/clear/dialog',
- body: {
- "acsTok": "",
- "mdlId": "",
- "usrId": "",
- "usrExtId": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/clear/dialog"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "mdlId": "",
- "usrId": "",
- "usrExtId": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="checkpost-lG213"><a href="#checkpost-lG213">Gets status and result of submitted requests.</a></h3>
- <p>Gets the status and result (OK or failure) of the previously submitted requests. Request statuses returned sorted by their registration time, starting from newest.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/check" uk-tooltip="Click to copy">/check</span>
- <a class="api-path-try-btn" data-id="checkpost-lG213">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqIds": [],
- "maxRows": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrId</b>
- <i class="object-type">Integer</i>
-
- <i>Description: User ID for which to check the results. Optional, caller user ID used by default. Checking results for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: External 'on-behalf-of' user ID for which to check the results. Optional, caller user ID used by default. Checking results for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user. Note that if only external 'on-behalf-of' user ID is provided and such user doesn't yet exist in NLPCraft - it will be created with this ID.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>srvReqIds</b>
- <i class="object-type">Array</i>
- </span>
-
- <ul></ul>
-
- </li>
-
- <li>
- <span>
- <b>maxRows</b>
- <i class="object-type">Integer</i>
-
- <i>Description: Optional maximum number of returned items - by default all items will be returned</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "states": {
- "srvReqId": "",
- "txt": "",
- "usrId": "",
- "intentId": "",
- "mdlId": "",
- "probeId": "",
- "status": "",
- "resType": "",
- "resBody": {},
- "error": "",
- "errorCode": "",
- "logHolder": {}
- }
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>states</b>
- <i class="object-type">Array</i>
- </span>
-
- <ul>
- <li>
- <span>
- <b>srvReqId</b>
- <i class="object-type">String</i>
-
- <i>Description: Server request ID</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>txt</b>
- <i class="object-type">String</i>
-
- <i>Description: Original request text</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrId</b>
- <i class="object-type">Integer</i>
-
- <i>Description: ID of the user that submitted the request</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>intentId</b>
- <i class="object-type">String</i>
-
- <i>Description: ID of the intent</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>mdlId</b>
- <i class="object-type">String</i>
-
- <i>Description: ID of the model</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>probeId</b>
- <i class="object-type">String</i>
-
- <i>Description: ID of the data probe</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Current status of this request (QRY_READY indicates that result - error or ok - is ready)</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>resType</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional result type if returned by model (provided only if status is QRY_READY and processing was not rejected or terminated due to an exception)</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>resBody</b>
- <i class="object-type">Object</i>
- </span>
-
- <ul></ul>
-
- </li>
-
- <li>
- <span>
- <b>error</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional error if returned by model (provided only if status is QRY_READY and processing was rejected or terminated due to an exception)</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>errorCode</b>
- <i class="object-type">Integer</i>
-
- <i>Description: Optional error code indicating a type of error. Only present of 'error' field is present. One of the following values: 1 - Rejection by the data model. 100 - Unexpected system error. 101 - Model's result is too big. 102 - Recoverable system error. 10001 - Too many unknown words. 10002 - Sentence is too complex (too many free words). 10003 - Too many suspicious or unrelated words. 10004 - Swear words found and are not allowed. 10005 - Sentence contains no nou [...]
-
- </span>
- </li>
-
- <li>
- <span>
- <b>logHolder</b>
- <i class="object-type">Object</i>
- </span>
-
- <ul></ul>
-
- </li>
- </ul>
-
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/check \
- --body '{"acsTok":"","usrId":"","usrExtId":"","srvReqIds":[],"maxRows":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/check', {
- method: 'POST',
- body: {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqIds": [],
- "maxRows": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/check',
- body: {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqIds": [],
- "maxRows": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/check"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqIds": [],
- "maxRows": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="cancelpost-FvCib"><a href="#cancelpost-FvCib">Cancels a question.</a></h3>
- <p>Cancels the previously submitted sentence and removes its result, if any, from the server storage. Must be called when query result is no longer needed (i.e. downloaded by all client apps) to release the server memory. Note that query results will auto-expire on server after a certain period of time. Note also that even when the embedded probe is used the results are still stored on the server and have to be cancelled or otherwise will be timed out.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/cancel" uk-tooltip="Click to copy">/cancel</span>
- <a class="api-path-try-btn" data-id="cancelpost-FvCib">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqIds": []
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrId</b>
- <i class="object-type">Integer</i>
-
- <i>Description: ID of the user whose requests to cancel. Optional, caller user ID used by default. Cancelling requests for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: External 'on-behalf-of' ID of the user whose requests to cancel. Optional, caller user ID used by default. Cancelling requests for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user. Note that if only external 'on-behalf-of' user ID is provided and such user doesn't yet exist in NLPCraft - it will be created with this ID.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>srvReqIds</b>
- <i class="object-type">Array</i>
- </span>
-
- <ul></ul>
-
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/cancel \
- --body '{"acsTok":"","usrId":"","usrExtId":"","srvReqIds":[]}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/cancel', {
- method: 'POST',
- body: {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqIds": []
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/cancel',
- body: {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqIds": []
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/cancel"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "srvReqIds": []
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="askpost-pJxZW"><a href="#askpost-pJxZW">Asks a question.</a></h3>
- <p>Submits the sentence to be processed asynchronously. Use '/check' call to get status and result, and '/cancel' call to discard the result from the server storage without waiting for auto-expiration.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/ask" uk-tooltip="Click to copy">/ask</span>
- <a class="api-path-try-btn" data-id="askpost-pJxZW">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "txt": "",
- "mdlId": "",
- "data": {},
- "enableLog": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrId</b>
- <i class="object-type">Integer</i>
-
- <i>Description: ID of the user submitting the question. Optional, caller user ID used by default. Submitting questions for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: External 'on-behalf-of' ID of the user submitting the question. Optional, caller user ID used by default. Submitting questions for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user. Note that if only external 'on-behalf-of' user ID is provided and such user doesn't yet exist in NLPCraft - it will be created with this ID.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>txt</b>
- <i class="object-type">String</i>
-
- <i>Description: Text of the question</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>mdlId</b>
- <i class="object-type">String</i>
-
- <i>Description: Model ID.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>data</b>
- <i class="object-type">Object</i>
- </span>
-
- <ul></ul>
-
- </li>
-
- <li>
- <span>
- <b>enableLog</b>
- <i class="object-type">Boolean</i>
-
- <i>Description: Flag to enable detailed processing log to be returned with the result</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "srvReqId": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>srvReqId</b>
- <i class="object-type">String</i>
-
- <i>Description: Server ID assigned to the new processing request</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/ask \
- --body '{"acsTok":"","usrId":"","usrExtId":"","txt":"","mdlId":"","data":{},"enableLog":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/ask', {
- method: 'POST',
- body: {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "txt": "",
- "mdlId": "",
- "data": {},
- "enableLog": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/ask',
- body: {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "txt": "",
- "mdlId": "",
- "data": {},
- "enableLog": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/ask"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "txt": "",
- "mdlId": "",
- "data": {},
- "enableLog": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="ask-syncpost-Y4k6v"><a href="#ask-syncpost-Y4k6v">Asks a question in synchronous mode.</a></h3>
- <p>Submits the sentence to be processed synchronously and returns the result immediately. This call will block until the result is ready or the waiting is timed out.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/ask/sync" uk-tooltip="Click to copy">/ask/sync</span>
- <a class="api-path-try-btn" data-id="ask-syncpost-Y4k6v">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "txt": "",
- "mdlId": "",
- "data": {},
- "enableLog": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrId</b>
- <i class="object-type">Integer</i>
-
- <i>Description: ID of the user submitting the question. Optional, caller user ID used by default. Submitting questions for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrExtId</b>
- <i class="object-type">String</i>
-
- <i>Description: External 'on-behalf-of' ID of the user submitting the question. Optional, caller user ID used by default. Submitting questions for other users from the same company requires administrative privileges. If both user ID and external 'on-behalf-of' user ID are provided they have to point to the same NLPCraft user. Note that if only external 'on-behalf-of' user ID is provided and such user doesn't yet exist in NLPCraft - it will be created with this ID.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>txt</b>
- <i class="object-type">String</i>
-
- <i>Description: Text of the question</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>mdlId</b>
- <i class="object-type">String</i>
-
- <i>Description: Model ID.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>data</b>
- <i class="object-type">Object</i>
- </span>
-
- <ul></ul>
-
- </li>
-
- <li>
- <span>
- <b>enableLog</b>
- <i class="object-type">Boolean</i>
-
- <i>Description: Flag to enable detailed processing log to be returned with the result</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "state": {
- "srvReqId": "",
- "txt": "",
- "usrId": "",
- "intentId": "",
- "mdlId": "",
- "probeId": "",
- "status": "",
- "resType": "",
- "resBody": {},
- "error": "",
- "errorCode": "",
- "logHolder": {}
- }
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>state</b>
- <i class="object-type">Object</i>
- </span>
-
- <ul>
- <li>
- <span>
- <b>srvReqId</b>
- <i class="object-type">String</i>
-
- <i>Description: Server request ID</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>txt</b>
- <i class="object-type">String</i>
-
- <i>Description: Original request text</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>usrId</b>
- <i class="object-type">Integer</i>
-
- <i>Description: ID of the user that submitted the request</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>intentId</b>
- <i class="object-type">String</i>
-
- <i>Description: ID of the intent</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>mdlId</b>
- <i class="object-type">String</i>
-
- <i>Description: ID of the model</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>probeId</b>
- <i class="object-type">String</i>
-
- <i>Description: ID of the data probe</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Current status of this request (QRY_READY indicates that result - error or ok - is ready)</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>resType</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional result type if returned by model (provided only if status is QRY_READY and processing was not rejected or terminated due to an exception)</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>resBody</b>
- <i class="object-type">Object</i>
- </span>
-
- <ul></ul>
-
- </li>
-
- <li>
- <span>
- <b>error</b>
- <i class="object-type">String</i>
-
- <i>Description: Optional error if returned by model (provided only if status is QRY_READY and processing was rejected or terminated due to an exception)</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>errorCode</b>
- <i class="object-type">Integer</i>
-
- <i>Description: Optional error code indicating a type of error. Only present of 'error' field is present.</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>logHolder</b>
- <i class="object-type">Object</i>
- </span>
-
- <ul></ul>
-
- </li>
- </ul>
-
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/ask/sync \
- --body '{"acsTok":"","usrId":"","usrExtId":"","txt":"","mdlId":"","data":{},"enableLog":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/ask/sync', {
- method: 'POST',
- body: {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "txt": "",
- "mdlId": "",
- "data": {},
- "enableLog": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/ask/sync',
- body: {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "txt": "",
- "mdlId": "",
- "data": {},
- "enableLog": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/ask/sync"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "usrId": "",
- "usrExtId": "",
- "txt": "",
- "mdlId": "",
- "data": {},
- "enableLog": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
-
- <hr class="api-divider uk-divider-icon" />
-
- <h2 style="margin-bottom: 40px;"><a href="#">Tools</a></h2>
-
- <div class="path">
- <h3 id="healthget-Oc3oL"><a href="#healthget-Oc3oL">Health ping.</a></h3>
- <p>Pings server for HTTP 200 code.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-get uk-label">get</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/health" uk-tooltip="Click to copy">/health</span>
- <a class="api-path-try-btn" data-id="healthget-Oc3oL">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request GET \
- --url http://localhost:8081/api/v1/health</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/health', {
- method: 'GET',
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'GET',
- url: 'http://localhost:8081/api/v1/health',
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/health"
-
-headers = {
-
-}
-
-response = requests.GET(url, headers=headers)</code></pre>
- </div>
- </div>
- </div>
- <hr class="api-divider" />
- <div class="path">
- <h3 id="model-sugsynpost-JjSHY"><a href="#model-sugsynpost-JjSHY">Runs model synonym suggestion tool.</a></h3>
- <p>Runs model synonym suggestion tool that is based on BERT models and uses @NCIntentSample annotation. Administrative privileges required.</p>
-
- <div uk-alert class="path-url">
- <span class="api-method api-method-post uk-label">post</span>
- <span class="root">http://localhost:8081/api/v1</span>
- <span class="link" data-copy="http://localhost:8081/api/v1/model/sugsyn" uk-tooltip="Click to copy">/model/sugsyn</span>
- <a class="api-path-try-btn" data-id="model-sugsynpost-JjSHY">Try out</a>
- </div>
-
- <ul class="path-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="request">Request</a></li>
- <li><a href="#" data-tab="response">Response</a></li>
- <li><a href="#" data-tab="coding">Coding</a></li>
- </ul>
-
- <div class="tab path-tab path-tab-request">
-
- <p>body</p>
- <div class="blocks">
-
- <div class="blocks-block">
- <div class="blocks-block-info-col">
- <span>Payload body</span>
- <span class="attr red">required</span>
- </div>
- <div class="blocks-block-desc-col">
-
-
-
- <span class="gray details">JSON request.</span>
-
- <div class="request-box-details">
-
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
-
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "acsTok": "",
- "mdlId": "",
- "minScore": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>acsTok</b>
- <i class="object-type">String</i>
-
- <i>Description: Access token obtain via '/signin' call</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>mdlId</b>
- <i class="object-type">String</i>
-
- <i>Description: ID of the model to run synonym suggestion on</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>minScore</b>
- <i class="object-type">Number</i>
-
- <i>Description: Minimal score to include into the result (from 0 to 1, default is 0)</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
-
- </div>
-
- </div>
-
- <div class="tab path-tab path-tab-response" style="display: none;">
-
- <h4>200</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Successful operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "result": {}
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this operation</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>result</b>
- <i class="object-type">Object</i>
- </span>
-
- <ul></ul>
-
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- <h4>400</h4>
- <div class="blocks">
- <div class="blocks-block">
- <div class="blocks-block-desc-col" style="padding: 0 5px;">
- <span class="gray details">Failed operation.</span><br />
- <div class="request-box-details">
- <ul uk-tab style="margin-bottom: 5px;">
- <li class="uk-active"><a href="#" class="btn-model-example">Example Value</a></li>
- <li><a href="#" class="btn-model-definition">Model</a></li>
- </ul>
-
- <div class="highlight model-example">
- <pre><code class="language-javascript" data-lang="javascript">{
- "status": "",
- "reason": ""
-}</code></pre>
- </div>
-
-
- <div class="model-definition" style="display: none;">
- <div class="wtree">
- <ul>
- <li>
- <span>
- <b>status</b>
- <i class="object-type">String</i>
- <i>Enum: </i>
- <i>Description: Status code of this error</i>
-
- </span>
- </li>
-
- <li>
- <span>
- <b>reason</b>
- <i class="object-type">String</i>
-
- <i>Description: Reason for this error</i>
-
- </span>
- </li>
- </ul>
- </div>
- </div>
-
- </div>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <div class="tab path-tab path-tab-coding" style="display: none;">
- <ul class="uk-flex-right code-tabs" uk-tab>
- <li class="uk-active"><a href="#" data-tab="curl">cURL</a></li>
- <li><a href="#" data-tab="javascript">JavaScript</a></li>
- <li><a href="#" data-tab="node">Node</a></li>
- <li><a href="#" data-tab="python">Python</a></li>
- </ul>
- <div class="tab-code tab-code-curl">
- <pre><code class="bash">curl --request POST \
- --url http://localhost:8081/api/v1/model/sugsyn \
- --body '{"acsTok":"","mdlId":"","minScore":""}'</code></pre>
- </div>
- <div class="tab-code tab-code-javascript" style="display: none">
- <pre><code class="javascript">fetch('http://localhost:8081/api/v1/model/sugsyn', {
- method: 'POST',
- body: {
- "acsTok": "",
- "mdlId": "",
- "minScore": ""
- },
-})
-.then(e => e.json())
-.then((data) => {
- console.log('Request succeeded with JSON response', data);
-})
-.catch((error) => {
- console.log('Request failed', error);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-node" style="display: none">
- <pre><code class="javascript">const request = require('request');
-
-const options = {
- method: 'POST',
- url: 'http://localhost:8081/api/v1/model/sugsyn',
- body: {
- "acsTok": "",
- "mdlId": "",
- "minScore": ""
- },
-};
-
-request(options, function (error, response, body) {
- if (error) throw new Error(error);
-
- console.log(body);
-});</code></pre>
- </div>
- <div class="tab-code tab-code-python" style="display: none">
- <pre><code class="python">import requests
-
-url = "http://localhost:8081/api/v1/model/sugsyn"
-
-headers = {
-
-}
-
-body = {
- "acsTok": "",
- "mdlId": "",
- "minScore": ""
-}
-
-response = requests.POST(url, headers=headers, body=body)</code></pre>
- </div>
- </div>
- </div>
-
- <hr class="api-divider uk-divider-icon" />
-
- </main>
-
- <style>.api-path-try-btn{display: none;}</style>
-
-
-
- <script>window.color = {base: '#4298fc', text: '#FFF'};</script>
- <script id="pathsObjectScript">window.pathsObject = {"auths":[],"rootUrl":"http://localhost:8081/api/v1","paths":[{"requests":[{"items":[{"name":"Payload body","description":"JSON request.","required":true,"modelExample":"{\n \"email\": \"\",\n \"passwd\": \"\"\n}"}],"title":"body"}],"responses":[{"name":"200","description":"Successful operation.","headers":[],"modelExample":"{\n \"status\": \"\",\n \"acsTok\": \"\"\n}"},{"name":"400","description":"Failed operation.","he [...]
- <script src="https://cdn.jsdelivr.net/npm/api-html@1.1.6/themes/compact/assets/js/bundle.min.js"></script>
- <script src="https://cdn.jsdelivr.net/npm/api-html@1.1.6/themes/compact/assets/js/scripts.js"></script>
- <script src="https://cdn.jsdelivr.net/npm/api-html@1.1.6/themes/compact/assets/js/single.api.js"></script>
- <script src="https://cdn.jsdelivr.net/npm/api-html@1.1.6/themes/compact/assets/js/popup.api.js" id="popupScript"></script>
-
-</body>
-</html>
diff --git a/relnotes/release-notes-0.5.0.html b/relnotes/release-notes-0.5.0.html
index 8aeb294..18929ba 100644
--- a/relnotes/release-notes-0.5.0.html
+++ b/relnotes/release-notes-0.5.0.html
@@ -15,4 +15,4 @@
limitations under the License.
-->
-<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
+<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
diff --git a/relnotes/release-notes-0.6.2.html b/relnotes/release-notes-0.6.2.html
index 312baae..85cb1d7 100644
--- a/relnotes/release-notes-0.6.2.html
+++ b/relnotes/release-notes-0.6.2.html
@@ -15,4 +15,4 @@
limitations under the License.
-->
-<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
+<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
diff --git a/relnotes/release-notes-0.7.0.html b/relnotes/release-notes-0.7.0.html
index bf90641..c2b8863 100644
--- a/relnotes/release-notes-0.7.0.html
+++ b/relnotes/release-notes-0.7.0.html
@@ -15,4 +15,4 @@
limitations under the License.
-->
-<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
+<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
diff --git a/relnotes/release-notes-0.7.1.html b/relnotes/release-notes-0.7.1.html
index f8a326b..e61ae64 100644
--- a/relnotes/release-notes-0.7.1.html
+++ b/relnotes/release-notes-0.7.1.html
@@ -15,4 +15,4 @@
limitations under the License.
-->
-<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
+<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
diff --git a/relnotes/release-notes-0.7.2.html b/relnotes/release-notes-0.7.2.html
index d6274d6..46ad1cd 100644
--- a/relnotes/release-notes-0.7.2.html
+++ b/relnotes/release-notes-0.7.2.html
@@ -15,4 +15,4 @@
limitations under the License.
-->
-<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
+<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
diff --git a/server-and-probe.html b/server-and-probe.html
index 5b7c42c..41c7285 100644
--- a/server-and-probe.html
+++ b/server-and-probe.html
@@ -193,4 +193,4 @@ nlpcraft {
</execution>
</executions>
</plugin>
- </pre><p> <b>NOTES</b>:</p><ul><li> On line 14 we specify the URL endpoint to check whether or not our server is online. We use <code>/health</code> localhost REST call for that.<li> On line 16 we redirect the output from server to a dedicated file to <b>avoid interleaving</b> log from server and log from data probe in the same console (where we are running the Maven build from). Such interleaving will make the combined log unreadable and can cause output problem for the console [...]
+ </pre><p> <b>NOTES</b>:</p><ul><li> On line 14 we specify the URL endpoint to check whether or not our server is online. We use <code>/health</code> localhost REST call for that.<li> On line 16 we redirect the output from server to a dedicated file to <b>avoid interleaving</b> log from server and log from data probe in the same console (where we are running the Maven build from). Such interleaving will make the combined log unreadable and can cause output problem for the console [...]
diff --git a/tools/embedded_probe.html b/tools/embedded_probe.html
index a89afa0..e2613d5 100644
--- a/tools/embedded_probe.html
+++ b/tools/embedded_probe.html
@@ -44,4 +44,4 @@ public class AlarmTest {
assertTrue(cli.ask("Set my alarm for 30s").isOk());
}
}
- </pre><p> Notes:</p><ul><li> Lines 6 and 18 show the embedded data probe start and stop as it's used in the unit tests.</ul><p> It's important to note that there are number of inherent limitations associated with embedded probe:</p><ul><li> Embedded probe is only available for JVM-based applications (and can be used with any JVM languages).<li> There can be only one embedded probe per JVM.<li> Once data probe is stopped and cannot be re-started again in the same JVM.<li> Even tho [...]
+ </pre><p> Notes:</p><ul><li> Lines 6 and 18 show the embedded data probe start and stop as it's used in the unit tests.</ul><p> It's important to note that there are number of inherent limitations associated with embedded probe:</p><ul><li> Embedded probe is only available for JVM-based applications (and can be used with any JVM languages).<li> There can be only one embedded probe per JVM.<li> Once data probe is stopped and cannot be re-started again in the same JVM.<li> Even tho [...]
diff --git a/tools/script.html b/tools/script.html
index 7772d58..f475c76 100644
--- a/tools/script.html
+++ b/tools/script.html
@@ -21,4 +21,4 @@
> $mvn clean package
</pre><p style="margin-left: 20px"> Runs Maven build in the current directory.</p><pre class="brush: plain">
> $cmd /c dir
- </pre><p style="margin-left: 20px"> Runs Windows <code>dir</code> command in the current directory using a separate shell.</p><p> Note that <em>stdin</em>, <em>stderr</em> and <em>stdout</em> of the new process will inherit from running <code>bin/nlpcraft.{sh|cmd}</code> script process. Running OS commands makes the most sense in REPL mode where you don't want to lose a session context while executing external OS commands. Technically, however, external OS commands can be execute [...]
+ </pre><p style="margin-left: 20px"> Runs Windows <code>dir</code> command in the current directory using a separate shell.</p><p> Note that <em>stdin</em>, <em>stderr</em> and <em>stdout</em> of the new process will inherit from running <code>bin/nlpcraft.{sh|cmd}</code> script process. Running OS commands makes the most sense in REPL mode where you don't want to lose a session context while executing external OS commands. Technically, however, external OS commands can be execute [...]
diff --git a/tools/sql_model_gen.html b/tools/sql_model_gen.html
index 597ddc3..7c0efb2 100644
--- a/tools/sql_model_gen.html
+++ b/tools/sql_model_gen.html
@@ -131,4 +131,4 @@ EXAMPLES:
-s public
-e "#_.+"
-o model.json
- </pre><p> After the data model stub is generated:</p><ul><li> Load generated YAML/JSON-based model using <a target="javadoc" href="https://javadoc.io/static/org.apache.nlpcraft/nlpcraft/0.5.0/org/apache/nlpcraft/model/NCModelFileAdapter.html">NCModelFileAdapter</a> class to instantiate model from this file.<li> Modify and extend generated model stub to your own needs. In most cases, you'll need to add, remove or modify auto-generated synonyms, add intents, etc. Note, however, tha [...]
+ </pre><p> After the data model stub is generated:</p><ul><li> Load generated YAML/JSON-based model using <a target="javadoc" href="https://javadoc.io/static/org.apache.nlpcraft/nlpcraft/0.5.0/org/apache/nlpcraft/model/NCModelFileAdapter.html">NCModelFileAdapter</a> class to instantiate model from this file.<li> Modify and extend generated model stub to your own needs. In most cases, you'll need to add, remove or modify auto-generated synonyms, add intents, etc. Note, however, tha [...]
diff --git a/tools/syn_tool.html b/tools/syn_tool.html
index 659660d..c5ff27f 100644
--- a/tools/syn_tool.html
+++ b/tools/syn_tool.html
@@ -93,4 +93,4 @@
"Model has too few (3) intents samples. It will negatively affect the quality of suggestions. Try to increase overall sample count to at least 20."
]
}
- </pre><p> The result is structured as a list of proposed synonyms with their corresponding scores for each model's element. You should analyse the results for their fitness for your model and its existing synonyms. The tool cannot guarantee that every suggested synonym is appropriate or valid - but it gives a good "courtesy" check for potentially missing synonyms.</p><div class="bq info"><p> <b>Run Periodically</b></p><p> It is a good idea to run this tool periodically if you are [...]
+ </pre><p> The result is structured as a list of proposed synonyms with their corresponding scores for each model's element. You should analyse the results for their fitness for your model and its existing synonyms. The tool cannot guarantee that every suggested synonym is appropriate or valid - but it gives a good "courtesy" check for potentially missing synonyms.</p><div class="bq info"><p> <b>Run Periodically</b></p><p> It is a good idea to run this tool periodically if you are [...]
diff --git a/tools/test_framework.html b/tools/test_framework.html
index 9ff67b9..b048f42 100644
--- a/tools/test_framework.html
+++ b/tools/test_framework.html
@@ -61,4 +61,4 @@ public class AlarmModel extends NCModelFileAdapter {
}
</pre><p> Auto model validator will scan the model for its callback methods, collect all samples from <code>@NCIntentSample</code> annotations, and will submit each sample and check that correct intent is selected as the winning match. Notice that this auto validation does not require any additional code to be written - the tool gathers all required information from the model itself.</p><p> Add necessary classpath to and run:</p><pre class="brush: plain">
java -ea -DNLPCRAFT_TEST_MODELS=org.apache.nlpcraft.examples.alarm.AlarmModel org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator
- </pre><p> Notes:</p><ul><li> When running auto validator from command line you set models to test via <code>NLPCRAFT_TEST_MODELS</code> system property that should contain comma separate list of the data model classes.</ul><p> In the log output you should see the following validation results:</p><figure> <img class="img-fluid-no-border" src="/images/auto_validation.png" alt=""><figcaption><b>Fig 1.</b> Model Auto-Validation Result.</figcaption></figure><p> See <a target="javadoc" [...]
+ </pre><p> Notes:</p><ul><li> When running auto validator from command line you set models to test via <code>NLPCRAFT_TEST_MODELS</code> system property that should contain comma separate list of the data model classes.</ul><p> In the log output you should see the following validation results:</p><figure> <img class="img-fluid-no-border" src="/images/auto_validation.png" alt=""><figcaption><b>Fig 1.</b> Model Auto-Validation Result.</figcaption></figure><p> See <a target="javadoc" [...]
diff --git a/use-cases.html b/use-cases.html
index e601460..c4253a0 100644
--- a/use-cases.html
+++ b/use-cases.html
@@ -15,4 +15,4 @@
limitations under the License.
-->
-<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
+<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
diff --git a/using-rest.html b/using-rest.html
index 15a6988..6467465 100644
--- a/using-rest.html
+++ b/using-rest.html
@@ -15,11 +15,11 @@
limitations under the License.
-->
-<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
+<!doctype html><html lang="en"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-180663034-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-180663034-1'); </script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="An open sourc [...]
https://localhost:8081/api/v1/signin
</pre><p> where:<dl><dt><code>http</code><dd>Either <code>http</code> or <code>https</code> protocol.<dt><code>localhost:8081</code><dd>Host and port on which REST server is started. <code>localhost:8081</code> is the default configuration and can be <a href="/server-and-probe.html">changed</a>.<dt><code>/api/v1</code><dd>Mandatory prefix indicating API version.<dt><code>/signin</code><dd>Specific REST path.</dl><div class="bq info"><p> <b>Management Script</b></p><p> <a href="/t [...]
{
"code": "NC_INVALID_ACCESS_TOKEN",
"msg": "Unknown access token: PPdxjwXBOIMpAWNgpKq1"
}
- </pre><p> Following tables shows all possible <code>code</code> values for these server errors:</p><table class="gradient-table"><thead><tr><th>Code<th>Description<tbody><tr><td><code>NC_INVALID_ACCESS_TOKEN</code><td> The access token is invalid or no longer valid. Note that previously issued existing access tokens can expire or be otherwise invalidated and have to be obtained again.<tr><td><code>NC_SIGNIN_FAILURE</code><td> Invalid or unknown user email and/or user password dur [...]
+ </pre><p> Following tables shows all possible <code>code</code> values for these server errors:</p><table class="gradient-table"><thead><tr><th>Code<th>Description<tbody><tr><td><code>NC_INVALID_ACCESS_TOKEN</code><td> The access token is invalid or no longer valid. Note that previously issued existing access tokens can expire or be otherwise invalidated and have to be obtained again.<tr><td><code>NC_SIGNIN_FAILURE</code><td> Invalid or unknown user email and/or user password dur [...]