| <html><head><meta charset="utf-8"></meta><meta name="viewport" content="width=device-width, initial-scale=1"></meta><title>NCNLPEntityParser</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"><span class="nh "><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="../../NCContext.html"><span class="micon tr"></span><span>NCContext</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCConversation.html"><span class="micon tr"></span><span>NCConversation</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCCuration.html"><span class="micon cl"></span><span>NCCuration</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCDialogFlowItem.html"><span class="micon tr"></span><span>NCDialogFlowItem</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCEntity.html"><span class="micon tr"></span><span>NCEntity</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCEntityEnricher.html"><span class="micon tr"></span><span>NCEntityEnricher</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCEntityMapper.html"><span class="micon tr"></span><span>NCEntityMapper</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCEntityParser.html"><span class="micon tr"></span><span>NCEntityParser</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCEntityValidator.html"><span class="micon tr"></span><span>NCEntityValidator</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCException.html"><span class="micon cl"></span><span>NCException</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCIntentMatch.html"><span class="micon tr"></span><span>NCIntentMatch</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCIntentSkip.html"><span class="micon cl"></span><span>NCIntentSkip</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCLifecycle.html"><span class="micon tr"></span><span>NCLifecycle</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCMatchedCallback.html"><span class="micon tr"></span><span>NCMatchedCallback</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCModel.html"><span class="micon tr"></span><span>NCModel</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCModelClient.html"><span class="micon cl"></span><span>NCModelClient</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCModelConfig$.html"><span class="micon ob"></span><span>NCModelConfig</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCModelConfig.html"><span class="micon tr"></span><span>NCModelConfig</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCPipeline.html"><span class="micon tr"></span><span>NCPipeline</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCPipelineBuilder.html"><span class="micon cl"></span><span>NCPipelineBuilder</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCPropertyMap.html"><span class="micon tr"></span><span>NCPropertyMap</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCPropertyMapAdapter.html"><span class="micon cl"></span><span>NCPropertyMapAdapter</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCRejection.html"><span class="micon cl"></span><span>NCRejection</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCRequest.html"><span class="micon tr"></span><span>NCRequest</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCResult$.html"><span class="micon ob"></span><span>NCResult</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCResult.html"><span class="micon tr"></span><span>NCResult</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCResultType.html"><span class="micon en"></span><span>NCResultType</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCToken.html"><span class="micon tr"></span><span>NCToken</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCTokenEnricher.html"><span class="micon tr"></span><span>NCTokenEnricher</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCTokenParser.html"><span class="micon tr"></span><span>NCTokenParser</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCTokenValidator.html"><span class="micon tr"></span><span>NCTokenValidator</span></a></span></div><div class="ni "><span class="nh "><a href="../../NCVariant.html"><span class="micon tr"></span><span>NCVariant</span></a></span></div><div class="ni "><span class="nh "><a href="../../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="../enrichers.html"><span class="micon pa"></span><span>org.apache.nlpcraft.nlp.enrichers</span></a></span><div class="ni "><span class="nh "><a href="../enrichers/NCBracketsTokenEnricher.html"><span class="micon cl"></span><span>NCBracketsTokenEnricher</span></a></span></div><div class="ni "><span class="nh "><a href="../enrichers/NCDictionaryTokenEnricher.html"><span class="micon cl"></span><span>NCDictionaryTokenEnricher</span></a></span></div><div class="ni "><span class="nh "><a href="../enrichers/NCEnStopWordsTokenEnricher.html"><span class="micon cl"></span><span>NCEnStopWordsTokenEnricher</span></a></span></div><div class="ni "><span class="nh "><a href="../enrichers/NCOpenNLPTokenEnricher.html"><span class="micon cl"></span><span>NCOpenNLPTokenEnricher</span></a></span></div><div class="ni "><span class="nh "><a href="../enrichers/NCQuotesTokenEnricher.html"><span class="micon cl"></span><span>NCQuotesTokenEnricher</span></a></span></div><div class="ni "><span class="nh "><a href="../enrichers/NCSwearWordsTokenEnricher.html"><span class="micon cl"></span><span>NCSwearWordsTokenEnricher</span></a></span></div></div><div class="ni expanded"><span class="nh expanded"><span class="ar"></span><a href="../parsers.html"><span class="micon pa"></span><span>org.apache.nlpcraft.nlp.parsers</span></a></span><div class="ni expanded"><span class="nh selected"><a href="NCNLPEntityParser.html"><span class="micon cl"></span><span>NCNLPEntityParser</span></a></span></div><div class="ni "><span class="nh "><a href="NCOpenNLPEntityParser.html"><span class="micon cl"></span><span>NCOpenNLPEntityParser</span></a></span></div><div class="ni "><span class="nh "><a href="NCOpenNLPTokenParser.html"><span class="micon cl"></span><span>NCOpenNLPTokenParser</span></a></span></div><div class="ni "><span class="nh "><a href="NCSemanticElement.html"><span class="micon tr"></span><span>NCSemanticElement</span></a></span></div><div class="ni "><span class="nh "><a href="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="../stemmer.html"><span class="micon pa"></span><span>org.apache.nlpcraft.nlp.stemmer</span></a></span><div class="ni "><span class="nh "><a href="../stemmer/NCEnStemmer.html"><span class="micon cl"></span><span>NCEnStemmer</span></a></span></div><div class="ni "><span class="nh "><a href="../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="../parsers.html">org.apache.nlpcraft.nlp.parsers</a>/<a href="NCNLPEntityParser.html">NCNLPEntityParser</a></div><div id="content"><div><div class="cover-header"><span class="micon cl"></span><h1>NCNLPEntityParser</h1></div><div class="signature monospace"><span class="annotations monospace"></span><div class="signature"><span class="modifiers"></span><span class="kind"><span t="k">class </span></span><a href="NCNLPEntityParser.html" class="documentableName ">NCNLPEntityParser</a><span>(<span t="k"></span><span t="k"></span>predicate: <a href="../../NCToken.html" t="t">NCToken</a><span t="k"> => </span><a href="https://www.scala-lang.org/api/2.13.8/scala/Boolean.html" t="t">Boolean</a>)<span t="k"> extends </span><a href="../../NCEntityParser.html" t="t">NCEntityParser</a></span></div></div><div class="cover"><div class="doc"><p>Common NLP data <a href="../../NCEntityParser.html">entity parser</a>.</p> |
| <p>This parser converts list of input <a href="../../NCToken.html">NCToken</a> instances <strong>one-to-one</strong> to the list of <a href="../../NCEntity.html">NCEntity</a> instances with |
| type <strong>nlp:entity</strong>. All <a href="../../NCEntity.html">NCEntity</a> instances in the result list will contain the following |
| <a href="../../NCPropertyMap.html">metadata</a> properties:</p> |
| <ul> |
| <li><code>nlp:entity:text</code> - token's text.</li> |
| <li><code>nlp:entity:index</code> - token's index in the input sentence.</li> |
| <li><code>nlp:entity:startCharIndex</code> - token text's first character index in the input sentence.</li> |
| <li><code>nlp:entity:endCharIndex</code> - token text 's last character index in the input sentence.</li> |
| </ul> |
| <p>Note that <a href="../../NCEntity.html">NCEntity</a> instances inherit all <a href="../../NCToken.html">NCToken</a> <a href="../../NCPropertyMap.html">metadata</a> properties from its |
| corresponding token with new name that is prefixed with <strong>'nlp:entity:'</strong>. For example, for token property <strong>prop</strong> |
| the corresponding inherited entity property name will be <strong>nlp:entity:prop</strong>.</p> |
| </div><dl class="attributes"><dt>Value parameters:</dt><dd><dl class="attributes"><dt>predicate</dt><dd><p>Predicate which allows to filter list of converted <a href="../../NCToken.html">NCToken</a> instances. Only tokens that |
| satisfy given predicate will convert to entity by this parser. By default all <a href="../../NCToken.html">NCToken</a> instances are |
| converted.</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/nlp/parsers/NCNLPEntityParser.scala#L52">NCNLPEntityParser.scala</a></dd></dl></div><div class="tabs single"><div class="names"><button data-togglable="graph" class="tab showGraph">Graph</button><button data-togglable="supertypes" class="tab ">Supertypes</button></div><div class="contents"><div data-togglable="graph" class="tab showGraph"><div id="inheritance-diagram" class="diagram-class showGraph"><input value="Reset zoom" type="button" class="btn" onclick="zoomOut()"></input><svg id="graph"></svg><script type="text/dot" id="dot"> digraph g { |
| node0 [id=node0, label="<span style=\"color: #FFFFFF;\">class <a href=\"NCNLPEntityParser.html\" t=\"t\">NCNLPEntityParser</a></span>", style="fill: #45AD7D;"]; |
| node1 [id=node1, label="<span style=\"color: #FFFFFF;\">class <span data-unresolved-link=\"\" t=\"t\">Object</span></span>", style="fill: #45AD7D;"]; |
| node2 [id=node2, label="<span style=\"color: #FFFFFF;\">class <span data-unresolved-link=\"\" t=\"t\">Any</span></span>", style="fill: #45AD7D;"]; |
| node3 [id=node3, label="<span style=\"color: #FFFFFF;\">trait <span data-unresolved-link=\"\" t=\"t\">Matchable</span></span>", style="fill: #1CAACF;"]; |
| node4 [id=node4, label="<span style=\"color: #FFFFFF;\">trait <a href=\"../../NCEntityParser.html\" t=\"t\">NCEntityParser</a></span>", style="fill: #1CAACF;"]; |
| node5 [id=node5, label="<span style=\"color: #FFFFFF;\">trait <a href=\"../../NCLifecycle.html\" t=\"t\">NCLifecycle</a></span>", style="fill: #1CAACF;"]; |
| |
| |
| node0 -> node1; |
| node1 -> node2; |
| node1 -> node3; |
| node3 -> node2; |
| node0 -> node4; |
| node4 -> node1; |
| node4 -> node5; |
| node5 -> node1; |
| |
| } |
| </script></div></div><div data-togglable="supertypes" class="tab "><div class="symbol monospace"><div>trait <a href="../../NCEntityParser.html" t="t">NCEntityParser</a></div><div>trait <a href="../../NCLifecycle.html" t="t">NCLifecycle</a></div><div>class <span data-unresolved-link="" t="t">Object</span></div><div>trait <span data-unresolved-link="" t="t">Matchable</span></div><div>class <span data-unresolved-link="" t="t">Any</span></div></div></div></div></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="Value members" class="tab selected">Value members</button></div><div class="contents"><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="parse-fffff77c" data-f-keywords="override"><a link="NCNLPEntityParser.html#parse-fffff77c" class="documentableAnchor"></a><div><span class="annotations monospace"></span></div><div class="header monospace"><div class="signature"><span class="modifiers"><span t="k">override </span></span><span class="kind"><span t="k">def </span></span><a href="NCNLPEntityParser.html#parse-fffff77c" class="documentableName ">parse</a><span>(<span t="k"></span><span t="k"></span>req: <a href="../../NCRequest.html" t="t">NCRequest</a>, <span t="k"></span>cfg: <a href="../../NCModelConfig.html" t="t">NCModelConfig</a>, <span t="k"></span>toks: <a href="https://www.scala-lang.org/api/2.13.8/scala/collection/immutable/List.html" t="t">List</a>[<a href="../../NCToken.html" t="t">NCToken</a>]): <a href="https://www.scala-lang.org/api/2.13.8/scala/collection/immutable/List.html" t="t">List</a>[<a href="../../NCEntity.html" t="t">NCEntity</a>]</span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Parses and converts given list of tokens into the list of entities.</p> |
| </div><div class="cover"><div class="doc"><p>Parses and converts given list of tokens into the list of entities.</p> |
| </div><dl class="attributes"><dt>Definition Classes</dt><dd><div><a href="../../NCEntityParser.html">NCEntityParser</a></div></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/NCNLPEntityParser.scala#L56">NCNLPEntityParser.scala</a></dd></dl></div></div></div></div></div></div><div class="documentableList"><h3 class="groupHeader">Inherited methods</h3><div class="documentableElement" id="onStart-fffff138" data-f-inherited="NCLifecycle"><a link="NCNLPEntityParser.html#onStart-fffff138" 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="NCNLPEntityParser.html#onStart-fffff138" class="documentableName ">onStart</a><span>(<span t="k"></span><span t="k"></span>cfg: <a href="../../NCModelConfig.html" t="t">NCModelConfig</a>): <a href="https://www.scala-lang.org/api/2.13.8/scala/Unit.html" t="t">Unit</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Called when the component starts. Default implementation is no-op.</p> |
| </div><div class="cover"><div class="doc"><p>Called when the component starts. Default implementation is no-op.</p> |
| </div><dl class="attributes"><dt>Value parameters:</dt><dd><dl class="attributes"><dt>cfg</dt><dd><p>Configuration of the model this component is associated with.</p> |
| </dd></dl></dd><dt>Inherited from:</dt><dd><a href="../../NCLifecycle.html#onStart-fffff138">NCLifecycle</a></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCLifecycle.scala#L36">NCLifecycle.scala</a></dd></dl></div></div></div></div></div><div class="documentableElement" id="onStop-fffff138" data-f-inherited="NCLifecycle"><a link="NCNLPEntityParser.html#onStop-fffff138" 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="NCNLPEntityParser.html#onStop-fffff138" class="documentableName ">onStop</a><span>(<span t="k"></span><span t="k"></span>cfg: <a href="../../NCModelConfig.html" t="t">NCModelConfig</a>): <a href="https://www.scala-lang.org/api/2.13.8/scala/Unit.html" t="t">Unit</a></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Called when the component stops. Default implementation is no-op.</p> |
| </div><div class="cover"><div class="doc"><p>Called when the component stops. Default implementation is no-op.</p> |
| </div><dl class="attributes"><dt>Value parameters:</dt><dd><dl class="attributes"><dt>cfg</dt><dd><p>Configuration of the model this component is associated with.</p> |
| </dd></dl></dd><dt>Inherited from:</dt><dd><a href="../../NCLifecycle.html#onStop-fffff138">NCLifecycle</a></dd><dt>Source:</dt><dd><a href="https://github.com/apache/incubator-nlpcraft/blob/master/nlpcraft/src/main/scala/org/apache/nlpcraft/NCLifecycle.scala#L43">NCLifecycle.scala</a></dd></dl></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> |
