blob: 7bfa54a7a29ca4c62e9d1a42eb61f12756897c57 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class NLPNERTaggerOp
| Apache Lucene.NET 4.8.0-beta00013 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class NLPNERTaggerOp
| Apache Lucene.NET 4.8.0-beta00013 Documentation ">
<meta name="generator" content="docfx 2.56.2.0">
<link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css">
<meta property="docfx:navrel" content="toc.html">
<meta property="docfx:tocrel" content="analysis-opennlp/toc.html">
<meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<span id="forkongithub"><a href="https://github.com/apache/lucenenet" target="_blank">Fork me on GitHub</a></span>
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/">
<img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search">
<ul class="level0 breadcrumb">
<li>
<a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a>
<span id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</span>
</li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list"></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Lucene.Net.Analysis.OpenNlp.Tools.NLPNERTaggerOp">
<h1 id="Lucene_Net_Analysis_OpenNlp_Tools_NLPNERTaggerOp" data-uid="Lucene.Net.Analysis.OpenNlp.Tools.NLPNERTaggerOp" class="text-break">Class NLPNERTaggerOp
</h1>
<div class="markdown level0 summary"><p>Supply OpenNLP Named Entity Resolution tool
Requires binary models from OpenNLP project on SourceForge.
<p>
Usage: from <a href="http://opennlp.apache.org/docs/1.8.3/manual/opennlp.html#tools.namefind.recognition.api">
the OpenNLP documentation</a>:
<p>
&quot;The NameFinderME class is not thread safe, it must only be called from one thread.
To use multiple threads multiple NameFinderME instances sharing the same model instance
can be created. The input text should be segmented into documents, sentences and tokens.
To perform entity detection an application calls the find method for every sentence in
the document. After every document clearAdaptiveData must be called to clear the adaptive
data in the feature generators. Not calling clearAdaptiveData can lead to a sharp drop
in the detection rate after a few documents.&quot;</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">NLPNERTaggerOp</span></div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Analysis.OpenNlp.Tools.html">Lucene.Net.Analysis.OpenNlp.Tools</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.Analysis.OpenNLP.dll</h6>
<h5 id="Lucene_Net_Analysis_OpenNlp_Tools_NLPNERTaggerOp_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class NLPNERTaggerOp : object</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_OpenNlp_Tools_NLPNERTaggerOp__ctor_TokenNameFinderModel_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.OpenNlp.Tools.NLPNERTaggerOp.%23ctor(TokenNameFinderModel)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Analysis.OpenNLP/Tools/NLPNERTaggerOp.cs/#L43">View Source</a>
</span>
<a id="Lucene_Net_Analysis_OpenNlp_Tools_NLPNERTaggerOp__ctor_" data-uid="Lucene.Net.Analysis.OpenNlp.Tools.NLPNERTaggerOp.#ctor*"></a>
<h4 id="Lucene_Net_Analysis_OpenNlp_Tools_NLPNERTaggerOp__ctor_TokenNameFinderModel_" data-uid="Lucene.Net.Analysis.OpenNlp.Tools.NLPNERTaggerOp.#ctor(TokenNameFinderModel)">NLPNERTaggerOp(TokenNameFinderModel)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public NLPNERTaggerOp(TokenNameFinderModel model)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">TokenNameFinderModel</span></td>
<td><span class="parametername">model</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_OpenNlp_Tools_NLPNERTaggerOp_GetNames_System_String___.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.OpenNlp.Tools.NLPNERTaggerOp.GetNames(System.String%5B%5D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Analysis.OpenNLP/Tools/NLPNERTaggerOp.cs/#L48">View Source</a>
</span>
<a id="Lucene_Net_Analysis_OpenNlp_Tools_NLPNERTaggerOp_GetNames_" data-uid="Lucene.Net.Analysis.OpenNlp.Tools.NLPNERTaggerOp.GetNames*"></a>
<h4 id="Lucene_Net_Analysis_OpenNlp_Tools_NLPNERTaggerOp_GetNames_System_String___" data-uid="Lucene.Net.Analysis.OpenNlp.Tools.NLPNERTaggerOp.GetNames(System.String[])">GetNames(String[])</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual Span[] GetNames(string[] words)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span>[]</td>
<td><span class="parametername">words</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">Span</span>[]</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_OpenNlp_Tools_NLPNERTaggerOp_Reset.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.OpenNlp.Tools.NLPNERTaggerOp.Reset%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Analysis.OpenNLP/Tools/NLPNERTaggerOp.cs/#L54">View Source</a>
</span>
<a id="Lucene_Net_Analysis_OpenNlp_Tools_NLPNERTaggerOp_Reset_" data-uid="Lucene.Net.Analysis.OpenNlp.Tools.NLPNERTaggerOp.Reset*"></a>
<h4 id="Lucene_Net_Analysis_OpenNlp_Tools_NLPNERTaggerOp_Reset" data-uid="Lucene.Net.Analysis.OpenNlp.Tools.NLPNERTaggerOp.Reset">Reset()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void Reset()</code></pre>
</div>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_OpenNlp_Tools_NLPNERTaggerOp.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.OpenNlp.Tools.NLPNERTaggerOp%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/apache/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Analysis.OpenNLP/Tools/NLPNERTaggerOp.cs/#L39" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
Copyright © 2020 The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script>
</body>
</html>