blob: 21ef6de9c1207853e8515874e710b14754a4ae4e [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_161) on Thu Apr 30 21:50:54 PDT 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>NCEmbeddedResult (Apache NLPCraft 0.5.0)</title>
<meta name="date" content="2020-04-30">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="NCEmbeddedResult (Apache NLPCraft 0.5.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<link href="https://stackpath.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet"> <script src="../../../../../resources/sh/scripts/XRegExp.js" type="text/javascript"></script> <script src="../../../../../resources/sh/scripts/shCore.js" type="text/javascript"></script> <script src="../../../../../resources/sh/scripts/shAutoloader.js" type="text/javascript"></script> <link href="../../../../../resources/sh/styles/shCoreNLPCraft.css" rel="stylesheet" type="text/css" title="Style"> <link href="../../../../../resources/sh/styles/shThemeNLPCraft.css" rel="stylesheet" type="text/css" title="Style"> <link href="https://fonts.googleapis.com/css?family=Roboto+Mono" rel="stylesheet"> <script async defer src="https://buttons.github.io/buttons.js"></script>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/NCEmbeddedResult.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">Apache NLPCraft <span style="font-size: 80%">0.5.0</span></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/nlpcraft/probe/embedded/NCEmbeddedProbe.html" title="class in org.apache.nlpcraft.probe.embedded"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/nlpcraft/probe/embedded/NCEmbeddedResult.html" target="_top">Frames</a></li>
<li><a href="NCEmbeddedResult.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.nlpcraft.probe.embedded</div>
<h2 title="Interface NCEmbeddedResult" class="title">Interface NCEmbeddedResult</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">NCEmbeddedResult</span></pre>
<div class="block">Result container for the embedded probe. When an embedded probe completes query processing for one of its
deployed models it calls registered callbacks, if any, with this container before the results are sent back
to the REST server.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/nlpcraft/probe/embedded/NCEmbeddedProbe.html#registerCallback-java.util.function.Consumer-"><code>NCEmbeddedProbe.registerCallback(Consumer)</code></a>,
<a href="../../../../../org/apache/nlpcraft/probe/embedded/NCEmbeddedProbe.html#unregisterCallback-java.util.function.Consumer-"><code>NCEmbeddedProbe.unregisterCallback(Consumer)</code></a>,
<a href="../../../../../org/apache/nlpcraft/model/NCResult.html" title="class in org.apache.nlpcraft.model"><code>NCResult</code></a>,
<a href="../../../../../org/apache/nlpcraft/probe/embedded/NCEmbeddedProbe.html" title="class in org.apache.nlpcraft.probe.embedded"><code>NCEmbeddedProbe</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/nlpcraft/probe/embedded/NCEmbeddedResult.html#getBody--">getBody</a></span>()</code>
<div class="block">Gets optional result body.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/nlpcraft/probe/embedded/NCEmbeddedResult.html#getErrorCode--">getErrorCode</a></span>()</code>
<div class="block">Gets optional error code.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/nlpcraft/probe/embedded/NCEmbeddedResult.html#getErrorMessage--">getErrorMessage</a></span>()</code>
<div class="block">Gets optional error message.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/nlpcraft/probe/embedded/NCEmbeddedResult.html#getLogHolder--">getLogHolder</a></span>()</code>
<div class="block">Gets request processing log holder as JSON string.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/nlpcraft/probe/embedded/NCEmbeddedResult.html#getModelId--">getModelId</a></span>()</code>
<div class="block">Gets the ID of the model that produced this result.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/nlpcraft/probe/embedded/NCEmbeddedResult.html#getOriginalText--">getOriginalText</a></span>()</code>
<div class="block">Gets original text of the request that produced this result.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/nlpcraft/probe/embedded/NCEmbeddedResult.html#getProbeId--">getProbeId</a></span>()</code>
<div class="block">Gets ID of the probe this result was generated by.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/nlpcraft/probe/embedded/NCEmbeddedResult.html#getServerRequestId--">getServerRequestId</a></span>()</code>
<div class="block">Gets ID of the request that produced this result.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/nlpcraft/probe/embedded/NCEmbeddedResult.html#getType--">getType</a></span>()</code>
<div class="block">Gets optional result type.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/nlpcraft/probe/embedded/NCEmbeddedResult.html#getUserId--">getUserId</a></span>()</code>
<div class="block">Gets ID of the user that made the request this result is for.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getModelId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getModelId</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getModelId()</pre>
<div class="block">Gets the ID of the model that produced this result. Note that embedded probe can host more than one
data model hence this parameter is important to distinguish to which model this result belongs.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ID of the model produced this result.</dd>
</dl>
</li>
</ul>
<a name="getServerRequestId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServerRequestId</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getServerRequestId()</pre>
<div class="block">Gets ID of the request that produced this result.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ID of the request that produced this result.</dd>
</dl>
</li>
</ul>
<a name="getOriginalText--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOriginalText</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getOriginalText()</pre>
<div class="block">Gets original text of the request that produced this result.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Original text of the request that produced this result.</dd>
</dl>
</li>
</ul>
<a name="getUserId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserId</h4>
<pre>long&nbsp;getUserId()</pre>
<div class="block">Gets ID of the user that made the request this result is for.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ID of the user that made the request this result is for.</dd>
</dl>
</li>
</ul>
<a name="getBody--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBody</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getBody()</pre>
<div class="block">Gets optional result body. Note that either both result body and type are set or
error message and error code are set, but not both pairs.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Result body or <code>null</code> if error occurred.</dd>
</dl>
</li>
</ul>
<a name="getType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getType()</pre>
<div class="block">Gets optional result type. Note that either both result body and type are set or
error message and error code are set, but not both pairs.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Result type or <code>null</code> if error occurred.</dd>
</dl>
</li>
</ul>
<a name="getErrorMessage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getErrorMessage</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getErrorMessage()</pre>
<div class="block">Gets optional error message.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Error message or <code>null</code> if no errors occurred.</dd>
</dl>
</li>
</ul>
<a name="getErrorCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getErrorCode</h4>
<pre>int&nbsp;getErrorCode()</pre>
<div class="block">Gets optional error code. One of the following codes:
<table class="dl-table" summary="">
<thead>
<tr>
<th>Code</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>1</code></td>
<td>Rejected by the model.</td>
</tr>
<tr>
<td><code>100</code></td>
<td>Unexpected system error.</td>
</tr>
<tr>
<td><code>101</code></td>
<td>Model's result is too big.</td>
</tr>
<tr>
<td><code>102</code></td>
<td>Recoverable system error.</td>
</tr>
<tr>
<td><code>10001</code></td>
<td>Too many unknown words.</td>
</tr>
<tr>
<td><code>10002</code></td>
<td>Sentence is too complex (too many free words).</td>
</tr>
<tr>
<td><code>10003</code></td>
<td>Too many suspicious or unrelated words.</td>
</tr>
<tr>
<td><code>10004</code></td>
<td>Swear words found and are not allowed.</td>
</tr>
<tr>
<td><code>10005</code></td>
<td>Sentence contains no nouns.</td>
</tr>
<tr>
<td><code>10006</code></td>
<td>Only latin charset is supported.</td>
</tr>
<tr>
<td><code>10007</code></td>
<td>Only english language is supported.</td>
</tr>
<tr>
<td><code>10008</code></td>
<td>Sentence seems unrelated to data model.</td>
</tr>
<tr>
<td><code>10009</code></td>
<td>Sentence is too short (before processing).</td>
</tr>
<tr>
<td><code>10010</code></td>
<td>Sentence is ambiguous.</td>
</tr>
<tr>
<td><code>10011</code></td>
<td>Sentence is too short (after processing).</td>
</tr>
<tr>
<td><code>10012</code></td>
<td>Sentence is too long.</td>
</tr>
</tbody>
</table></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Error code if error message is not <code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="getProbeId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProbeId</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getProbeId()</pre>
<div class="block">Gets ID of the probe this result was generated by.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ID of the probe this result was generated by.</dd>
</dl>
</li>
</ul>
<a name="getLogHolder--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getLogHolder</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getLogHolder()</pre>
<div class="block">Gets request processing log holder as JSON string.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Request processing log holder as JSON string.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/NCEmbeddedResult.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><span style="vertical-align: super">Apache NLPCraft <span style="font-size: 80%">0.5.0</span></span> <a style="vertical-align: super; margin-right: 10px" href="https://github.com/apache/incubator-nlpcraft" target="github"><i class="fa fa-github github-logo"></i></a> <a class="github-button" href="https://github.com/apache/incubator-nlpcraft/tree/master/src/main/scala/org/apache/nlpcraft/examples" data-icon="octicon-eye" aria-label="NLPCraft Examples">Examples</a> <a class="github-button" href="https://github.com/apache/incubator-nlpcraft" data-icon="octicon-star" aria-label="Star on GitHub">Star</a> <a class="github-button" href="https://github.com/apache/incubator-nlpcraft/fork" data-icon="octicon-repo-forked" aria-label="Fork on GitHub">Fork</a> <script type="text/javascript"> SyntaxHighlighter.defaults["auto-links"] = false; SyntaxHighlighter.defaults["tab-size"] = 2; SyntaxHighlighter.autoloader( 'java ../../../../../resources/sh/scripts/shBrushJava.js', 'js jscript javascript ../../../../../resources/sh/scripts/shBrushJScript.js', 'text plain ../../../../../resources/sh/scripts/shBrushPlain.js', 'py python ../../../../../resources/sh/scripts/shBrushPython.js', 'ruby rails ror rb ../../../../../resources/sh/scripts/shBrushRuby.js', 'scala ../../../../../resources/sh/scripts/shBrushScala.js', 'sql ../../../../../resources/sh/scripts/shBrushSql.js', 'xml xhtml xslt html ../../../../../resources/sh/scripts/shBrushXml.js' ); SyntaxHighlighter.all(); </script></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/nlpcraft/probe/embedded/NCEmbeddedProbe.html" title="class in org.apache.nlpcraft.probe.embedded"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/nlpcraft/probe/embedded/NCEmbeddedResult.html" target="_top">Frames</a></li>
<li><a href="NCEmbeddedResult.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><center> <br/> <span style="font-size: larger">Copyright &#169; 2020 Apache Software Foundation</span> <br/> <br/> <img src="https://www.apache.org/img/ASF20thAnniversary.jpg" height="64px"> </center></small></p>
</body>
</html>