blob: b332b39b70a4bd47295d4e12f74b4c11af354fef [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.8) on Fri Nov 20 12:32:33 PST 2020 -->
<title>Uses of Package org.apache.nlpcraft.model (Apache NLPCraft 0.7.2)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-11-20">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Uses of Package org.apache.nlpcraft.model (Apache NLPCraft 0.7.2)";
}
}
catch(err) {
}
//-->
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav"><link href="https://stackpath.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet"> <script src="https://nlpcraft.apache.org/javadoc/resources/sh/scripts/XRegExp.js" type="text/javascript"></script> <script src="https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shCore.js" type="text/javascript"></script> <script src="https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shAutoloader.js" type="text/javascript"></script> <link href="https://nlpcraft.apache.org/javadoc/resources/sh/styles/shCoreNLPCraft.css" rel="stylesheet" type="text/css" title="Style"> <link href="https://nlpcraft.apache.org/javadoc/resources/sh/styles/shThemeNLPCraft.css" rel="stylesheet" type="text/css" title="Style"> <link href="https://fonts.googleapis.com/css?family=Roboto+Mono" rel="stylesheet"> <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet"> <script async defer src="https://buttons.github.io/buttons.js"></script>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Use</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.7.2</span></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h1 title="Uses of Package org.apache.nlpcraft.model" class="title">Uses of Package<br>org.apache.nlpcraft.model</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary">
<caption><span>Packages that use <a href="package-summary.html">org.apache.nlpcraft.model</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="#org.apache.nlpcraft.model">org.apache.nlpcraft.model</a></th>
<td class="colLast">
<div class="block">Contains <b>main API</b> for defining data models.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="#org.apache.nlpcraft.model.factories.basic">org.apache.nlpcraft.model.factories.basic</a></th>
<td class="colLast">
<div class="block">Contains basic model factory implementation.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="#org.apache.nlpcraft.model.factories.spring">org.apache.nlpcraft.model.factories.spring</a></th>
<td class="colLast">
<div class="block">Contains Spring-based model factory implementation.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="#org.apache.nlpcraft.model.opencensus">org.apache.nlpcraft.model.opencensus</a></th>
<td class="colLast">
<div class="block">Contains OpenCensus integration components.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="#org.apache.nlpcraft.model.tools.sqlgen">org.apache.nlpcraft.model.tools.sqlgen</a></th>
<td class="colLast">
<div class="block">Contains model stub generator for SQL RDBMS.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="#org.apache.nlpcraft.model.tools.test">org.apache.nlpcraft.model.tools.test</a></th>
<td class="colLast">
<div class="block">Contains model testing framework.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a id="org.apache.nlpcraft.model">
<!-- -->
</a>
<table class="useSummary">
<caption><span>Classes in <a href="package-summary.html">org.apache.nlpcraft.model</a> used by <a href="package-summary.html">org.apache.nlpcraft.model</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/NCCompany.html#org.apache.nlpcraft.model">NCCompany</a></th>
<td class="colLast">
<div class="block">Descriptor of the user company.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/NCContext.html#org.apache.nlpcraft.model">NCContext</a></th>
<td class="colLast">
<div class="block">Data model query context.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/NCConversation.html#org.apache.nlpcraft.model">NCConversation</a></th>
<td class="colLast">
<div class="block">Conversation container for specific user and data model.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/NCCustomElement.html#org.apache.nlpcraft.model">NCCustomElement</a></th>
<td class="colLast">
<div class="block">Detected model element returning from custom parser.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/NCCustomParser.html#org.apache.nlpcraft.model">NCCustomParser</a></th>
<td class="colLast">
<div class="block">Custom model element parser for programmatic NER implementations.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/NCCustomWord.html#org.apache.nlpcraft.model">NCCustomWord</a></th>
<td class="colLast">
<div class="block">A partially enriched token with a basic set of NLP properties used by custom NER parser.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/NCElement.html#org.apache.nlpcraft.model">NCElement</a></th>
<td class="colLast">
<div class="block">Data model element.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/NCIntentMatch.html#org.apache.nlpcraft.model">NCIntentMatch</a></th>
<td class="colLast">
<div class="block">An intent match context that can be passed into the callback of the matched intent.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/NCIntentSample.html#org.apache.nlpcraft.model">NCIntentSample</a></th>
<td class="colLast">
<div class="block">Annotation to define one or more samples of the user input that should match a corresponding intent.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/NCLifecycle.html#org.apache.nlpcraft.model">NCLifecycle</a></th>
<td class="colLast">
<div class="block">NLPCraft lifecycle component.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/NCMetadata.html#org.apache.nlpcraft.model">NCMetadata</a></th>
<td class="colLast">
<div class="block">Provides support for map-based metadata.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/NCModel.html#org.apache.nlpcraft.model">NCModel</a></th>
<td class="colLast">
<div class="block">User-defined semantic data model.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/NCModelAdapter.html#org.apache.nlpcraft.model">NCModelAdapter</a></th>
<td class="colLast">
<div class="block">Adapter for data models.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/NCModelView.html#org.apache.nlpcraft.model">NCModelView</a></th>
<td class="colLast">
<div class="block">Read-only view on data model.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/NCRejection.html#org.apache.nlpcraft.model">NCRejection</a></th>
<td class="colLast">
<div class="block">Exception to indicate that user input cannot be processed as is.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/NCRequest.html#org.apache.nlpcraft.model">NCRequest</a></th>
<td class="colLast">
<div class="block">Supplemental information about the user request.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/NCResult.html#org.apache.nlpcraft.model">NCResult</a></th>
<td class="colLast">
<div class="block">Data model result returned from model intent callbacks.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/NCToken.html#org.apache.nlpcraft.model">NCToken</a></th>
<td class="colLast">
<div class="block">Detected model element.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/NCUser.html#org.apache.nlpcraft.model">NCUser</a></th>
<td class="colLast">
<div class="block">Descriptor of the user.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/NCValue.html#org.apache.nlpcraft.model">NCValue</a></th>
<td class="colLast">
<div class="block">Model element's value.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/NCValueLoader.html#org.apache.nlpcraft.model">NCValueLoader</a></th>
<td class="colLast">
<div class="block">Dynamic value loader that can be used by model elements to dynamically load or create their values.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/NCVariant.html#org.apache.nlpcraft.model">NCVariant</a></th>
<td class="colLast">
<div class="block">A list of tokens representing one possible parsing variant of the user input.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a id="org.apache.nlpcraft.model.factories.basic">
<!-- -->
</a>
<table class="useSummary">
<caption><span>Classes in <a href="package-summary.html">org.apache.nlpcraft.model</a> used by <a href="factories/basic/package-summary.html">org.apache.nlpcraft.model.factories.basic</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/NCModel.html#org.apache.nlpcraft.model.factories.basic">NCModel</a></th>
<td class="colLast">
<div class="block">User-defined semantic data model.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/NCModelFactory.html#org.apache.nlpcraft.model.factories.basic">NCModelFactory</a></th>
<td class="colLast">
<div class="block">Optional factory for data models.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a id="org.apache.nlpcraft.model.factories.spring">
<!-- -->
</a>
<table class="useSummary">
<caption><span>Classes in <a href="package-summary.html">org.apache.nlpcraft.model</a> used by <a href="factories/spring/package-summary.html">org.apache.nlpcraft.model.factories.spring</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/NCModel.html#org.apache.nlpcraft.model.factories.spring">NCModel</a></th>
<td class="colLast">
<div class="block">User-defined semantic data model.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/NCModelFactory.html#org.apache.nlpcraft.model.factories.spring">NCModelFactory</a></th>
<td class="colLast">
<div class="block">Optional factory for data models.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a id="org.apache.nlpcraft.model.opencensus">
<!-- -->
</a>
<table class="useSummary">
<caption><span>Classes in <a href="package-summary.html">org.apache.nlpcraft.model</a> used by <a href="opencensus/package-summary.html">org.apache.nlpcraft.model.opencensus</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/NCLifecycle.html#org.apache.nlpcraft.model.opencensus">NCLifecycle</a></th>
<td class="colLast">
<div class="block">NLPCraft lifecycle component.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a id="org.apache.nlpcraft.model.tools.sqlgen">
<!-- -->
</a>
<table class="useSummary">
<caption><span>Classes in <a href="package-summary.html">org.apache.nlpcraft.model</a> used by <a href="tools/sqlgen/package-summary.html">org.apache.nlpcraft.model.tools.sqlgen</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/NCModel.html#org.apache.nlpcraft.model.tools.sqlgen">NCModel</a></th>
<td class="colLast">
<div class="block">User-defined semantic data model.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/NCToken.html#org.apache.nlpcraft.model.tools.sqlgen">NCToken</a></th>
<td class="colLast">
<div class="block">Detected model element.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/NCVariant.html#org.apache.nlpcraft.model.tools.sqlgen">NCVariant</a></th>
<td class="colLast">
<div class="block">A list of tokens representing one possible parsing variant of the user input.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a id="org.apache.nlpcraft.model.tools.test">
<!-- -->
</a>
<table class="useSummary">
<caption><span>Classes in <a href="package-summary.html">org.apache.nlpcraft.model</a> used by <a href="tools/test/package-summary.html">org.apache.nlpcraft.model.tools.test</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/NCModel.html#org.apache.nlpcraft.model.tools.test">NCModel</a></th>
<td class="colLast">
<div class="block">User-defined semantic data model.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Use</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.7.2</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/nlpcraft/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 https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shBrushJava.js', 'js jscript javascript https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shBrushJScript.js', 'text plain https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shBrushPlain.js', 'py python https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shBrushPython.js', 'ruby rails ror rb https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shBrushRuby.js', 'scala https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shBrushScala.js', 'sql https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shBrushSql.js', 'xml xhtml xslt html https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shBrushXml.js' ); SyntaxHighlighter.all(); </script></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<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" alt="ASF Logo"> </center></small></p>
</footer>
</body>
</html>