MaigoLabs.NeedLe
1.1.0
dotnet add package MaigoLabs.NeedLe --version 1.1.0
NuGet\Install-Package MaigoLabs.NeedLe -Version 1.1.0
<PackageReference Include="MaigoLabs.NeedLe" Version="1.1.0" />
<PackageVersion Include="MaigoLabs.NeedLe" Version="1.1.0" />
<PackageReference Include="MaigoLabs.NeedLe" />
paket add MaigoLabs.NeedLe --version 1.1.0
#r "nuget: MaigoLabs.NeedLe, 1.1.0"
#:package MaigoLabs.NeedLe@1.1.0
#addin nuget:?package=MaigoLabs.NeedLe&version=1.1.0
#tool nuget:?package=MaigoLabs.NeedLe&version=1.1.0
MaigoLabs.NeedLe
Fuzzy search engine for small text pieces, with Chinese/Japanese pronunciation support.
See also in-browser demo (TypeScript version, but the same features as in C#).
Install
dotnet add package MaigoLabs.NeedLe
Or install sub-packages separately:
dotnet add package MaigoLabs.NeedLe.Indexer # For building indexes
dotnet add package MaigoLabs.NeedLe.Searcher # For searching only
Usage
Indexing
Indexing requires dictionaries. These are installed as dependencies of the MaigoLabs.NeedLe.Indexer package:
- MeCab.DotNet
- OpenccNetLib
- hyjiacan.pinyin4net
using MaigoLabs.NeedLe.Indexer;
var documents = new[] { "你好世界", "こんにちは" };
var compressedIndex = InvertedIndexBuilder.BuildInvertedIndex(documents);
// To customize dictionary paths, pass the second argument `TokenizerOptions` to `BuildInvertedIndex`.
// The built index could be stored for later use, or sent to frontend to load with TypeScript package `@maigolabs/needle`.
// For compatibility with .NET Standard, we don't provide JSON related methods. You can use any JSON library to serialize/deserialize the index in the way you prefer.
var json = JsonSerializer.Serialize(compressedIndex);
Searching
Searching requires a prebuilt index but doesn't require dictionaries. Searcher is a lightweight package without dependencies.
using MaigoLabs.NeedLe.Searcher;
// Index returned by `BuildInvertedIndex`.
var index = InvertedIndexLoader.Load(compressedIndex);
var results = InvertedIndexSearcher.Search(index, "sekai");
foreach (var result in results) Console.WriteLine($"{result.DocumentText} ({result.MatchRatio:P0})")
// → 你好世界 (50%)
To highlight the search result, see also SearchResultHighlighter.
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- MaigoLabs.NeedLe.Common (>= 1.1.0)
- MaigoLabs.NeedLe.Indexer (>= 1.1.0)
- MaigoLabs.NeedLe.Searcher (>= 1.1.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.