| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class FreeTextSuggester |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class FreeTextSuggester |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation "> |
| <meta name="generator" content="docfx 2.56.0.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="suggest/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"> |
| <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.Search.Suggest.Analyzing.FreeTextSuggester"> |
| |
| |
| <h1 id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester" class="text-break">Class FreeTextSuggester |
| </h1> |
| <div class="markdown level0 summary"><p>Builds an ngram model from the text sent to <a class="xref" href="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.html#Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_Build_Lucene_Net_Search_Suggest_IInputIterator_System_Double_">Build(IInputIterator, Double)</a> |
| and predicts based on the last grams-1 tokens in |
| the request sent to <a class="xref" href="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.html#Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_DoLookup_System_String_System_Collections_Generic_IEnumerable_Lucene_Net_Util_BytesRef__System_Boolean_System_Int32_">DoLookup(String, IEnumerable<BytesRef>, Boolean, Int32)</a>. This tries to |
| handle the "long tail" of suggestions for when the |
| incoming query is a never before seen query string.</p> |
| <p>Likely this suggester would only be used as a |
| fallback, when the primary suggester fails to find |
| any suggestions. |
| |
| </p> |
| <p>Note that the weight for each suggestion is unused, |
| and the suggestions are the analyzed forms (so your |
| analysis process should normally be very "light"). |
| |
| </p> |
| <p>This uses the stupid backoff language model to smooth |
| scores across ngram models; see |
| <a href="http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.76.1126"> |
| "Large language models in machine translation"</a> for details. |
| |
| </p> |
| <p> From <a class="xref" href="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.html#Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_DoLookup_System_String_System_Collections_Generic_IEnumerable_Lucene_Net_Util_BytesRef__System_Boolean_System_Int32_">DoLookup(String, IEnumerable<BytesRef>, Boolean, Int32)</a>, the key of each result is the |
| ngram token; the value is <span class="xref">System.Int64.MaxValue</span> * score (fixed |
| point, cast to long). Divide by <span class="xref">System.Int64.MaxValue</span> to get |
| the score back, which ranges from 0.0 to 1.0. |
| |
| <code>onlyMorePopular</code> is unused. |
| |
| @lucene.experimental |
| </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"><a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html">Lookup</a></div> |
| <div class="level2"><span class="xref">FreeTextSuggester</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html#Lucene_Net_Search_Suggest_Lookup_CHARSEQUENCE_COMPARER">Lookup.CHARSEQUENCE_COMPARER</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html#Lucene_Net_Search_Suggest_Lookup_Build_Lucene_Net_Search_Spell_IDictionary_">Lookup.Build(IDictionary)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html#Lucene_Net_Search_Suggest_Lookup_Load_System_IO_Stream_">Lookup.Load(Stream)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html#Lucene_Net_Search_Suggest_Lookup_Store_System_IO_Stream_">Lookup.Store(Stream)</a> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetHashCode()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetType()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.MemberwiseClone()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ToString()</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Search.Suggest.Analyzing.html">Lucene.Net.Search.Suggest.Analyzing</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Suggest.dll</h6> |
| <h5 id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class FreeTextSuggester : Lookup</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester__ctor_Lucene_Net_Analysis_Analyzer_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.%23ctor(Lucene.Net.Analysis.Analyzer)%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Analyzing/FreeTextSuggester.cs/#L144">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester__ctor_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester__ctor_Lucene_Net_Analysis_Analyzer_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.#ctor(Lucene.Net.Analysis.Analyzer)">FreeTextSuggester(Analyzer)</h4> |
| <div class="markdown level1 summary"><p>Instantiate, using the provided analyzer for both |
| indexing and lookup, using bigram model by default. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public FreeTextSuggester(Analyzer analyzer)</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">Lucene.Net.Analysis.Analyzer</span></td> |
| <td><span class="parametername">analyzer</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester__ctor_Lucene_Net_Analysis_Analyzer_Lucene_Net_Analysis_Analyzer_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.%23ctor(Lucene.Net.Analysis.Analyzer%2CLucene.Net.Analysis.Analyzer)%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Analyzing/FreeTextSuggester.cs/#L153">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester__ctor_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester__ctor_Lucene_Net_Analysis_Analyzer_Lucene_Net_Analysis_Analyzer_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.#ctor(Lucene.Net.Analysis.Analyzer,Lucene.Net.Analysis.Analyzer)">FreeTextSuggester(Analyzer, Analyzer)</h4> |
| <div class="markdown level1 summary"><p>Instantiate, using the provided indexing and lookup |
| analyzers, using bigram model by default. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public FreeTextSuggester(Analyzer indexAnalyzer, Analyzer queryAnalyzer)</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">Lucene.Net.Analysis.Analyzer</span></td> |
| <td><span class="parametername">indexAnalyzer</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Analysis.Analyzer</span></td> |
| <td><span class="parametername">queryAnalyzer</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester__ctor_Lucene_Net_Analysis_Analyzer_Lucene_Net_Analysis_Analyzer_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.%23ctor(Lucene.Net.Analysis.Analyzer%2CLucene.Net.Analysis.Analyzer%2CSystem.Int32)%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Analyzing/FreeTextSuggester.cs/#L163">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester__ctor_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester__ctor_Lucene_Net_Analysis_Analyzer_Lucene_Net_Analysis_Analyzer_System_Int32_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.#ctor(Lucene.Net.Analysis.Analyzer,Lucene.Net.Analysis.Analyzer,System.Int32)">FreeTextSuggester(Analyzer, Analyzer, Int32)</h4> |
| <div class="markdown level1 summary"><p>Instantiate, using the provided indexing and lookup |
| analyzers, with the specified model (2 |
| = bigram, 3 = trigram, etc.). </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public FreeTextSuggester(Analyzer indexAnalyzer, Analyzer queryAnalyzer, int grams)</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">Lucene.Net.Analysis.Analyzer</span></td> |
| <td><span class="parametername">indexAnalyzer</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Analysis.Analyzer</span></td> |
| <td><span class="parametername">queryAnalyzer</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">grams</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester__ctor_Lucene_Net_Analysis_Analyzer_Lucene_Net_Analysis_Analyzer_System_Int32_System_Byte_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.%23ctor(Lucene.Net.Analysis.Analyzer%2CLucene.Net.Analysis.Analyzer%2CSystem.Int32%2CSystem.Byte)%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Analyzing/FreeTextSuggester.cs/#L178">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester__ctor_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester__ctor_Lucene_Net_Analysis_Analyzer_Lucene_Net_Analysis_Analyzer_System_Int32_System_Byte_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.#ctor(Lucene.Net.Analysis.Analyzer,Lucene.Net.Analysis.Analyzer,System.Int32,System.Byte)">FreeTextSuggester(Analyzer, Analyzer, Int32, Byte)</h4> |
| <div class="markdown level1 summary"><p>Instantiate, using the provided indexing and lookup |
| analyzers, and specified model (2 = bigram, 3 = |
| trigram ,etc.). The <code data-dev-comment-type="paramref" class="paramref">separator</code> is passed to <span class="xref">Lucene.Net.Analysis.Shingle.ShingleFilter.SetTokenSeparator(System.String)</span> |
| to join multiple |
| tokens into a single ngram token; it must be an ascii |
| (7-bit-clean) byte. No input tokens should have this |
| byte, otherwise <span class="xref">System.ArgumentException</span> is |
| thrown. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public FreeTextSuggester(Analyzer indexAnalyzer, Analyzer queryAnalyzer, int grams, byte separator)</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">Lucene.Net.Analysis.Analyzer</span></td> |
| <td><span class="parametername">indexAnalyzer</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Analysis.Analyzer</span></td> |
| <td><span class="parametername">queryAnalyzer</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">grams</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Byte</span></td> |
| <td><span class="parametername">separator</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="fields">Fields |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_ALPHA.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.ALPHA%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Analyzing/FreeTextSuggester.cs/#L104">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_ALPHA" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.ALPHA">ALPHA</h4> |
| <div class="markdown level1 summary"><p>The constant used for backoff smoothing; during |
| lookup, this means that if a given trigram did not |
| occur, and we backoff to the bigram, the overall score |
| will be 0.4 times what the bigram model would have |
| assigned. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public const double ALPHA = 0.4</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</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">System.Double</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_CODEC_NAME.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.CODEC_NAME%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Analyzing/FreeTextSuggester.cs/#L81">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_CODEC_NAME" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.CODEC_NAME">CODEC_NAME</h4> |
| <div class="markdown level1 summary"><p>Codec name used in the header for the saved model. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public const string CODEC_NAME = "freetextsuggest"</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</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">System.String</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_DEFAULT_GRAMS.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.DEFAULT_GRAMS%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Analyzing/FreeTextSuggester.cs/#L93">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_DEFAULT_GRAMS" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.DEFAULT_GRAMS">DEFAULT_GRAMS</h4> |
| <div class="markdown level1 summary"><p>By default we use a bigram model. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public const int DEFAULT_GRAMS = 2</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</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">System.Int32</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_DEFAULT_SEPARATOR.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.DEFAULT_SEPARATOR%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Analyzing/FreeTextSuggester.cs/#L138">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_DEFAULT_SEPARATOR" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.DEFAULT_SEPARATOR">DEFAULT_SEPARATOR</h4> |
| <div class="markdown level1 summary"><p>The default character used to join multiple tokens |
| into a single ngram token. The input tokens produced |
| by the analyzer must not contain this character. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public const byte DEFAULT_SEPARATOR = 30</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</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">System.Byte</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_VERSION_CURRENT.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.VERSION_CURRENT%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Analyzing/FreeTextSuggester.cs/#L89">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_VERSION_CURRENT" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.VERSION_CURRENT">VERSION_CURRENT</h4> |
| <div class="markdown level1 summary"><p>Current version of the the saved model file format. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public const int VERSION_CURRENT = 0</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</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">System.Int32</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_VERSION_START.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.VERSION_START%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Analyzing/FreeTextSuggester.cs/#L85">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_VERSION_START" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.VERSION_START">VERSION_START</h4> |
| <div class="markdown level1 summary"><p>Initial version of the the saved model file format. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public const int VERSION_START = 0</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</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">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="properties">Properties |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_Count.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.Count%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Analyzing/FreeTextSuggester.cs/#L507">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_Count_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.Count*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_Count" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.Count">Count</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 override long Count { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</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">System.Int64</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html#Lucene_Net_Search_Suggest_Lookup_Count">Lookup.Count</a></div> |
| <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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_Build_Lucene_Net_Search_Suggest_IInputIterator_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.Build(Lucene.Net.Search.Suggest.IInputIterator)%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Analyzing/FreeTextSuggester.cs/#L290">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_Build_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.Build*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_Build_Lucene_Net_Search_Suggest_IInputIterator_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.Build(Lucene.Net.Search.Suggest.IInputIterator)">Build(IInputIterator)</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 override void Build(IInputIterator iterator)</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><a class="xref" href="Lucene.Net.Search.Suggest.IInputIterator.html">IInputIterator</a></td> |
| <td><span class="parametername">iterator</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html#Lucene_Net_Search_Suggest_Lookup_Build_Lucene_Net_Search_Suggest_IInputIterator_">Lookup.Build(IInputIterator)</a></div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_Build_Lucene_Net_Search_Suggest_IInputIterator_System_Double_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.Build(Lucene.Net.Search.Suggest.IInputIterator%2CSystem.Double)%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Analyzing/FreeTextSuggester.cs/#L300">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_Build_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.Build*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_Build_Lucene_Net_Search_Suggest_IInputIterator_System_Double_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.Build(Lucene.Net.Search.Suggest.IInputIterator,System.Double)">Build(IInputIterator, Double)</h4> |
| <div class="markdown level1 summary"><p>Build the suggest index, using up to the specified |
| amount of temporary RAM while building. Note that |
| the weights for the suggestions are ignored. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void Build(IInputIterator iterator, double ramBufferSizeMB)</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><a class="xref" href="Lucene.Net.Search.Suggest.IInputIterator.html">IInputIterator</a></td> |
| <td><span class="parametername">iterator</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Double</span></td> |
| <td><span class="parametername">ramBufferSizeMB</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_DoLookup_System_String_System_Boolean_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.DoLookup(System.String%2CSystem.Boolean%2CSystem.Int32)%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Analyzing/FreeTextSuggester.cs/#L482">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_DoLookup_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.DoLookup*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_DoLookup_System_String_System_Boolean_System_Int32_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.DoLookup(System.String,System.Boolean,System.Int32)">DoLookup(String, Boolean, Int32)</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 override IList<Lookup.LookupResult> DoLookup(string key, bool onlyMorePopular, int num)</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">key</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">onlyMorePopular</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">num</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">System.Collections.Generic.IList</span><<a class="xref" href="Lucene.Net.Search.Suggest.Lookup.LookupResult.html">Lookup.LookupResult</a>></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html#Lucene_Net_Search_Suggest_Lookup_DoLookup_System_String_System_Boolean_System_Int32_">Lookup.DoLookup(String, Boolean, Int32)</a></div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_DoLookup_System_String_System_Collections_Generic_IEnumerable_Lucene_Net_Util_BytesRef__System_Boolean_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.DoLookup(System.String%2CSystem.Collections.Generic.IEnumerable%7BLucene.Net.Util.BytesRef%7D%2CSystem.Boolean%2CSystem.Int32)%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Analyzing/FreeTextSuggester.cs/#L494">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_DoLookup_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.DoLookup*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_DoLookup_System_String_System_Collections_Generic_IEnumerable_Lucene_Net_Util_BytesRef__System_Boolean_System_Int32_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.DoLookup(System.String,System.Collections.Generic.IEnumerable{Lucene.Net.Util.BytesRef},System.Boolean,System.Int32)">DoLookup(String, IEnumerable<BytesRef>, Boolean, Int32)</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 override IList<Lookup.LookupResult> DoLookup(string key, IEnumerable<BytesRef> contexts, bool onlyMorePopular, int num)</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">key</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.IEnumerable</span><<span class="xref">Lucene.Net.Util.BytesRef</span>></td> |
| <td><span class="parametername">contexts</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">onlyMorePopular</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">num</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">System.Collections.Generic.IList</span><<a class="xref" href="Lucene.Net.Search.Suggest.Lookup.LookupResult.html">Lookup.LookupResult</a>></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html#Lucene_Net_Search_Suggest_Lookup_DoLookup_System_String_System_Collections_Generic_IEnumerable_Lucene_Net_Util_BytesRef__System_Boolean_System_Int32_">Lookup.DoLookup(String, IEnumerable<BytesRef>, Boolean, Int32)</a></div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_DoLookup_System_String_System_Collections_Generic_IEnumerable_Lucene_Net_Util_BytesRef__System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.DoLookup(System.String%2CSystem.Collections.Generic.IEnumerable%7BLucene.Net.Util.BytesRef%7D%2CSystem.Int32)%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Analyzing/FreeTextSuggester.cs/#L526">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_DoLookup_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.DoLookup*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_DoLookup_System_String_System_Collections_Generic_IEnumerable_Lucene_Net_Util_BytesRef__System_Int32_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.DoLookup(System.String,System.Collections.Generic.IEnumerable{Lucene.Net.Util.BytesRef},System.Int32)">DoLookup(String, IEnumerable<BytesRef>, Int32)</h4> |
| <div class="markdown level1 summary"><p>Retrieve suggestions.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual IList<Lookup.LookupResult> DoLookup(string key, IEnumerable<BytesRef> contexts, int num)</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">key</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.IEnumerable</span><<span class="xref">Lucene.Net.Util.BytesRef</span>></td> |
| <td><span class="parametername">contexts</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">num</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">System.Collections.Generic.IList</span><<a class="xref" href="Lucene.Net.Search.Suggest.Lookup.LookupResult.html">Lookup.LookupResult</a>></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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_DoLookup_System_String_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.DoLookup(System.String%2CSystem.Int32)%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Analyzing/FreeTextSuggester.cs/#L489">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_DoLookup_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.DoLookup*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_DoLookup_System_String_System_Int32_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.DoLookup(System.String,System.Int32)">DoLookup(String, Int32)</h4> |
| <div class="markdown level1 summary"><p>Lookup, without any context. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual IList<Lookup.LookupResult> DoLookup(string key, int num)</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">key</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">num</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">System.Collections.Generic.IList</span><<a class="xref" href="Lucene.Net.Search.Suggest.Lookup.LookupResult.html">Lookup.LookupResult</a>></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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_Get_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.Get(System.String)%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Analyzing/FreeTextSuggester.cs/#L913">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_Get_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.Get*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_Get_System_String_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.Get(System.String)">Get(String)</h4> |
| <div class="markdown level1 summary"><p>Returns the weight associated with an input string, |
| or null if it does not exist.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual object Get(string key)</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">key</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">System.Object</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_GetSizeInBytes.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.GetSizeInBytes%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Analyzing/FreeTextSuggester.cs/#L196">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_GetSizeInBytes_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.GetSizeInBytes*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_GetSizeInBytes" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.GetSizeInBytes">GetSizeInBytes()</h4> |
| <div class="markdown level1 summary"><p>Returns byte size of the underlying FST. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override long GetSizeInBytes()</code></pre> |
| </div> |
| <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">System.Int64</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html#Lucene_Net_Search_Suggest_Lookup_GetSizeInBytes">Lookup.GetSizeInBytes()</a></div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_Load_Lucene_Net_Store_DataInput_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.Load(Lucene.Net.Store.DataInput)%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Analyzing/FreeTextSuggester.cs/#L461">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_Load_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.Load*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_Load_Lucene_Net_Store_DataInput_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.Load(Lucene.Net.Store.DataInput)">Load(DataInput)</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 override bool Load(DataInput input)</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">Lucene.Net.Store.DataInput</span></td> |
| <td><span class="parametername">input</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">System.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html#Lucene_Net_Search_Suggest_Lookup_Load_Lucene_Net_Store_DataInput_">Lookup.Load(DataInput)</a></div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_Store_Lucene_Net_Store_DataOutput_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.Store(Lucene.Net.Store.DataOutput)%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Analyzing/FreeTextSuggester.cs/#L450">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_Store_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.Store*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester_Store_Lucene_Net_Store_DataOutput_" data-uid="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.Store(Lucene.Net.Store.DataOutput)">Store(DataOutput)</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 override bool Store(DataOutput output)</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">Lucene.Net.Store.DataOutput</span></td> |
| <td><span class="parametername">output</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">System.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html#Lucene_Net_Search_Suggest_Lookup_Store_Lucene_Net_Store_DataOutput_">Lookup.Store(DataOutput)</a></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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Analyzing_FreeTextSuggester.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Suggest/Suggest/Analyzing/FreeTextSuggester.cs/#L76" 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 Licensed to the Apache Software Foundation (ASF) |
| |
| </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> |
