| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.2) on Fri May 07 16:35:12 PDT 2021 --> |
| <title>org.apache.nlpcraft.model (Apache NLPCraft 0.7.5)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-05-07"> |
| <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.3.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.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="org.apache.nlpcraft.model (Apache NLPCraft 0.7.5)"; |
| } |
| } |
| 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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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.7.5</span></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All 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"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.nlpcraft.model</h1> |
| </div> |
| <div class="contentContainer"> |
| <section role="region"><a id="package.description"> |
| <!-- --> |
| </a> |
| <div class="block">Contains <b>main API</b> for defining data models.</div> |
| </section> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="NCCompany.html" title="interface in 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="NCContext.html" title="interface in 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="NCConversation.html" title="interface in 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="NCCustomElement.html" title="interface in 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="NCCustomParser.html" title="interface in 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="NCCustomWord.html" title="interface in 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="NCDialogFlowItem.html" title="interface in org.apache.nlpcraft.model">NCDialogFlowItem</a></th> |
| <td class="colLast"> |
| <div class="block">An item of the dialog flow.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="NCElement.html" title="interface in org.apache.nlpcraft.model">NCElement</a></th> |
| <td class="colLast"> |
| <div class="block">Data model element.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="NCIntentMatch.html" title="interface in 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="rowColor"> |
| <th class="colFirst" scope="row"><a href="NCLifecycle.html" title="interface in org.apache.nlpcraft.model">NCLifecycle</a></th> |
| <td class="colLast"> |
| <div class="block">Lifecycle component.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="NCMetadata.html" title="interface in org.apache.nlpcraft.model">NCMetadata</a></th> |
| <td class="colLast"> |
| <div class="block">Provides support for mutable runtime-only metadata.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="NCModel.html" title="interface in org.apache.nlpcraft.model">NCModel</a></th> |
| <td class="colLast"> |
| <div class="block">User-defined data model.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="NCModelFactory.html" title="interface in org.apache.nlpcraft.model">NCModelFactory</a></th> |
| <td class="colLast"> |
| <div class="block">Optional factory for data models.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="NCModelView.html" title="interface in 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="NCRequest.html" title="interface in org.apache.nlpcraft.model">NCRequest</a></th> |
| <td class="colLast"> |
| <div class="block">Information about the user request.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="NCToken.html" title="interface in 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="NCTokenPredicateContext.html" title="interface in org.apache.nlpcraft.model">NCTokenPredicateContext</a></th> |
| <td class="colLast"> |
| <div class="block">Context passed into custom user-defined IDL term token predicate.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="NCUser.html" title="interface in org.apache.nlpcraft.model">NCUser</a></th> |
| <td class="colLast"> |
| <div class="block">Descriptor of the user.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="NCValue.html" title="interface in org.apache.nlpcraft.model">NCValue</a></th> |
| <td class="colLast"> |
| <div class="block">Model element's value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="NCValueLoader.html" title="interface in 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="altColor"> |
| <th class="colFirst" scope="row"><a href="NCVariant.html" title="interface in org.apache.nlpcraft.model">NCVariant</a></th> |
| <td class="colLast"> |
| <div class="block">A parsing variant is a list of tokens representing one possible parsing variant of the user input.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </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="NCMacroProcessor.html" title="class in org.apache.nlpcraft.model">NCMacroProcessor</a></th> |
| <td class="colLast"> |
| <div class="block">Standalone synonym macro DSL processor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="NCModelAdapter.html" title="class in org.apache.nlpcraft.model">NCModelAdapter</a></th> |
| <td class="colLast"> |
| <div class="block">Adapter for data models.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="NCModelFileAdapter.html" title="class in org.apache.nlpcraft.model">NCModelFileAdapter</a></th> |
| <td class="colLast"> |
| <div class="block">Adapter for data models that can load model configuration from external JSON/YAML file.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="NCResult.html" title="class in 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="altColor"> |
| <th class="colFirst" scope="row"><a href="NCTokenPredicateResult.html" title="class in org.apache.nlpcraft.model">NCTokenPredicateResult</a></th> |
| <td class="colLast"> |
| <div class="block">Result value of user-defined IDL term token predicate.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="NCIntentSkip.html" title="class in org.apache.nlpcraft.model">NCIntentSkip</a></th> |
| <td class="colLast"> |
| <div class="block">Control flow exception to skip current intent.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="NCRejection.html" title="class in 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> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Annotation Types Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Annotation Type</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="NCIntent.html" title="annotation in org.apache.nlpcraft.model">NCIntent</a></th> |
| <td class="colLast"> |
| <div class="block">Annotation to bind an intent with the method serving as its callback.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="NCIntent.NCIntentList.html" title="annotation in org.apache.nlpcraft.model">NCIntent.NCIntentList</a></th> |
| <td class="colLast"> |
| <div class="block">Grouping annotation required for when more than one <a href="NCIntent.html" title="annotation in org.apache.nlpcraft.model"><code>NCIntent</code></a> annotation is attached to the |
| callback or class.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="NCIntentRef.html" title="annotation in org.apache.nlpcraft.model">NCIntentRef</a></th> |
| <td class="colLast"> |
| <div class="block">Annotations referencing an intent defined outside of callback method declaration.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="NCIntentRef.NCIntentRefList.html" title="annotation in org.apache.nlpcraft.model">NCIntentRef.NCIntentRefList</a></th> |
| <td class="colLast"> |
| <div class="block">Grouping annotation required for when more than one <a href="NCIntentRef.html" title="annotation in org.apache.nlpcraft.model"><code>NCIntentRef</code></a> annotation is attached to the |
| callback.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="NCIntentSample.html" title="annotation in 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="NCIntentSample.NCIntentSampleList.html" title="annotation in org.apache.nlpcraft.model">NCIntentSample.NCIntentSampleList</a></th> |
| <td class="colLast"> |
| <div class="block">Grouping annotation required for when more than one <a href="NCIntentSample.html" title="annotation in org.apache.nlpcraft.model"><code>NCIntentSample</code></a> annotation is attached to the |
| callback.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="NCIntentTerm.html" title="annotation in org.apache.nlpcraft.model">NCIntentTerm</a></th> |
| <td class="colLast"> |
| <div class="block">Annotation to mark callback parameter to receive intent term's tokens.</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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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.7.5</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-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 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 © 2021 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> |