| <html><head><meta charset="utf-8"></meta><meta name="viewport" content="width=device-width, initial-scale=1"></meta><title>org.apache.nlpcraft.nlp.enrichers</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 expanded"><span class="nh selected expanded"><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"><span class="nh "><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 "><span class="nh "><a href="parsers/NCNLPEntityParser.html"><span class="micon cl"></span><span>NCNLPEntityParser</span></a></span></div><div class="ni "><span class="nh "><a href="parsers/NCOpenNLPEntityParser.html"><span class="micon cl"></span><span>NCOpenNLPEntityParser</span></a></span></div><div class="ni "><span class="nh "><a href="parsers/NCOpenNLPTokenParser.html"><span class="micon cl"></span><span>NCOpenNLPTokenParser</span></a></span></div><div class="ni "><span class="nh "><a href="parsers/NCSemanticElement.html"><span class="micon tr"></span><span>NCSemanticElement</span></a></span></div><div class="ni "><span class="nh "><a href="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="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="enrichers.html">org.apache.nlpcraft.nlp.enrichers</a></div><div id="content"><div><div class="cover-header"><span class="micon pa"></span><h1>org.apache.nlpcraft.nlp.enrichers</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="enrichers.html" class="documentableName ">org.apache.nlpcraft.nlp.enrichers</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></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">class </span></span><a href="enrichers/NCBracketsTokenEnricher.html" class="documentableName ">NCBracketsTokenEnricher</a><span><span t="k"> extends </span><a href="../NCTokenEnricher.html" t="t">NCTokenEnricher</a><span t="k"> with </span><span data-unresolved-link="" t="t">LazyLogging</span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Brackets <a href="../NCTokenEnricher.html">token enricher</a>.</p> |
| </div><div class="cover"><div class="doc"><p>Brackets <a href="../NCTokenEnricher.html">token enricher</a>.</p> |
| <p>This enricher adds <code>brackets</code> boolean <a href="../NCPropertyMap.html">metadata</a> property to the <a href="../NCToken.html">token</a> |
| instance if the word it represents is enclosed in brackets. Supported brackets are: <code>()</code>, <code>{}</code>, <code>[]</code> and <code><></code>.</p> |
| <p><strong>NOTE:</strong> invalid enclosed brackets are ignored and for all input tokens property <code>brackets</code> assigned as <code>false</code>.</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/nlp/enrichers/NCBracketsTokenEnricher.scala#L44">NCBracketsTokenEnricher.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="enrichers/NCDictionaryTokenEnricher.html" class="documentableName ">NCDictionaryTokenEnricher</a><span>(<span t="k"></span><span t="k"></span>dictRes: <a href="https://www.scala-lang.org/api/2.13.8/scala/Predef$.html#String" t="t">String</a>)<span t="k"> extends </span><a href="../NCTokenEnricher.html" t="t">NCTokenEnricher</a><span t="k"> with </span><span data-unresolved-link="" t="t">LazyLogging</span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Dictionary-based "known-word" <a href="../NCTokenEnricher.html">token enricher</a>.</p> |
| </div><div class="cover"><div class="doc"><p>Dictionary-based "known-word" <a href="../NCTokenEnricher.html">token enricher</a>.</p> |
| <p>This enricher adds <code>dict</code> boolean <a href="../NCPropertyMap.html">metadata</a> property to the <a href="../NCToken.html">token</a> |
| instance if word it represents is a known dictionary word, i.e. the configured dictionary contains this word's |
| lemma. The value <code>true</code> of the metadata property indicates that this word's lemma is found in the dictionary, |
| <code>false</code> value indicates otherwise.</p> |
| <p><strong>NOTE:</strong> this implementation requires <code>lemma</code> string <a href="../NCPropertyMap.html">metadata</a> property that contains |
| token's lemma. You can configure <a href="enrichers/NCOpenNLPTokenEnricher.html">NCOpenNLPTokenEnricher</a> for required language that provides this |
| metadata property before this enricher in your <a href="../NCPipeline.html">pipeline</a>.</p> |
| </div><dl class="attributes"><dt>Value parameters:</dt><dd><dl class="attributes"><dt>dictRes</dt><dd><p>Relative path, absolute path, classpath resource or URL to the dictionary. |
| The dictionary should have a simple plain text format with <em>one lemma per line</em>, empty lines are skipped, |
| duplicates ignored, lines starting with <strong>#</strong> symbol will be treated as comments and ignored. |
| Note that the search in the dictionary is implemented using words' <strong>lemma</strong> and case is ignored.</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/enrichers/NCDictionaryTokenEnricher.scala#L42">NCDictionaryTokenEnricher.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="enrichers/NCEnStopWordsTokenEnricher.html" class="documentableName ">NCEnStopWordsTokenEnricher</a><span>(<span t="k"></span><span t="k"></span>addSet: <a href="https://www.scala-lang.org/api/2.13.8/scala/collection/Set.html" t="t">Set</a>[<a href="https://www.scala-lang.org/api/2.13.8/scala/Predef$.html#String" t="t">String</a>], <span t="k"></span>exclSet: <a href="https://www.scala-lang.org/api/2.13.8/scala/collection/Set.html" t="t">Set</a>[<a href="https://www.scala-lang.org/api/2.13.8/scala/Predef$.html#String" t="t">String</a>], <span t="k"></span>stemmer: <a href="stemmer/NCStemmer.html" t="t">NCStemmer</a>)<span t="k"> extends </span><a href="../NCTokenEnricher.html" t="t">NCTokenEnricher</a><span t="k"> with </span><span data-unresolved-link="" t="t">LazyLogging</span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Stopword <a href="../NCTokenEnricher.html">token enricher</a> for English (EN) language. Stopwords are the words |
| which are filtered out (i.e. stopped) before processing of natural language text because they are |
| insignificant.</p> |
| </div><div class="cover"><div class="doc"><p>Stopword <a href="../NCTokenEnricher.html">token enricher</a> for English (EN) language. Stopwords are the words |
| which are filtered out (i.e. stopped) before processing of natural language text because they are |
| insignificant.</p> |
| <p>This enricher adds <code>stopword</code> boolean <a href="../NCPropertyMap.html">metadata</a> property to the <a href="../NCToken.html">token</a> |
| instance if the word it represents is an English stopword. The value <code>true</code> of this metadata property indicates that |
| this word is detected as a stopword, <code>false</code> value indicates otherwise. This implementation works off the |
| algorithm that uses an internal list of English stopwords as well as a procedural logic to determine the stopword |
| status of the token. This algorithm should work fine for most of the general uses cases. User can also add |
| additional stopwords or exceptions for the existing ones using corresponding parameters in <a href="enrichers/NCEnStopWordsTokenEnricher.html">NCEnStopWordsTokenEnricher</a> |
| constructor.</p> |
| <p>More information about stopwords can be found at <a href="https://en.wikipedia.org/wiki/Stop_word">https://en.wikipedia.org/wiki/Stop_word</a>.</p> |
| <p><strong>NOTE:</strong> this implementation requires <code>lemma</code> and <code>pos</code> string <a href="../NCPropertyMap.html">metadata</a> properties that |
| contain token's lemma and part of speech accordingly. You can configure <a href="enrichers/NCOpenNLPTokenEnricher.html">NCOpenNLPTokenEnricher</a> with the model |
| for English language that would provide these metadata properties before this enricher in your <a href="../NCPipeline.html">pipeline</a>.</p> |
| </div><dl class="attributes"><dt>Value parameters:</dt><dd><dl class="attributes"><dt>addSet</dt><dd><p>User defined collection of additional stopwords. These words will be stemmatized by the given <code>stemmer</code> |
| before attempting to find a match. Default value is an empty set.</p> |
| </dd><dt>exclSet</dt><dd><p>User defined collection of exceptions, i.e. the words which should not be marked as stopwords during |
| processing. These words will be stemmatized by the given <code>stemmer</code> before attempting to find a match. |
| Default value is an empty set.</p> |
| </dd><dt>stemmer</dt><dd><p>English stemmer implementation. Default value is the instance of <a href="stemmer/NCEnStemmer.html">NCEnStemmer</a>.</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/enrichers/NCEnStopWordsTokenEnricher.scala#L192">NCEnStopWordsTokenEnricher.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="enrichers/NCOpenNLPTokenEnricher.html" class="documentableName ">NCOpenNLPTokenEnricher</a><span>(<span t="k"></span><span t="k"></span>posMdlRes: <a href="https://www.scala-lang.org/api/2.13.8/scala/Predef$.html#String" t="t">String</a>, <span t="k"></span>lemmaDicRes: <a href="https://www.scala-lang.org/api/2.13.8/scala/Predef$.html#String" t="t">String</a>)<span t="k"> extends </span><a href="../NCTokenEnricher.html" t="t">NCTokenEnricher</a><span t="k"> with </span><span data-unresolved-link="" t="t">LazyLogging</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 href="https://opennlp.apache.org/">OpenNLP</a>-based language independent <a href="../NCTokenEnricher.html">token enricher</a>. This |
| enricher adds <code>lemma</code> and <code>pos</code> (part-of-speech) string <a href="../NCPropertyMap.html">metadata</a> property to the <a href="../NCToken.html">token</a> |
| instance. Learn more about lemmas <a href="https://en.wikipedia.org/wiki/Lemma_(morphology)">here</a> and about part-of-speech |
| <a href="https://www.ling.upenn.edu/courses/Fall_2003/ling001/penn_treebank_pos.html">here</a>.</p> |
| </div><div class="cover"><div class="doc"><p><a href="https://opennlp.apache.org/">OpenNLP</a>-based language independent <a href="../NCTokenEnricher.html">token enricher</a>. This |
| enricher adds <code>lemma</code> and <code>pos</code> (part-of-speech) string <a href="../NCPropertyMap.html">metadata</a> property to the <a href="../NCToken.html">token</a> |
| instance. Learn more about lemmas <a href="https://en.wikipedia.org/wiki/Lemma_(morphology)">here</a> and about part-of-speech |
| <a href="https://www.ling.upenn.edu/courses/Fall_2003/ling001/penn_treebank_pos.html">here</a>.</p> |
| <p>This OpenNLP enricher requires PoS and lemma models. Some of free OpenNLP community-maintained models can be found |
| <a href="https://opennlp.sourceforge.net/models-1.5/">here</a>. Note that at least one of model must be defined.</p> |
| </div><dl class="attributes"><dt>Value parameters:</dt><dd><dl class="attributes"><dt>lemmaDicRes</dt><dd><p>Relative path, absolute path, classpath resource or URL to |
| <a href="https://opennlp.apache.org/docs/2.0.0/apidocs/opennlp-tools/opennlp/tools/lemmatizer/DictionaryLemmatizer.html">DictionaryLemmatizer</a> model. |
| Can be <code>null</code> if <strong>lemmatizer</strong> model is not configured, so <code>lemma</code> property will not be set. |
| Note that at least one of the model must be provided.</p> |
| </dd><dt>posMdlRes</dt><dd><p>Relative path, absolute path, classpath resource or URL to |
| <a href="https://opennlp.apache.org/docs/2.0.0/apidocs/opennlp-tools/opennlp/tools/postag/POSTaggerME.html">POSTaggerME</a> model. |
| Can be <code>null</code> if <strong>part-of-speech</strong> model is not configured, so <code>pos</code> property will not be set. |
| Note that at least one of the model must be provided.</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/enrichers/NCOpenNLPTokenEnricher.scala#L47">NCOpenNLPTokenEnricher.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="enrichers/NCQuotesTokenEnricher.html" class="documentableName ">NCQuotesTokenEnricher</a><span><span t="k"> extends </span><a href="../NCTokenEnricher.html" t="t">NCTokenEnricher</a><span t="k"> with </span><span data-unresolved-link="" t="t">LazyLogging</span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Quotes <a href="../NCTokenEnricher.html">token enricher</a>.</p> |
| </div><div class="cover"><div class="doc"><p>Quotes <a href="../NCTokenEnricher.html">token enricher</a>.</p> |
| <p>This enricher adds <code>quoted</code> boolean <a href="../NCPropertyMap.html">metadata</a> property to the <a href="../NCToken.html">token</a> |
| instance if word it represents is in quotes. The value <code>true</code> of the metadata property indicates that this word is in quotes, |
| <code>false</code> value indicates otherwise.</p> |
| <p>Supported quotes are: <strong>«</strong>, <strong>»</strong>, <strong>"</strong>, <strong>'</strong>, <strong>`</strong>.</p> |
| <p><strong>NOTE:</strong> invalid enclosed quotes are ignored.</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/nlp/enrichers/NCQuotesTokenEnricher.scala#L51">NCQuotesTokenEnricher.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="enrichers/NCSwearWordsTokenEnricher.html" class="documentableName ">NCSwearWordsTokenEnricher</a><span>(<span t="k"></span><span t="k"></span>dictRes: <a href="https://www.scala-lang.org/api/2.13.8/scala/Predef$.html#String" t="t">String</a>, <span t="k"></span>stemmer: <a href="stemmer/NCStemmer.html" t="t">NCStemmer</a>)<span t="k"> extends </span><a href="../NCTokenEnricher.html" t="t">NCTokenEnricher</a><span t="k"> with </span><span data-unresolved-link="" t="t">LazyLogging</span></span></div></div><div class="docs"><span class="modifiers"></span><div><div class="originInfo"></div><div class="memberDocumentation"><div class="documentableBrief doc"><p>Swear-word <a href="../NCTokenEnricher.html">token enricher</a>.</p> |
| </div><div class="cover"><div class="doc"><p>Swear-word <a href="../NCTokenEnricher.html">token enricher</a>.</p> |
| <p>This enricher adds <code>swear</code> boolean <a href="../NCPropertyMap.html">metadata</a> property to the <a href="../NCToken.html">token</a> |
| instance if word it represents is in a swear word dictionary, i.e. the swear dictionary contains this word's |
| stem. The value <code>true</code> of the metadata property indicates that this word's stem is found in the dictionary, |
| <code>false</code> value indicates otherwise.</p> |
| </div><dl class="attributes"><dt>Value parameters:</dt><dd><dl class="attributes"><dt>dictRes</dt><dd><p>Relative path, absolute path, classpath resource or URL to the dictionary. |
| The dictionary should have a simple plain text format with <em>one lemma per line</em>, empty lines are skipped, |
| duplicates ignored, lines starting with <strong>#</strong> symbol will be treated as comments and ignored. |
| Note that the search in the dictionary is implemented using words' <strong>stem</strong> and case is ignored.</p> |
| </dd><dt>stemmer</dt><dd><p>Stemmer implementation for the language used in the supplied swear-word dictionary.</p> |
| </dd></dl></dd><dt>See also:</dt><dd><div><div><p><a href="stemmer/NCEnStemmer.html">org.apache.nlpcraft.nlp.stemmer.NCEnStemmer</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/nlp/enrichers/NCSwearWordsTokenEnricher.scala#L44">NCSwearWordsTokenEnricher.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> |
