| <html><head><meta charset="utf-8"></meta><meta name="viewport" content="width=device-width, initial-scale=1"></meta><title>org.apache.nlpcraft</title><link rel="shortcut icon" type="image/x-icon" href="../../favicon.ico"></link><script type="text/javascript" src="../../scripts/theme.js"></script><script type="text/javascript" src="../../scripts/searchData.js" defer="true"></script><script type="text/javascript" src="../../scripts/scastieConfiguration.js" defer="true"></script><link rel="stylesheet" href="../../styles/nord-light.css"></link><link rel="stylesheet" href="../../styles/scalastyle.css"></link><link rel="stylesheet" href="../../styles/colors.css"></link><link rel="stylesheet" href="../../styles/dotty-icons.css"></link><link rel="stylesheet" href="../../styles/diagram.css"></link><link rel="stylesheet" href="../../styles/filter-bar.css"></link><link rel="stylesheet" href="../../styles/code-snippets.css"></link><link rel="stylesheet" href="../../styles/searchbar.css"></link><link rel="stylesheet" href="../../styles/social-links.css"></link><link rel="stylesheet" href="../../styles/ux.css"></link><link rel="stylesheet" href="../../styles/versions-dropdown.css"></link><link rel="stylesheet" href="../../styles/fontawesome.css"></link><script type="text/javascript" src="../../hljs/highlight.min.js" defer="true"></script><script type="text/javascript" src="../../scripts/hljs-scala3.js" defer="true"></script><script type="text/javascript" src="../../scripts/ux.js" defer="true"></script><script type="text/javascript" src="../../scripts/common/component.js" defer="true"></script><script type="text/javascript" src="../../scripts/common/utils.js" defer="true"></script><script type="text/javascript" src="../../scripts/components/FilterBar.js" defer="true"></script><script type="text/javascript" src="../../scripts/components/DocumentableList.js" defer="true"></script><script type="text/javascript" src="../../scripts/components/Input.js" defer="true"></script><script type="text/javascript" src="../../scripts/components/FilterGroup.js" defer="true"></script><script type="text/javascript" src="../../scripts/components/Filter.js" defer="true"></script><script type="text/javascript" src="../../scripts/scaladoc-scalajs.js" defer="true"></script><script type="text/javascript" src="https://code.jquery.com/jquery-3.5.1.min.js" defer="true"></script><script type="text/javascript" src="https://d3js.org/d3.v6.min.js" defer="true"></script><script type="text/javascript" src="https://cdn.jsdelivr.net/npm/graphlib-dot@0.6.2/dist/graphlib-dot.min.js" defer="true"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/dagre-d3/0.6.1/dagre-d3.min.js" defer="true"></script><script type="text/javascript" src="https://scastie.scala-lang.org/embedded.js" defer="true"></script><script type="text/javascript" src="../../scripts/data.js" defer="true"></script><script>var pathToRoot = "../../";</script></head><body><div id="container"><div id="leftColumn"><div id="logo"><span><div class="projectName">NLPCraft</div></span><div id="version"><div class="versions-dropdown"><div onclick="dropdownHandler()" id="dropdown-button" class="dropdownbtn dropdownbtnactive"><div class="projectVersion">1.0.0</div><div id="dropdown-content" class="dropdown-content"><input type="text" placeholder="Search..." id="dropdown-input" onkeyup="filterFunction()"></input></div></div></div></div><div class="socials"><a href="https://github.com/apache/incubator-nlpcraft"><span class="social-icon" data-icon-path="github-icon-white.png"></span></a></div></div><div id="paneSearch"></div><nav id="sideMenu2"><div class="ni expanded"><span class="nh expanded"><span class="ar"></span><a href="../../index.html"><span>NLPCraft</span></a></span><div class="ni expanded"><span class="nh selected expanded"><span class="ar"></span><a href="nlpcraft.html"><span class="micon pa"></span><span>org.apache.nlpcraft</span></a></span><div class="ni "><span class="nh "><a href="nlpcraft/NCContext.html"><span class="micon tr"></span><span>NCContext</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCConversation.html"><span class="micon tr"></span><span>NCConversation</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCCuration.html"><span class="micon cl"></span><span>NCCuration</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCDialogFlowItem.html"><span class="micon tr"></span><span>NCDialogFlowItem</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCEntity.html"><span class="micon tr"></span><span>NCEntity</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCEntityEnricher.html"><span class="micon tr"></span><span>NCEntityEnricher</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCEntityMapper.html"><span class="micon tr"></span><span>NCEntityMapper</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCEntityParser.html"><span class="micon tr"></span><span>NCEntityParser</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCEntityValidator.html"><span class="micon tr"></span><span>NCEntityValidator</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCException.html"><span class="micon cl"></span><span>NCException</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCIntentMatch.html"><span class="micon tr"></span><span>NCIntentMatch</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCIntentSkip.html"><span class="micon cl"></span><span>NCIntentSkip</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCLifecycle.html"><span class="micon tr"></span><span>NCLifecycle</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCMatchedCallback.html"><span class="micon tr"></span><span>NCMatchedCallback</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCModel.html"><span class="micon tr"></span><span>NCModel</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCModelClient.html"><span class="micon cl"></span><span>NCModelClient</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCModelConfig$.html"><span class="micon ob"></span><span>NCModelConfig</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCModelConfig.html"><span class="micon tr"></span><span>NCModelConfig</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCPipeline.html"><span class="micon tr"></span><span>NCPipeline</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCPipelineBuilder.html"><span class="micon cl"></span><span>NCPipelineBuilder</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCPropertyMap.html"><span class="micon tr"></span><span>NCPropertyMap</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCPropertyMapAdapter.html"><span class="micon cl"></span><span>NCPropertyMapAdapter</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCRejection.html"><span class="micon cl"></span><span>NCRejection</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCRequest.html"><span class="micon tr"></span><span>NCRequest</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCResult$.html"><span class="micon ob"></span><span>NCResult</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCResult.html"><span class="micon tr"></span><span>NCResult</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCResultType.html"><span class="micon en"></span><span>NCResultType</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCToken.html"><span class="micon tr"></span><span>NCToken</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCTokenEnricher.html"><span class="micon tr"></span><span>NCTokenEnricher</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCTokenParser.html"><span class="micon tr"></span><span>NCTokenParser</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCTokenValidator.html"><span class="micon tr"></span><span>NCTokenValidator</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCVariant.html"><span class="micon tr"></span><span>NCVariant</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/NCVariantFilter.html"><span class="micon tr"></span><span>NCVariantFilter</span></a></span></div></div><div class="ni"><span class="nh "><span class="ar"></span><a href="nlpcraft/nlp/enrichers.html"><span class="micon pa"></span><span>org.apache.nlpcraft.nlp.enrichers</span></a></span><div class="ni "><span class="nh "><a href="nlpcraft/nlp/enrichers/NCBracketsTokenEnricher.html"><span class="micon cl"></span><span>NCBracketsTokenEnricher</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/nlp/enrichers/NCDictionaryTokenEnricher.html"><span class="micon cl"></span><span>NCDictionaryTokenEnricher</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/nlp/enrichers/NCEnStopWordsTokenEnricher.html"><span class="micon cl"></span><span>NCEnStopWordsTokenEnricher</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/nlp/enrichers/NCOpenNLPTokenEnricher.html"><span class="micon cl"></span><span>NCOpenNLPTokenEnricher</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/nlp/enrichers/NCQuotesTokenEnricher.html"><span class="micon cl"></span><span>NCQuotesTokenEnricher</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/nlp/enrichers/NCSwearWordsTokenEnricher.html"><span class="micon cl"></span><span>NCSwearWordsTokenEnricher</span></a></span></div></div><div class="ni"><span class="nh "><span class="ar"></span><a href="nlpcraft/nlp/parsers.html"><span class="micon pa"></span><span>org.apache.nlpcraft.nlp.parsers</span></a></span><div class="ni "><span class="nh "><a href="nlpcraft/nlp/parsers/NCNLPEntityParser.html"><span class="micon cl"></span><span>NCNLPEntityParser</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/nlp/parsers/NCOpenNLPEntityParser.html"><span class="micon cl"></span><span>NCOpenNLPEntityParser</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/nlp/parsers/NCOpenNLPTokenParser.html"><span class="micon cl"></span><span>NCOpenNLPTokenParser</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/nlp/parsers/NCSemanticElement.html"><span class="micon tr"></span><span>NCSemanticElement</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/nlp/parsers/NCSemanticEntityParser.html"><span class="micon cl"></span><span>NCSemanticEntityParser</span></a></span></div></div><div class="ni"><span class="nh "><span class="ar"></span><a href="nlpcraft/nlp/stemmer.html"><span class="micon pa"></span><span>org.apache.nlpcraft.nlp.stemmer</span></a></span><div class="ni "><span class="nh "><a href="nlpcraft/nlp/stemmer/NCEnStemmer.html"><span class="micon cl"></span><span>NCEnStemmer</span></a></span></div><div class="ni "><span class="nh "><a href="nlpcraft/nlp/stemmer/NCStemmer.html"><span class="micon tr"></span><span>NCStemmer</span></a></span></div></div></div></nav></div><div id="main"><div id="leftToggler"><span class="icon-toggler"></span></div><div id="scaladoc-searchBar"></div><main id="main-content"><div class="breadcrumbs container"><a href="../../index.html">NLPCraft</a>/<a href="nlpcraft.html">org.apache.nlpcraft</a></div><div id="content"><div><div class="cover-header"><span class="micon pa"></span><h1>org.apache.nlpcraft</h1></div><div class="signature monospace"><span class="annotations monospace"></span><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">package </span></span><a href="nlpcraft.html" class="documentableName ">org.apache.nlpcraft</a><span></span></div></div><div class="cover"><div class="doc"></div><dl class="attributes"></dl></div><div class="documentableFilter"><div class="filterUpperContainer"><button class="filterToggleButton" data-test-id="filterToggleButton"> |
| <svg xmlns="http://www.w3.org/2000/svg" height="24" viewBox="0 0 24 24" width="24"> |
| <path d="M0 0h24v24H0z" fill="none"/> |
| <path d="M10 6L8.59 7.41 13.17 12l-4.58 4.59L10 18l6-6z"/> |
| </svg> |
| </button><input class="filterableInput" placeholder="Filter all members" data-test-id="filterBarInput"></input></div><div class="filterLowerContainer"></div></div><div class="membersList"><div class="tabs"><div class="names"><button data-togglable="Type members" class="tab selected">Type members</button><button data-togglable="Value members" class="tab selected">Value members</button><button data-togglable="Extensions" class="tab selected">Extensions</button></div><div class="contents"><div data-togglable="Type members" class="tab selected"><h2 data-togglable="Type members">Type members</h2><div class="documentableList"><h3 class="groupHeader">Classlikes</h3><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">trait </span></span><a href="nlpcraft/NCContext.html" class="documentableName ">NCContext</a><span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>A context containing a fully parsed data from the input query.</p> |
| </div><div class="cover"><div class="doc"><p>A context containing a fully parsed data from the input query.</p> |
| </div><dl class="attributes"><dt>See also:</dt><dd><div><div><p><a href="nlpcraft/NCModel.html#onContext-38d">NCModel.onContext</a></p> |
| </div></div></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCContext.scala#L25">NCContext.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">trait </span></span><a href="nlpcraft/NCConversation.html" class="documentableName ">NCConversation</a><span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Conversation container. Conversation contains everything that should be implicitly remembered |
| during the active, ongoing conversation and forgotten once the conversation ends or timed out. |
| Conversation contains the following elements:</p> |
| </div><div class="cover"><div class="doc"><p>Conversation container. Conversation contains everything that should be implicitly remembered |
| during the active, ongoing conversation and forgotten once the conversation ends or timed out. |
| Conversation contains the following elements:</p> |
| <ul> |
| <li>List of entities comprising a "short-term-memory" (STM) of this conversation.</li> |
| <li>Chronological list of previously matched intents.</li> |
| <li>Auto-expiring user data.</li> |
| </ul> |
| <p>Note that the conversation is unique for given combination of user and data model.</p> |
| <p>Conversation management is based on idea of a "short-term-memory" (STM). STM can be viewed as a condensed |
| short-term history of the input for a given user and data model. Every submitted user request that wasn't |
| rejected is added to the conversation STM as a list of tokens. Existing STM tokens belonging to the same |
| group will be overridden by the more recent tokens from the same group. Note also that tokens in STM automatically |
| expire (i.e. context is "forgotten") after a certain period of time and/or based on the depth of the |
| conversation since the last mention.</p> |
| <p>You can also maintain user state-machine between requests using conversation's session. Conversation's |
| <a href="nlpcraft/NCConversation.html#getData-0">data</a> is a mutable thread-safe container that can hold any arbitrary user data |
| while supporting the same expiration logic as the rest of the conversation elements (i.e. tokens and |
| previously matched intent IDs).</p> |
| <p>Conversation expiration policy is configured by two configuration properties:</p> |
| <ul> |
| <li><a href="nlpcraft/NCModelConfig.html#getConversationDepth-0">NCModelConfig.getConversationDepth</a></li> |
| <li><a href="nlpcraft/NCModelConfig.html#getConversationTimeout-0">NCModelConfig.getConversationTimeout</a></li> |
| </ul> |
| </div><dl class="attributes"><dt>See also:</dt><dd><div><div><p><a href="nlpcraft/NCContext.html#getConversation-0">NCContext.getConversation</a></p> |
| </div><div><p><a href="nlpcraft/NCModelConfig.html#getConversationDepth-0">NCModelConfig.getConversationDepth</a></p> |
| </div><div><p><a href="nlpcraft/NCModelConfig.html#getConversationTimeout-0">NCModelConfig.getConversationTimeout</a></p> |
| </div></div></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCConversation.scala#L50">NCConversation.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">class </span></span><a href="nlpcraft/NCCuration.html" class="documentableName ">NCCuration</a><span>(<span t="k"></span><span t="k"></span>msg: <a href="https://www.scala-lang.org/api/2.13.8/scala/Predef$.html#String" t="t">String</a>, <span t="k"></span>cause: <a href="https://www.scala-lang.org/api/2.13.8/scala.html#Throwable" t="t">Throwable</a>)<span t="k"> extends </span><a href="nlpcraft/NCRejection.html" t="t">NCRejection</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>A type of rejection indicating that human curation is required. Curation is typically an indication that input |
| query is likely valid but needs a human correction like a typo fix, slang resolution, etc.</p> |
| </div><div class="cover"><div class="doc"><p>A type of rejection indicating that human curation is required. Curation is typically an indication that input |
| query is likely valid but needs a human correction like a typo fix, slang resolution, etc.</p> |
| <p>Note that NLPCraft does not handle the curation process itself but only allows to indicate the curation |
| request by throwing this exception. Curation is a special type of rejection. The user code is responsible for |
| he actual handling of the curation logic, e.g. giving the user an option to fix the input and resubmitting the |
| request.</p> |
| </div><dl class="attributes"><dt>Value parameters:</dt><dd><dl class="attributes"><dt>cause</dt><dd><p>Optional cause of this exception.</p> |
| </dd><dt>msg</dt><dd><p>Curation message.</p> |
| </dd></dl></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCCuration.scala#L32">NCCuration.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">trait </span></span><a href="nlpcraft/NCDialogFlowItem.html" class="documentableName ">NCDialogFlowItem</a><span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>An item of the dialog flow. Dialog flow is a chronologically ordered list of dialog flow items. Each item |
| represents a snapshot of winning intent's match and its associated data. List of dialog flow items |
| is passed into a custom user-defined dialog flow match method.</p> |
| </div><div class="cover"><div class="doc"><p>An item of the dialog flow. Dialog flow is a chronologically ordered list of dialog flow items. Each item |
| represents a snapshot of winning intent's match and its associated data. List of dialog flow items |
| is passed into a custom user-defined dialog flow match method.</p> |
| </div><dl class="attributes"><dt>See also:</dt><dd><div><div><p><a href="nlpcraft/NCConversation.html#getDialogFlow-0">NCConversation#getDialogFlow</a></p> |
| </div></div></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCDialogFlowItem.scala#L27">NCDialogFlowItem.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">trait </span></span><a href="nlpcraft/NCEntity.html" class="documentableName ">NCEntity</a><span><span t="k"> extends </span><a href="nlpcraft/NCPropertyMap.html" t="t">NCPropertyMap</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>An entity is a collection if one or more <a href="nlpcraft/NCToken.html">tokens</a>. An entity typically has a |
| consistent semantic meaning and usually denotes a real-world object, such as persons, locations, number, |
| date and time, organizations, products, etc. - where such objects can be abstract or have a physical existence. |
| Entities are produced by <a href="nlpcraft/NCEntityParser.html">NCEntityParser</a>. See <a href="nlpcraft/NCPipeline.html">NCPipeline</a> for documentation on the entities in the |
| overall processing pipeline.</p> |
| </div><div class="cover"><div class="doc"><p>An entity is a collection if one or more <a href="nlpcraft/NCToken.html">tokens</a>. An entity typically has a |
| consistent semantic meaning and usually denotes a real-world object, such as persons, locations, number, |
| date and time, organizations, products, etc. - where such objects can be abstract or have a physical existence. |
| Entities are produced by <a href="nlpcraft/NCEntityParser.html">NCEntityParser</a>. See <a href="nlpcraft/NCPipeline.html">NCPipeline</a> for documentation on the entities in the |
| overall processing pipeline.</p> |
| <p>Note that both <a href="nlpcraft/NCToken.html">NCToken</a> and <a href="nlpcraft/NCEntity.html">NCEntity</a> interfaces extend <a href="nlpcraft/NCPropertyMap.html">NCPropertyMap</a> trait |
| that allows them to store custom metadata properties. Parser, enrichers and validators for tokens |
| and entities use this capability to store and check their properties in tokens and entities.</p> |
| </div><dl class="attributes"><dt>See also:</dt><dd><div><div><p><a href="nlpcraft/NCToken.html">NCToken</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenParser.html">NCTokenParser</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenEnricher.html">NCTokenEnricher</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenValidator.html">NCTokenValidator</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityParser.html">NCEntityParser</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityEnricher.html">NCEntityEnricher</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityValidator.html">NCEntityValidator</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityMapper.html">NCEntityMapper</a></p> |
| </div></div></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntity.scala#L40">NCEntity.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">trait </span></span><a href="nlpcraft/NCEntityEnricher.html" class="documentableName ">NCEntityEnricher</a><span><span t="k"> extends </span><a href="nlpcraft/NCLifecycle.html" t="t">NCLifecycle</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>A pipeline component that enrichers entities by settings their properties. |
| See <a href="nlpcraft/NCPipeline.html">NCPipeline</a> for documentation on the overall processing pipeline. Note that this is |
| an optional component in the pipeline.</p> |
| </div><div class="cover"><div class="doc"><p>A pipeline component that enrichers entities by settings their properties. |
| See <a href="nlpcraft/NCPipeline.html">NCPipeline</a> for documentation on the overall processing pipeline. Note that this is |
| an optional component in the pipeline.</p> |
| </div><dl class="attributes"><dt>See also:</dt><dd><div><div><p><a href="nlpcraft/NCPipeline.html#getEntityEnrichers-0">NCPipeline.getEntityEnrichers</a></p> |
| </div><div><p><a href="nlpcraft/NCEntity.html">NCEntity</a></p> |
| </div><div><p><a href="nlpcraft/NCToken.html">NCToken</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenParser.html">NCTokenParser</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenEnricher.html">NCTokenEnricher</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenValidator.html">NCTokenValidator</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityParser.html">NCEntityParser</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityEnricher.html">NCEntityEnricher</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityValidator.html">NCEntityValidator</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityMapper.html">NCEntityMapper</a></p> |
| </div></div></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityEnricher.scala#L37">NCEntityEnricher.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">trait </span></span><a href="nlpcraft/NCEntityMapper.html" class="documentableName ">NCEntityMapper</a><span><span t="k"> extends </span><a href="nlpcraft/NCLifecycle.html" t="t">NCLifecycle</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>A pipeline component that allows to map one set of entities into another after the entities were parsed |
| and enriched. Entity mapper is an optional component and the pipeline can have zero or more entity mappers. Mappers |
| are typically used for combining several existing entities into a new one without necessarily touching the entity |
| parser or enrichers. See <a href="nlpcraft/NCPipeline.html">NCPipeline</a> for documentation on the overall processing pipeline.</p> |
| </div><div class="cover"><div class="doc"><p>A pipeline component that allows to map one set of entities into another after the entities were parsed |
| and enriched. Entity mapper is an optional component and the pipeline can have zero or more entity mappers. Mappers |
| are typically used for combining several existing entities into a new one without necessarily touching the entity |
| parser or enrichers. See <a href="nlpcraft/NCPipeline.html">NCPipeline</a> for documentation on the overall processing pipeline.</p> |
| </div><dl class="attributes"><dt>See also:</dt><dd><div><div><p><a href="nlpcraft/NCPipeline.html#getEntityMappers-0">NCPipeline.getEntityMappers</a></p> |
| </div><div><p><a href="nlpcraft/NCEntity.html">NCEntity</a></p> |
| </div><div><p><a href="nlpcraft/NCToken.html">NCToken</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenParser.html">NCTokenParser</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenEnricher.html">NCTokenEnricher</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenValidator.html">NCTokenValidator</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityParser.html">NCEntityParser</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityEnricher.html">NCEntityEnricher</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityValidator.html">NCEntityValidator</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityMapper.html">NCEntityMapper</a></p> |
| </div></div></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityMapper.scala#L37">NCEntityMapper.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">trait </span></span><a href="nlpcraft/NCEntityParser.html" class="documentableName ">NCEntityParser</a><span><span t="k"> extends </span><a href="nlpcraft/NCLifecycle.html" t="t">NCLifecycle</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>A pipeline component that converts list of tokens into the list of entities.</p> |
| </div><div class="cover"><div class="doc"><p>A pipeline component that converts list of tokens into the list of entities.</p> |
| <p>Parser instance can produce <a href="nlpcraft/NCEntity.html">NCEntity</a> instances with different types. |
| Each <a href="nlpcraft/NCEntity.html">NCEntity</a> instance contains <a href="nlpcraft/NCToken.html">NCToken</a> instances list and |
| each <a href="nlpcraft/NCToken.html">NCToken</a> instance can belong to one or more different <a href="nlpcraft/NCEntity.html">NCEntity</a> instances. |
| Order of result entities list is not important.</p> |
| <p>See <a href="nlpcraft/NCPipeline.html">NCPipeline</a> for documentation on the overall processing pipeline. Note that pipeline |
| must have at least one entity parser.</p> |
| </div><dl class="attributes"><dt>See also:</dt><dd><div><div><p><a href="nlpcraft/NCPipeline.html#getEntityParsers-0">NCPipeline.getEntityParsers</a></p> |
| </div><div><p><a href="nlpcraft/NCEntity.html">NCEntity</a></p> |
| </div><div><p><a href="nlpcraft/NCToken.html">NCToken</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenParser.html">NCTokenParser</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenEnricher.html">NCTokenEnricher</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenValidator.html">NCTokenValidator</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityParser.html">NCEntityParser</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityEnricher.html">NCEntityEnricher</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityValidator.html">NCEntityValidator</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityMapper.html">NCEntityMapper</a></p> |
| </div></div></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityParser.scala#L42">NCEntityParser.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">trait </span></span><a href="nlpcraft/NCEntityValidator.html" class="documentableName ">NCEntityValidator</a><span><span t="k"> extends </span><a href="nlpcraft/NCLifecycle.html" t="t">NCLifecycle</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>A pipeline components that validates the final list of parsed and enriched entities. |
| See <a href="nlpcraft/NCPipeline.html">NCPipeline</a> for documentation on the overall processing pipeline. Note that this is an |
| optional component.</p> |
| </div><div class="cover"><div class="doc"><p>A pipeline components that validates the final list of parsed and enriched entities. |
| See <a href="nlpcraft/NCPipeline.html">NCPipeline</a> for documentation on the overall processing pipeline. Note that this is an |
| optional component.</p> |
| <p>This component can be used to perform any kind of last-stage validation before the list of |
| entities is passed to intent matching. For example, this can be used for content-based access control, time-based |
| control, location-based control, etc.</p> |
| </div><dl class="attributes"><dt>See also:</dt><dd><div><div><p><a href="nlpcraft/NCPipeline.html#getEntityValidators-0">NCPipeline.getEntityValidators</a></p> |
| </div><div><p><a href="nlpcraft/NCEntity.html">NCEntity</a></p> |
| </div><div><p><a href="nlpcraft/NCToken.html">NCToken</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenParser.html">NCTokenParser</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenEnricher.html">NCTokenEnricher</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenValidator.html">NCTokenValidator</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityParser.html">NCEntityParser</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityEnricher.html">NCEntityEnricher</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityValidator.html">NCEntityValidator</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityMapper.html">NCEntityMapper</a></p> |
| </div></div></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityValidator.scala#L41">NCEntityValidator.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">class </span></span><a href="nlpcraft/NCException.html" class="documentableName ">NCException</a><span>(<span t="k"></span><span t="k"></span>msg: <a href="https://www.scala-lang.org/api/2.13.8/scala/Predef$.html#String" t="t">String</a>, <span t="k"></span>cause: <a href="https://www.scala-lang.org/api/2.13.8/scala.html#Throwable" t="t">Throwable</a>)<span t="k"> extends </span><span data-unresolved-link="" t="t">RuntimeException</span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Base NLPCraft exception.</p> |
| </div><div class="cover"><div class="doc"><p>Base NLPCraft exception.</p> |
| </div><dl class="attributes"><dt>Value parameters:</dt><dd><dl class="attributes"><dt>cause</dt><dd><p>Optional cause exception.</p> |
| </dd><dt>msg</dt><dd><p>Error message.</p> |
| </dd></dl></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCException.scala#L26">NCException.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">trait </span></span><a href="nlpcraft/NCIntentMatch.html" class="documentableName ">NCIntentMatch</a><span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Descriptor of the matched intent.</p> |
| </div><div class="cover"><div class="doc"><p>Descriptor of the matched intent.</p> |
| </div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCIntentMatch.scala#L25">NCIntentMatch.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">class </span></span><a href="nlpcraft/NCIntentSkip.html" class="documentableName ">NCIntentSkip</a><span>(<span t="k"></span><span t="k"></span>msg: <a href="https://www.scala-lang.org/api/2.13.8/scala/Predef$.html#String" t="t">String</a>, <span t="k"></span>cause: <a href="https://www.scala-lang.org/api/2.13.8/scala.html#Throwable" t="t">Throwable</a>)<span t="k"> extends </span><a href="nlpcraft/NCException.html" t="t">NCException</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Control flow exception to skip current intent. This exception can be thrown by the intent callback to indicate |
| that current intent should be skipped (even though it was matched and its callback was called). If there's more |
| than one intent matched the next best matching intent will be selected and its callback will be called.</p> |
| </div><div class="cover"><div class="doc"><p>Control flow exception to skip current intent. This exception can be thrown by the intent callback to indicate |
| that current intent should be skipped (even though it was matched and its callback was called). If there's more |
| than one intent matched the next best matching intent will be selected and its callback will be called.</p> |
| <p>This exception becomes useful when it is hard or impossible to encode the entire matching logic using just |
| declarative IDL. In these cases the intent definition can be relaxed and the "last mile" of intent |
| matching can happen inside the intent callback's user logic. If it is determined that intent in fact does |
| not match then throwing this exception allows to try next best matching intent, if any.</p> |
| </div><dl class="attributes"><dt>See also:</dt><dd><div><div><p><a href="nlpcraft/NCModel.html#onMatchedIntent-946">NCModel.onMatchedIntent</a></p> |
| </div></div></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCIntentSkip.scala#L32">NCIntentSkip.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">trait </span></span><a href="nlpcraft/NCLifecycle.html" class="documentableName ">NCLifecycle</a><span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Lifecycle callbacks for various pipeline components.</p> |
| </div><div class="cover"><div class="doc"><p>Lifecycle callbacks for various pipeline components.</p> |
| </div><dl class="attributes"><dt>See also:</dt><dd><div><div><p><a href="nlpcraft/NCTokenParser.html">NCTokenParser</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenEnricher.html">NCTokenEnricher</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenValidator.html">NCTokenValidator</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityParser.html">NCEntityParser</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityEnricher.html">NCEntityEnricher</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityValidator.html">NCEntityValidator</a></p> |
| </div></div></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCLifecycle.scala#L30">NCLifecycle.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">trait </span></span><a href="nlpcraft/NCMatchedCallback.html" class="documentableName ">NCMatchedCallback</a><span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>A descriptor of the intent callback returned by <a href="nlpcraft/NCModelClient.html#debugAsk-fffff96c">NCModelClient.debugAsk</a> method. This descriptor |
| defines the callback for the intent that was detected as a winning intent but whose callback wasn't |
| fired as per <a href="nlpcraft/NCModelClient.html#debugAsk-fffff96c">NCModelClient.debugAsk</a> method's semantic.</p> |
| </div><div class="cover"><div class="doc"><p>A descriptor of the intent callback returned by <a href="nlpcraft/NCModelClient.html#debugAsk-fffff96c">NCModelClient.debugAsk</a> method. This descriptor |
| defines the callback for the intent that was detected as a winning intent but whose callback wasn't |
| fired as per <a href="nlpcraft/NCModelClient.html#debugAsk-fffff96c">NCModelClient.debugAsk</a> method's semantic.</p> |
| <p>Using this descriptor the user can execute callback itself, if necessary.</p> |
| </div><dl class="attributes"><dt>See also:</dt><dd><div><div><p><a href="nlpcraft/NCModelClient.html#debugAsk-fffff96c">NCModelClient.debugAsk</a></p> |
| </div></div></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCMatchedCallback.scala#L29">NCMatchedCallback.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">trait </span></span><a href="nlpcraft/NCModel.html" class="documentableName ">NCModel</a><span>(<span t="k"></span><span t="k"></span>cfg: <a href="nlpcraft/NCModelConfig.html" t="t">NCModelConfig</a>, <span t="k"></span>pipeline: <a href="nlpcraft/NCPipeline.html" t="t">NCPipeline</a>)</span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Data model.</p> |
| </div><div class="cover"><div class="doc"><p>Data model.</p> |
| <p>Data model is a key entity in NLPCraft and contains:</p> |
| <ul> |
| <li>Model <a href="nlpcraft/NCModel.html#getConfig-0">configuration</a>.</li> |
| <li>Model <a href="nlpcraft/NCModel.html#getPipeline-0">processing pipeline</a>.</li> |
| <li>Life-cycle callbacks.</li> |
| </ul> |
| <p>NLPCraft employs model-as-a-code approach where entire data model is an implementation of just this interface. |
| The instance of this interface is passed to <a href="nlpcraft/NCModelClient.html">NCModelClient</a> class. |
| Note that the model-as-a-code approach natively supports any software life cycle tools and frameworks like various |
| build tools, CI/SCM tools, IDEs, etc. You don't need any additional tools to manage |
| some aspects of your data models - your entire model and all of its components are part of your project's |
| source code.</p> |
| </div><dl class="attributes"><dt>See also:</dt><dd><div><div><p><a href="nlpcraft/NCModelClient.html">NCModelClient</a></p> |
| </div><div><p><a href="nlpcraft/NCModelConfig.html">NCModelConfig</a></p> |
| </div><div><p><a href="nlpcraft/NCPipeline.html">NCPipeline</a></p> |
| </div></div></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCModel.scala#L39">NCModel.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">class </span></span><a href="nlpcraft/NCModelClient.html" class="documentableName ">NCModelClient</a><span>(<span t="k"></span><span t="k"></span>mdl: <a href="nlpcraft/NCModel.html" t="t">NCModel</a>)<span t="k"> extends </span><span data-unresolved-link="" t="t">LazyLogging</span><span t="k"> with </span><span data-unresolved-link="" t="t">AutoCloseable</span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Client API to issue requests again given model. This the primary method of interacting with NLPCraft |
| from the user perspective.</p> |
| </div><div class="cover"><div class="doc"><p>Client API to issue requests again given model. This the primary method of interacting with NLPCraft |
| from the user perspective.</p> |
| </div><dl class="attributes"><dt>Value parameters:</dt><dd><dl class="attributes"><dt>mdl</dt><dd><p>A data model to issue requests against.</p> |
| </dd></dl></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCModelClient.scala#L42">NCModelClient.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">object </span></span><a href="nlpcraft/NCModelConfig$.html" class="documentableName ">NCModelConfig</a><span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Model configuration factory.</p> |
| </div><div class="cover"><div class="doc"><p>Model configuration factory.</p> |
| </div><dl class="attributes"><dt>Companion:</dt><dd><a href="nlpcraft/NCModelConfig.html">class</a></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCModelConfig.scala#L25">NCModelConfig.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">trait </span></span><a href="nlpcraft/NCModelConfig.html" class="documentableName ">NCModelConfig</a><span><span t="k"> extends </span><a href="nlpcraft/NCPropertyMap.html" t="t">NCPropertyMap</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Model configuration container.</p> |
| </div><div class="cover"><div class="doc"><p>Model configuration container.</p> |
| </div><dl class="attributes"><dt>See also:</dt><dd><div><div><p><a href="nlpcraft/NCModel.html#getConfig-0">NCModel.getConfig</a></p> |
| </div></div></dd><dt>Companion:</dt><dd><a href="nlpcraft/NCModelConfig$.html">object</a></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCModelConfig.scala#L94">NCModelConfig.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">trait </span></span><a href="nlpcraft/NCPipeline.html" class="documentableName ">NCPipeline</a><span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>NLP processing pipeline for the input request. Pipeline is associated with the model.</p> |
| </div><div class="cover"><div class="doc"><p>NLP processing pipeline for the input request. Pipeline is associated with the model.</p> |
| <p>An NLP pipeline is a container for the sequence of processing components that take the input text at the beginning |
| of the pipeline and produce the list of <a href="nlpcraft/NCVariant.html">variants</a> at the end of the pipeline. |
| Schematically the pipeline looks like this:</p> |
| <pre> |
| +----------+ +-----------+ +--------+ |
| *=========* +---------+ +---+-------+ | +---+-------+ | +---+-----+ | |
| : Text : -> | Token | -> | Token | | -> | Token | | -> | Entity | | ----. |
| : Input : | Parser | | Enrichers |--+ | Validators |--+ | Parsers |--+ \ |
| *=========* +---------+ +-----------+ +------------+ +---------+ \ |
| } |
| +--------+ +--------+ +-----------+ +----------+ / |
| *============* +---+-----+ | +---+-----+ | +---+--------+ | +---+-------+ | / |
| : Variants : <- | Variant | | <- | Entity | | <- | Entity | | <- | Entity | | <-' |
| : List : | Filters |--+ | Mappers |--+ | Validators |--+ | Enrichers |--+ |
| *============* +----- ---+ +----- ---+ +------------+ +-----------+ |
| </pre> |
| <p>The result variants are then passed further to the intent matching. Note that only one token parser |
| and at least one entity parser is required for the minimal pipeline.</p> |
| </div><dl class="attributes"><dt>See also:</dt><dd><div><div><p><a href="nlpcraft/NCToken.html">NCToken</a></p> |
| </div><div><p><a href="nlpcraft/NCEntity.html">NCEntity</a></p> |
| </div><div><p><a href="nlpcraft/NCVariant.html">NCVariant</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenParser.html">NCTokenParser</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenEnricher.html">NCTokenEnricher</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenValidator.html">NCTokenValidator</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityEnricher.html">NCEntityEnricher</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityMapper.html">NCEntityMapper</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityValidator.html">NCEntityValidator</a></p> |
| </div><div><p><a href="nlpcraft/NCVariantFilter.html">NCVariantFilter</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityValidator.html">NCEntityValidator</a></p> |
| </div></div></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPipeline.scala#L55">NCPipeline.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">class </span></span><a href="nlpcraft/NCPipelineBuilder.html" class="documentableName ">NCPipelineBuilder</a><span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Convenient builder for <a href="nlpcraft/NCPipeline.html">NCPipeline</a> instance.</p> |
| </div><div class="cover"><div class="doc"><p>Convenient builder for <a href="nlpcraft/NCPipeline.html">NCPipeline</a> instance.</p> |
| </div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPipelineBuilder.scala#L30">NCPipelineBuilder.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">trait </span></span><a href="nlpcraft/NCPropertyMap.html" class="documentableName ">NCPropertyMap</a><span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Map-like container that provides support for mutable runtime-only properties or metadata.</p> |
| </div><div class="cover"><div class="doc"><p>Map-like container that provides support for mutable runtime-only properties or metadata.</p> |
| </div><dl class="attributes"><dt>See also:</dt><dd><div><div><p><a href="nlpcraft/NCPropertyMapAdapter.html">NCPropertyMapAdapter</a></p> |
| </div><div><p><a href="nlpcraft/NCToken.html">NCToken</a></p> |
| </div><div><p><a href="nlpcraft/NCEntity.html">NCEntity</a></p> |
| </div><div><p><a href="nlpcraft/NCModelConfig.html">NCModelConfig</a></p> |
| </div></div></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPropertyMap.scala#L28">NCPropertyMap.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">class </span></span><a href="nlpcraft/NCPropertyMapAdapter.html" class="documentableName ">NCPropertyMapAdapter</a><span><span t="k"> extends </span><a href="nlpcraft/NCPropertyMap.html" t="t">NCPropertyMap</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Convenient adapter for <a href="nlpcraft/NCPropertyMap.html">NCPropertyMap</a> interface. Note that this class uses |
| <span data-unresolved-link="" title="Problem linking ConcurrentHashMap: No DRI found for query">ConcurrentHashMap</span> for its implementation making its access thread-safe.</p> |
| </div><div class="cover"><div class="doc"><p>Convenient adapter for <a href="nlpcraft/NCPropertyMap.html">NCPropertyMap</a> interface. Note that this class uses |
| <span data-unresolved-link="" title="Problem linking ConcurrentHashMap: No DRI found for query">ConcurrentHashMap</span> for its implementation making its access thread-safe.</p> |
| </div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPropertyMapAdapter.scala#L27">NCPropertyMapAdapter.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">class </span></span><a href="nlpcraft/NCRejection.html" class="documentableName ">NCRejection</a><span>(<span t="k"></span><span t="k"></span>msg: <a href="https://www.scala-lang.org/api/2.13.8/scala/Predef$.html#String" t="t">String</a>, <span t="k"></span>cause: <a href="https://www.scala-lang.org/api/2.13.8/scala.html#Throwable" t="t">Throwable</a>)<span t="k"> extends </span><span data-unresolved-link="" t="t">RuntimeException</span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>An exception to indicate a rejection of the user input. This exception is either thrown automatically by the |
| processing logic or can be thrown by the user from the intent callback.</p> |
| </div><div class="cover"><div class="doc"><p>An exception to indicate a rejection of the user input. This exception is either thrown automatically by the |
| processing logic or can be thrown by the user from the intent callback.</p> |
| <p>This exception typically indicates that user has not provided enough information in the input string |
| to have it processed automatically, without additional curation or modification. In most cases this means that |
| the user's input is either too short or too simple, too long or too complex, missing required context, or unrelated |
| to the requested data model.</p> |
| </div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCRejection.scala#L29">NCRejection.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">trait </span></span><a href="nlpcraft/NCRequest.html" class="documentableName ">NCRequest</a><span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Descriptor for the input user request. User request descriptor can be obtained via |
| <a href="nlpcraft/NCContext.html#getRequest-0">NCContext.getRequest</a> method.</p> |
| </div><div class="cover"><div class="doc"><p>Descriptor for the input user request. User request descriptor can be obtained via |
| <a href="nlpcraft/NCContext.html#getRequest-0">NCContext.getRequest</a> method.</p> |
| </div><dl class="attributes"><dt>See also:</dt><dd><div><div><p><a href="nlpcraft/NCContext.html#getRequest-0">NCContext.getRequest</a></p> |
| </div></div></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCRequest.scala#L26">NCRequest.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">object </span></span><a href="nlpcraft/NCResult$.html" class="documentableName ">NCResult</a><span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Convenient factory for creating <a href="nlpcraft/NCResult.html">NCResult</a> instances.</p> |
| </div><div class="cover"><div class="doc"><p>Convenient factory for creating <a href="nlpcraft/NCResult.html">NCResult</a> instances.</p> |
| </div><dl class="attributes"><dt>Companion:</dt><dd><a href="nlpcraft/NCResult.html">class</a></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCResult.scala#L23">NCResult.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">trait </span></span><a href="nlpcraft/NCResult.html" class="documentableName ">NCResult</a><span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Intent callback result.</p> |
| </div><div class="cover"><div class="doc"><p>Intent callback result.</p> |
| </div><dl class="attributes"><dt>Companion:</dt><dd><a href="nlpcraft/NCResult$.html">object</a></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCResult.scala#L64">NCResult.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">enum </span></span><a href="nlpcraft/NCResultType.html" class="documentableName ">NCResultType</a><span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Result types.</p> |
| </div><div class="cover"><div class="doc"><p>Result types.</p> |
| </div><dl class="attributes"><dt>See also:</dt><dd><div><div><p><a href="nlpcraft/NCResult.html#getType-0">NCResult.getType</a></p> |
| </div></div></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCResultType.scala#L25">NCResultType.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">trait </span></span><a href="nlpcraft/NCToken.html" class="documentableName ">NCToken</a><span><span t="k"> extends </span><a href="nlpcraft/NCPropertyMap.html" t="t">NCPropertyMap</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Represents a contiguous substring of the original input text produced by <a href="nlpcraft/NCTokenParser.html">NCTokenParser</a>. |
| A token is the result of <a href="nlpcraft/NCTokenParser.html">tokenization</a> - the process of demarcating and classifying |
| sections of a string of input characters. See <a href="nlpcraft/NCPipeline.html">NCPipeline</a> for documentation on the tokens place in the |
| overall processing pipeline.</p> |
| </div><div class="cover"><div class="doc"><p>Represents a contiguous substring of the original input text produced by <a href="nlpcraft/NCTokenParser.html">NCTokenParser</a>. |
| A token is the result of <a href="nlpcraft/NCTokenParser.html">tokenization</a> - the process of demarcating and classifying |
| sections of a string of input characters. See <a href="nlpcraft/NCPipeline.html">NCPipeline</a> for documentation on the tokens place in the |
| overall processing pipeline.</p> |
| <p>Note that both <a href="nlpcraft/NCToken.html">NCToken</a> and <a href="nlpcraft/NCEntity.html">NCEntity</a> interfaces extend <a href="nlpcraft/NCPropertyMap.html">NCPropertyMap</a> interface |
| that allows them to store custom metadata properties. Parser, enrichers and validators for tokens |
| and entities use this capability to store and check their properties in tokens and entities.</p> |
| </div><dl class="attributes"><dt>See also:</dt><dd><div><div><p><a href="nlpcraft/NCEntity.html">NCEntity</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenParser.html">NCTokenParser</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenEnricher.html">NCTokenEnricher</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenValidator.html">NCTokenValidator</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityParser.html">NCEntityParser</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityEnricher.html">NCEntityEnricher</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityValidator.html">NCEntityValidator</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityMapper.html">NCEntityMapper</a></p> |
| </div></div></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCToken.scala#L39">NCToken.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">trait </span></span><a href="nlpcraft/NCTokenEnricher.html" class="documentableName ">NCTokenEnricher</a><span><span t="k"> extends </span><a href="nlpcraft/NCLifecycle.html" t="t">NCLifecycle</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Optional pipeline component that can enrich previously parsed <a href="nlpcraft/NCToken.html">tokens</a>. |
| See <a href="nlpcraft/NCPipeline.html">NCPipeline</a> for documentation on the token enricher place in the overall processing pipeline.</p> |
| </div><div class="cover"><div class="doc"><p>Optional pipeline component that can enrich previously parsed <a href="nlpcraft/NCToken.html">tokens</a>. |
| See <a href="nlpcraft/NCPipeline.html">NCPipeline</a> for documentation on the token enricher place in the overall processing pipeline.</p> |
| </div><dl class="attributes"><dt>See also:</dt><dd><div><div><p><a href="nlpcraft/NCPipeline.html#getTokenEnrichers-0">NCPipeline.getTokenEnrichers</a></p> |
| </div><div><p><a href="nlpcraft/NCEntity.html">NCEntity</a></p> |
| </div><div><p><a href="nlpcraft/NCToken.html">NCToken</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenParser.html">NCTokenParser</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenValidator.html">NCTokenValidator</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityParser.html">NCEntityParser</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityEnricher.html">NCEntityEnricher</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityValidator.html">NCEntityValidator</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityMapper.html">NCEntityMapper</a></p> |
| </div></div></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenEnricher.scala#L35">NCTokenEnricher.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">trait </span></span><a href="nlpcraft/NCTokenParser.html" class="documentableName ">NCTokenParser</a><span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>A tokenizer that splits given text into the list of <a href="nlpcraft/NCToken.html">NCToken</a> objects. This is one of the user-defined |
| components of the processing <a href="nlpcraft/NCPipeline.html">pipeline</a>. See <a href="nlpcraft/NCPipeline.html">NCPipeline</a> for documentation on the token |
| parser place in the overall processing pipeline.</p> |
| </div><div class="cover"><div class="doc"><p>A tokenizer that splits given text into the list of <a href="nlpcraft/NCToken.html">NCToken</a> objects. This is one of the user-defined |
| components of the processing <a href="nlpcraft/NCPipeline.html">pipeline</a>. See <a href="nlpcraft/NCPipeline.html">NCPipeline</a> for documentation on the token |
| parser place in the overall processing pipeline.</p> |
| </div><dl class="attributes"><dt>See also:</dt><dd><div><div><p><a href="nlpcraft/NCPipeline.html#getTokenParser-0">NCPipeline.getTokenParser</a></p> |
| </div><div><p><a href="nlpcraft/NCEntity.html">NCEntity</a></p> |
| </div><div><p><a href="nlpcraft/NCToken.html">NCToken</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenParser.html">NCTokenParser</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenEnricher.html">NCTokenEnricher</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenValidator.html">NCTokenValidator</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityParser.html">NCEntityParser</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityEnricher.html">NCEntityEnricher</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityValidator.html">NCEntityValidator</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityMapper.html">NCEntityMapper</a></p> |
| </div></div></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenParser.scala#L36">NCTokenParser.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">trait </span></span><a href="nlpcraft/NCTokenValidator.html" class="documentableName ">NCTokenValidator</a><span><span t="k"> extends </span><a href="nlpcraft/NCLifecycle.html" t="t">NCLifecycle</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>A pipeline component that allows to validate a list of tokens produced by token parser before they get |
| sent further down the pipeline. This is one of the user-defined |
| components of the processing <a href="nlpcraft/NCPipeline.html">pipeline</a>. See <a href="nlpcraft/NCPipeline.html">NCPipeline</a> for documentation on the token |
| parser place in the overall processing pipeline.</p> |
| </div><div class="cover"><div class="doc"><p>A pipeline component that allows to validate a list of tokens produced by token parser before they get |
| sent further down the pipeline. This is one of the user-defined |
| components of the processing <a href="nlpcraft/NCPipeline.html">pipeline</a>. See <a href="nlpcraft/NCPipeline.html">NCPipeline</a> for documentation on the token |
| parser place in the overall processing pipeline.</p> |
| </div><dl class="attributes"><dt>See also:</dt><dd><div><div><p><a href="nlpcraft/NCPipeline.html#getTokenValidators-0">NCPipeline.getTokenValidators</a></p> |
| </div><div><p><a href="nlpcraft/NCEntity.html">NCEntity</a></p> |
| </div><div><p><a href="nlpcraft/NCToken.html">NCToken</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenParser.html">NCTokenParser</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenEnricher.html">NCTokenEnricher</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityParser.html">NCEntityParser</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityEnricher.html">NCEntityEnricher</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityValidator.html">NCEntityValidator</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityMapper.html">NCEntityMapper</a></p> |
| </div></div></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenValidator.scala#L37">NCTokenValidator.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">trait </span></span><a href="nlpcraft/NCVariant.html" class="documentableName ">NCVariant</a><span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>A parsing variant is a list of entities defining one possible parsing of the input query. Note that a given user |
| input almost always has one or more possible parsing variants. Furthermore, depending on the model |
| configuration a user input can produce hundreds and even thousands of parsing variants.</p> |
| </div><div class="cover"><div class="doc"><p>A parsing variant is a list of entities defining one possible parsing of the input query. Note that a given user |
| input almost always has one or more possible parsing variants. Furthermore, depending on the model |
| configuration a user input can produce hundreds and even thousands of parsing variants.</p> |
| <p>Pipeline provides user-defined variant filter component <a href="nlpcraft/NCVariantFilter.html">NCVariantFilter</a> to allow a programmatic filtration of |
| the variants. Note that even a few dozens of variants can significantly slow down the overall NLPCraft processing.</p> |
| </div><dl class="attributes"><dt>See also:</dt><dd><div><div><p><span data-unresolved-link="" title="Problem linking NCModel.onVariant(): No DRI found for query">NCModel.onVariant()</span></p> |
| </div></div></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCVariant.scala#L30">NCVariant.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement"><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">trait </span></span><a href="nlpcraft/NCVariantFilter.html" class="documentableName ">NCVariantFilter</a><span><span t="k"> extends </span><a href="nlpcraft/NCLifecycle.html" t="t">NCLifecycle</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>A pipeline component that allows to filter out unnecessary <a href="nlpcraft/NCVariant.html">parsing variants</a>. Note that a given user |
| input almost always has one or more possible different parsing variants. Furthermore, depending on the model |
| configuration a user input can produce hundreds and even thousands of parsing variants. This is one of the user-defined |
| components of the processing <a href="nlpcraft/NCPipeline.html">pipeline</a>. See <a href="nlpcraft/NCPipeline.html">NCPipeline</a> for documentation on the token |
| parser place in the overall processing pipeline.</p> |
| </div><div class="cover"><div class="doc"><p>A pipeline component that allows to filter out unnecessary <a href="nlpcraft/NCVariant.html">parsing variants</a>. Note that a given user |
| input almost always has one or more possible different parsing variants. Furthermore, depending on the model |
| configuration a user input can produce hundreds and even thousands of parsing variants. This is one of the user-defined |
| components of the processing <a href="nlpcraft/NCPipeline.html">pipeline</a>. See <a href="nlpcraft/NCPipeline.html">NCPipeline</a> for documentation on the token |
| parser place in the overall processing pipeline.</p> |
| </div><dl class="attributes"><dt>See also:</dt><dd><div><div><p><a href="nlpcraft/NCPipeline.html#getVariantFilters-0">NCPipeline.getVariantFilters</a></p> |
| </div><div><p><a href="nlpcraft/NCEntity.html">NCEntity</a></p> |
| </div><div><p><a href="nlpcraft/NCToken.html">NCToken</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenParser.html">NCTokenParser</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenEnricher.html">NCTokenEnricher</a></p> |
| </div><div><p><a href="nlpcraft/NCTokenValidator.html">NCTokenValidator</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityParser.html">NCEntityParser</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityEnricher.html">NCEntityEnricher</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityValidator.html">NCEntityValidator</a></p> |
| </div><div><p><a href="nlpcraft/NCEntityMapper.html">NCEntityMapper</a></p> |
| </div></div></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCVariantFilter.scala#L38">NCVariantFilter.scala</a></dd></dl></div></div></div></div></div></div></div><div data-togglable="Value members" class="tab selected"><h2 data-togglable="Value members">Value members</h2><div class="documentableList"><h3 class="groupHeader">Concrete methods</h3><div class="documentableElement" id="E-7a9"><a link="nlpcraft.html#E-7a9" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="nlpcraft.html#E-7a9" class="documentableName ">E</a><span>[<span t="k"></span><span data-unresolved-link="" t="t">T</span>](<span t="k"></span><span t="k"></span>msg: <a href="https://www.scala-lang.org/api/2.13.8/scala/Predef$.html#String" t="t">String</a>, <span t="k"></span>cause: <a href="https://www.scala-lang.org/api/2.13.8/scala.html#Throwable" t="t">Throwable</a>): <span t="t">T</span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Global syntax sugar for throwing <a href="nlpcraft/NCException.html">NCException</a>.</p> |
| </div><div class="cover"><div class="doc"><p>Global syntax sugar for throwing <a href="nlpcraft/NCException.html">NCException</a>.</p> |
| </div><dl class="attributes"><dt>Value parameters:</dt><dd><dl class="attributes"><dt>cause</dt><dd><p>Optional cause.</p> |
| </dd><dt>msg</dt><dd><p>Exception message.</p> |
| </dd></dl></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCGlobals.scala#L30">NCGlobals.scala</a></dd></dl></div></div></div></div></div></div></div><div data-togglable="Extensions" class="tab selected"><h2 data-togglable="Extensions">Extensions</h2><div class="documentableList"><h3 class="groupHeader">Extensions</h3><div><span class="groupHeader"><span t="k">extension </span>[<span t="k"></span><span data-unresolved-link="" t="t">T</span>](opt: <a href="https://www.scala-lang.org/api/2.13.8/scala/Option.html" t="t">Option</a>[<span data-unresolved-link="" t="t">T</span>])</span><div class="documentableElement" id="===-ffffff15"><a link="nlpcraft.html#===-ffffff15" class="documentableAnchor"></a><div><span class="annotations monospace"><span data-unresolved-link="" t="t">@targetName</span>("equalEqualEqualOpt") </span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="nlpcraft.html#===-ffffff15" class="documentableName ">===</a><span>(<span t="k"></span><span t="k"></span>x: <a href="https://www.scala-lang.org/api/2.13.8/scala/Option.html" t="t">Option</a>[<span data-unresolved-link="" t="t">T</span>]): <a href="https://www.scala-lang.org/api/2.13.8/scala/Boolean.html" t="t">Boolean</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Provides equality check between two options' values. This check is <code>true</code> when both options |
| are defined and have the same value.</p> |
| </div><div class="cover"><div class="doc"><p>Provides equality check between two options' values. This check is <code>true</code> when both options |
| are defined and have the same value.</p> |
| </div><dl class="attributes"><dt>Value parameters:</dt><dd><dl class="attributes"><dt>x</dt><dd><p>Option to compare.</p> |
| </dd></dl></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCGlobals.scala#L40">NCGlobals.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="===-fffffe7f"><a link="nlpcraft.html#===-fffffe7f" class="documentableAnchor"></a><div><span class="annotations monospace"><span data-unresolved-link="" t="t">@targetName</span>("equalEqualEqual") </span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="nlpcraft.html#===-fffffe7f" class="documentableName ">===</a><span>(<span t="k"></span><span t="k"></span>x: <span data-unresolved-link="" t="t">T</span>): <a href="https://www.scala-lang.org/api/2.13.8/scala/Boolean.html" t="t">Boolean</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Provides equality check between the option and the value of the same type. This check is <code>true</code> when |
| the option is defined and its value is equal to the given value.</p> |
| </div><div class="cover"><div class="doc"><p>Provides equality check between the option and the value of the same type. This check is <code>true</code> when |
| the option is defined and its value is equal to the given value.</p> |
| </div><dl class="attributes"><dt>Value parameters:</dt><dd><dl class="attributes"><dt>x</dt><dd><p>Value to compare the option to</p> |
| </dd></dl></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCGlobals.scala#L49">NCGlobals.scala</a></dd></dl></div></div></div></div></div></div><div><span class="groupHeader"><span t="k">extension </span>[<span t="k"></span><span data-unresolved-link="" t="t">T</span>](v: <span data-unresolved-link="" t="t">T</span>)</span><div class="documentableElement" id="?-fffff801"><a link="nlpcraft.html#?-fffff801" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="nlpcraft.html#?-fffff801" class="documentableName ">?</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/Option.html" t="t">Option</a>[<span t="t">T</span>]</span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"></div><div class="cover"><div class="doc"></div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCGlobals.scala#L52">NCGlobals.scala</a></dd></dl></div></div></div></div></div></div><div><span class="groupHeader"><span t="k">extension </span>(v: <a href="https://www.scala-lang.org/api/2.13.8/scala/Int.html" t="t">Int</a>)</span><div class="documentableElement" id="days-fffffbe0"><a link="nlpcraft.html#days-fffffbe0" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="nlpcraft.html#days-fffffbe0" class="documentableName ">days</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/Int.html" t="t">Int</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Converts milliseconds <code>int</code> value to days.</p> |
| </div><div class="cover"><div class="doc"><p>Converts milliseconds <code>int</code> value to days.</p> |
| </div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCGlobals.scala#L62">NCGlobals.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="gb-fffffbe0"><a link="nlpcraft.html#gb-fffffbe0" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="nlpcraft.html#gb-fffffbe0" class="documentableName ">gb</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/Int.html" t="t">Int</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Converts bytes <code>int</code> value to gigabytes.</p> |
| </div><div class="cover"><div class="doc"><p>Converts bytes <code>int</code> value to gigabytes.</p> |
| </div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCGlobals.scala#L66">NCGlobals.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="hours-fffffbe0"><a link="nlpcraft.html#hours-fffffbe0" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="nlpcraft.html#hours-fffffbe0" class="documentableName ">hours</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/Int.html" t="t">Int</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Converts milliseconds <code>int</code> value to hours.</p> |
| </div><div class="cover"><div class="doc"><p>Converts milliseconds <code>int</code> value to hours.</p> |
| </div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCGlobals.scala#L60">NCGlobals.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="kb-fffffbe0"><a link="nlpcraft.html#kb-fffffbe0" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="nlpcraft.html#kb-fffffbe0" class="documentableName ">kb</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/Int.html" t="t">Int</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Converts bytes <code>int</code> value to kilobytes.</p> |
| </div><div class="cover"><div class="doc"><p>Converts bytes <code>int</code> value to kilobytes.</p> |
| </div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCGlobals.scala#L70">NCGlobals.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="mb-fffffbe0"><a link="nlpcraft.html#mb-fffffbe0" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="nlpcraft.html#mb-fffffbe0" class="documentableName ">mb</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/Int.html" t="t">Int</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Converts bytes <code>int</code> value to megabytes.</p> |
| </div><div class="cover"><div class="doc"><p>Converts bytes <code>int</code> value to megabytes.</p> |
| </div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCGlobals.scala#L68">NCGlobals.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="mins-fffffbe0"><a link="nlpcraft.html#mins-fffffbe0" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="nlpcraft.html#mins-fffffbe0" class="documentableName ">mins</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/Int.html" t="t">Int</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Converts milliseconds <code>int</code> value to minutes.</p> |
| </div><div class="cover"><div class="doc"><p>Converts milliseconds <code>int</code> value to minutes.</p> |
| </div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCGlobals.scala#L58">NCGlobals.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="secs-fffffbe0"><a link="nlpcraft.html#secs-fffffbe0" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="nlpcraft.html#secs-fffffbe0" class="documentableName ">secs</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/Int.html" t="t">Int</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Converts milliseconds <code>int</code> value to seconds.</p> |
| </div><div class="cover"><div class="doc"><p>Converts milliseconds <code>int</code> value to seconds.</p> |
| </div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCGlobals.scala#L56">NCGlobals.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="tb-fffffbe0"><a link="nlpcraft.html#tb-fffffbe0" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="nlpcraft.html#tb-fffffbe0" class="documentableName ">tb</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/Int.html" t="t">Int</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Converts bytes <code>int</code> value to terabytes.</p> |
| </div><div class="cover"><div class="doc"><p>Converts bytes <code>int</code> value to terabytes.</p> |
| </div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCGlobals.scala#L64">NCGlobals.scala</a></dd></dl></div></div></div></div></div></div><div><span class="groupHeader"><span t="k">extension </span>(v: <a href="https://www.scala-lang.org/api/2.13.8/scala/Long.html" t="t">Long</a>)</span><div class="documentableElement" id="days-fffff788"><a link="nlpcraft.html#days-fffff788" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="nlpcraft.html#days-fffff788" class="documentableName ">days</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/Long.html" t="t">Long</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Converts milliseconds <code>long</code> value to days.</p> |
| </div><div class="cover"><div class="doc"><p>Converts milliseconds <code>long</code> value to days.</p> |
| </div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCGlobals.scala#L80">NCGlobals.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="gb-fffff788"><a link="nlpcraft.html#gb-fffff788" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="nlpcraft.html#gb-fffff788" class="documentableName ">gb</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/Long.html" t="t">Long</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Converts bytes <code>long</code> value to gigabytes.</p> |
| </div><div class="cover"><div class="doc"><p>Converts bytes <code>long</code> value to gigabytes.</p> |
| </div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCGlobals.scala#L84">NCGlobals.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="hours-fffff788"><a link="nlpcraft.html#hours-fffff788" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="nlpcraft.html#hours-fffff788" class="documentableName ">hours</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/Long.html" t="t">Long</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Converts milliseconds <code>long</code> value to hours.</p> |
| </div><div class="cover"><div class="doc"><p>Converts milliseconds <code>long</code> value to hours.</p> |
| </div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCGlobals.scala#L78">NCGlobals.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="kb-fffff788"><a link="nlpcraft.html#kb-fffff788" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="nlpcraft.html#kb-fffff788" class="documentableName ">kb</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/Long.html" t="t">Long</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Converts bytes <code>long</code> value to kilobytes.</p> |
| </div><div class="cover"><div class="doc"><p>Converts bytes <code>long</code> value to kilobytes.</p> |
| </div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCGlobals.scala#L88">NCGlobals.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="mb-fffff788"><a link="nlpcraft.html#mb-fffff788" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="nlpcraft.html#mb-fffff788" class="documentableName ">mb</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/Long.html" t="t">Long</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Converts bytes <code>long</code> value to megabytes.</p> |
| </div><div class="cover"><div class="doc"><p>Converts bytes <code>long</code> value to megabytes.</p> |
| </div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCGlobals.scala#L86">NCGlobals.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="mins-fffff788"><a link="nlpcraft.html#mins-fffff788" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="nlpcraft.html#mins-fffff788" class="documentableName ">mins</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/Long.html" t="t">Long</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Converts milliseconds <code>long</code> value to minutes.</p> |
| </div><div class="cover"><div class="doc"><p>Converts milliseconds <code>long</code> value to minutes.</p> |
| </div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCGlobals.scala#L76">NCGlobals.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="secs-fffff788"><a link="nlpcraft.html#secs-fffff788" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="nlpcraft.html#secs-fffff788" class="documentableName ">secs</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/Long.html" t="t">Long</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Converts milliseconds <code>long</code> value to seconds.</p> |
| </div><div class="cover"><div class="doc"><p>Converts milliseconds <code>long</code> value to seconds.</p> |
| </div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCGlobals.scala#L74">NCGlobals.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="tb-fffff788"><a link="nlpcraft.html#tb-fffff788" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">def </span></span><a href="nlpcraft.html#tb-fffff788" class="documentableName ">tb</a><span>: <a href="https://www.scala-lang.org/api/2.13.8/scala/Long.html" t="t">Long</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Converts bytes <code>long</code> value to terabytes.</p> |
| </div><div class="cover"><div class="doc"><p>Converts bytes <code>long</code> value to terabytes.</p> |
| </div><dl class="attributes"><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCGlobals.scala#L82">NCGlobals.scala</a></dd></dl></div></div></div></div></div></div></div></div></div></div></div></div></div></main><footer><div id="generated-by"><span class="footer-text">Generated by</span><a href="https://github.com/lampepfl/dotty/tree/master/scaladoc"><img src="../../images/scaladoc_logo.svg" alt="scaladoc" class="scaladoc_logo"></img><img src="../../images/scaladoc_logo_dark.svg" alt="scaladoc" class="scaladoc_logo_dark"></img></a></div><span id="footer-text">Apache NLPCraft</span><div class="socials"><span class="footer-text">Social links</span><a href="https://github.com/apache/incubator-nlpcraft"><span class="social-icon" data-icon-path="github-icon-black.png"></span></a></div><div class="mode"><span class="footer-text">Mode</span><label id="theme-toggle" class="switch"><input type="checkbox"></input><span class="slider"></span></label></div><span class="go-to-top-icon"><a href="#container"><span class="icon-vertical_align_top"></span><span class="footer-text">Back to top</span></a></span></footer></div></div></body></html> |
