| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Lucene.Net Docs - The documentation website for Lucene.Net | Apache Lucene.NET 4.8.0 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Lucene.Net Docs - The documentation website for Lucene.Net | Apache Lucene.NET 4.8.0 Documentation "> |
| <meta name="generator" content="docfx 2.47.0.0"> |
| |
| <link rel="shortcut icon" href="logo/favicon.ico"> |
| <link rel="stylesheet" href="styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="styles/docfx.css"> |
| <link rel="stylesheet" href="styles/main.css"> |
| <meta property="docfx:navrel" content="toc.html"> |
| <meta property="docfx:tocrel" content="toc.html"> |
| |
| <meta property="docfx:rel" content=""> |
| |
| </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="index.html"> |
| <img id="logo" class="svg" src="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" id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></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="article row grid"> |
| <div class="col-md-10"> |
| <article class="content wrap" id="_content" data-uid=""> |
| <h1 id="apache-lucenenet-480-documentation">Apache Lucene.Net 4.8.0 Documentation</h1> |
| |
| <hr> |
| <p>Lucene is a .NET full-text search engine. Lucene.NET is not a complete application, |
| but rather a code library and API that can easily be used to add search capabilities |
| to applications.</p> |
| <p>This is the official API documentation for <b>Apache Lucene.NET 4.8.0</b>.</p> |
| <h2 id="getting-started">Getting Started</h2> |
| <p>The following section is intended as a "getting started" guide. It has three |
| audiences: first-time users looking to install Apache Lucene in their |
| application; developers looking to modify or base the applications they develop |
| on Lucene; and developers looking to become involved in and contribute to the |
| development of Lucene. The goal is to help you "get started". It does not go into great depth |
| on some of the conceptual or inner details of Lucene:</p> |
| <ul> |
| <li><a class="xref" href="api/Lucene.Net.Demo/Lucene.Net.Demo.html">Lucene demo, its usage, and sources</a>: Tutorial and walk-through of the command-line Lucene demo.</li> |
| <li><a class="xref" href="api/Lucene.Net/overview.html">Introduction to Lucene's APIs</a>: High-level summary of the different Lucene packages.</li> |
| <li><a class="xref" href="api/Lucene.Net/Lucene.Net.Analysis.html">Analysis overview</a>: Introduction to Lucene's analysis API. See also the <a class="xref" href="api/Lucene.Net/Lucene.Net.Analysis.TokenStream.html">TokenStream consumer workflow</a>.</li> |
| </ul> |
| <h2 id="reference-documents">Reference Documents</h2> |
| <ul> |
| <li><a href="https://github.com/apache/lucenenet/releases/tag/Lucene.Net_4_8_0">Changes</a>: List of changes in this release.</li> |
| <li>System Requirements: Minimum and supported .NET versions. <strong>TODO: Add link</strong></li> |
| <li>Migration Guide: What changed in Lucene 4; how to migrate code from Lucene 3.x. <strong>TODO: Add link</strong></li> |
| <li><a class="xref" href="api/Lucene.Net/Lucene.Net.Codecs.Lucene46.html">File Formats</a> : Guide to the supported index format used by Lucene. This can be customized by using <a class="xref" href="api/Lucene.Net/Lucene.Net.Codecs.html">an alternate codec</a>.</li> |
| <li><a class="xref" href="api/Lucene.Net/Lucene.Net.Search.html">Search and Scoring in Lucene</a>: Introduction to how Lucene scores documents.</li> |
| <li><a class="xref" href="api/Lucene.Net/Lucene.Net.Search.Similarities.TFIDFSimilarity.html">Classic Scoring Formula</a>: Formula of Lucene's classic <a href="http://en.wikipedia.org/wiki/Vector_Space_Model">Vector Space</a> implementation. (look <a class="xref" href="api/Lucene.Net/Lucene.Net.Search.Similarities.html">here</a> for other models)</li> |
| <li><a class="xref" href="api/Lucene.Net.QueryParser/Lucene.Net.QueryParsers.Classic.html">Classic QueryParser Syntax</a>: Overview of the Classic QueryParser's syntax and features.</li> |
| </ul> |
| <h2 id="libraries">Libraries</h2> |
| <ul> |
| <li><a class="xref" href="api/Lucene.Net/overview.html">Lucene.Net</a>: Lucene core library</li> |
| <li><a class="xref" href="api/Lucene.Net/Lucene.Net.Analysis.html">Lucene.Net.Analysis.Common</a>: Analyzers for indexing content in different languages and domains.</li> |
| <li><a class="xref" href="api/Lucene.Net.ICU/Lucene.Net.Analysis.Icu.html">Lucene.Net.ICU</a>: Analysis integration with ICU (International Components for Unicode).</li> |
| <li><a class="xref" href="api/Lucene.Net.Analysis.Kuromoji/Lucene.Net.Analysis.Ja.html">Lucene.Net.Analysis.Kuromoji</a>: Japanese Morphological Analyzer</li> |
| <li><a class="xref" href="api/Lucene.Net.Analysis/Lucene.Net.Analysis.Phonetic.html">Lucene.Net.Analysis.Phonetic</a>: Analyzer for indexing phonetic signatures (for sounds-alike search)</li> |
| <li><a class="xref" href="api/Lucene.Net.Analysis.SmartCn/Lucene.Net.Analysis.Cn.Smart.html">Lucene.Net.Analysis.SmartCn</a>: Analyzer for indexing Chinese</li> |
| <li><a class="xref" href="api/Lucene.Net.Analysis/Lucene.Net.Analysis.Stempel.html">Lucene.Net.Analysis.Stempel</a>: Analyzer for indexing Polish</li> |
| </ul> |
| <!-- * [Lucene.Net.Analysis.UIMA](xref:Lucene.Net.Analysis.UIMA): Analysis integration with Apache UIMA --> |
| <!-- Change to Lucene.Net.Analysis.OpenNLP .... see https://github.com/apache/lucenenet/pull/230> --> |
| <ul> |
| <li><a class="xref" href="cli/benchmark/index.html">Lucene.Net.Benchmark</a>: System for benchmarking Lucene</li> |
| <li><a class="xref" href="api/Lucene.Net.Classification/Lucene.Net.Classification.html">Lucene.Net.Classification</a>: Classification module for Lucene</li> |
| <li><a class="xref" href="api/Lucene.Net/Lucene.Net.Codecs.html">Lucene.Net.Codecs</a>: Lucene codecs and postings formats.</li> |
| <li><a class="xref" href="api/Lucene.Net.Expressions/Lucene.Net.Expressions.html">Lucene.Net.Expressions</a>: Dynamically computed values to sort/facet/search on based on a pluggable grammar.</li> |
| <li><a class="xref" href="api/Lucene.Net.Facet/Lucene.Net.Facet.html">Lucene.Net.Facet</a>: Faceted indexing and search capabilities</li> |
| <li><a class="xref" href="api/Lucene.Net.Grouping/Lucene.Net.Search.Grouping.html">Lucene.Net.Grouping</a>: Collectors for grouping search results.</li> |
| <li><a class="xref" href="api/Lucene.Net.Highlighter/Lucene.Net.Search.Highlight.html">Lucene.Net.Highlighter</a>: Highlights search keywords in results</li> |
| <li><a class="xref" href="api/Lucene.Net.Join/Lucene.Net.Join.html">Lucene.Net.Join</a>: Index-time and Query-time joins for normalized content</li> |
| <li><a class="xref" href="api/Lucene.Net.Memory/Lucene.Net.Index.Memory.html">Lucene.Net.Memory</a>: Single-document in-memory index implementation</li> |
| <li><a class="xref" href="api/Lucene.Net/Lucene.Net.Misc.html">Lucene.Net.Misc</a>: Index tools and other miscellaneous code</li> |
| <li><a class="xref" href="api/Lucene.Net.Queries/Lucene.Net.Queries.html">Lucene.Net.Queries</a>: Filters and Queries that add to core Lucene</li> |
| <li><a class="xref" href="api/Lucene.Net.QueryParser/Lucene.Net.QueryParsers.Classic.html">Lucene.Net.QueryParser</a>: Query parsers and parsing framework</li> |
| <li><a class="xref" href="api/Lucene.Net.Replicator/Lucene.Net.Replicator.html">Lucene.Net.Replicator</a>: Files replication utility</li> |
| <li><a href="xref:Lucene.Net.Sandbox">Lucene.Net.Sandbox</a>: Various third party contributions and new ideas</li> |
| <li><a class="xref" href="api/Lucene.Net.Spatial/Lucene.Net.Spatial.html">Lucene.Net.Spatial</a>: Geospatial search</li> |
| <li><a class="xref" href="api/Lucene.Net.Suggest/Lucene.Net.Search.Suggest.html">Lucene.Net.Suggest</a>: Auto-suggest and Spellchecking support</li> |
| <li><strong>To be completed</strong>: analyzers-morfologik: Analyzer for indexing Polish</li> |
| <li><strong>To be completed</strong>: test-framework: Framework for testing Lucene-based applications</li> |
| </ul> |
| <h3 id="tools">Tools</h3> |
| <ul> |
| <li><a href="cli/index.html">Lucene CLI</a>: Dotnet tool to work with Lucene indexes from the command line</li> |
| <li><a class="xref" href="api/Lucene.Net.Demo/Lucene.Net.Demo.html">Demo</a>: Simple example code</li> |
| </ul> |
| </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/blob/master/websites/apidocs/index.md/#L1" class="contribution-link">Improve this Doc</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 © 2019 Licensed to the Apache Software Foundation (ASF) |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="styles/docfx.js"></script> |
| <script type="text/javascript" src="styles/main.js"></script> |
| </body> |
| </html> |
