full-text-search: In-memory full text search engine

[ bsd3, data, library, search, text ] [ Propose Tags ] [ Report a vulnerability ]

An in-memory full text search engine library. It lets you run full-text queries on a collection of your documents.

Features:

  • Keyword queries and auto-complete/auto-suggest queries.

  • Can search over any type of "document". (You explain how to extract search terms from them.)

  • Supports documents with multiple fields (e.g. title, body)

  • Supports documents with non-term features (e.g. quality score, page rank)

  • Uses the state of the art BM25F ranking function

  • Adjustable ranking parameters (including field weights and non-term feature scores)

  • In-memory but quite compact. It does not keep a copy of your original documents.

  • Quick incremental index updates, making it possible to keep your text search in-sync with your data.

It is independent of the document type, so you have to write the document-specific parts: extracting search terms and any stop words, case-normalisation or stemming. This is quite easy using libraries such as tokenize and snowball.

The source package includes a demo to illustrate how to use the library. The demo is a simplified version of how the library is used in the hackage-server where it provides the backend for the package search feature.

Flags

Manual Flags

NameDescriptionDefault
build-search-demo

Build a little program illustrating the use of the library

Disabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

Versions [RSS] 0.2.0.0, 0.2.1.0, 0.2.1.1, 0.2.1.3, 0.2.1.4, 0.2.2.0, 0.2.2.1, 0.2.2.2 (info)
Change log changelog
Dependencies array (>=0.4 && <0.6), base (>=4.5 && <4.19), containers (>=0.4 && <0.7), text (>=0.11 && <2.1), vector (>=0.11 && <0.14) [details]
Tested with ghc ==8.10.7 || ==9.0.2 || ==9.2.7 || ==9.4.4 || ==9.6.1
License BSD-3-Clause
Copyright 2013-2014 Duncan Coutts, 2014 Well-Typed LLP, 2014-2023 IRIS Connect Ltd.
Author Duncan Coutts
Maintainer Duncan Coutts <duncan@well-typed.com>, Adam Gundry <adam@well-typed.com>
Category Data, Text, Search
Bug tracker https://github.com/well-typed/full-text-search/issues
Source repo head: git clone git@github.com:well-typed/full-text-search.git
Uploaded by AdamGundry at 2023-03-21T12:39:13Z
Distributions NixOS:0.2.2.2
Reverse Dependencies 1 direct, 0 indirect [details]
Executables search-demo
Downloads 5313 total (6 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2023-03-21 [all 1 reports]