Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 1.73 KB

README.md

File metadata and controls

56 lines (39 loc) · 1.73 KB
Raw

nxsearch

TESTS

Work in progress. Upstream at: https://github.com/rmind/nxsearch

nxsearch is a full-text search engine library which is also provided with a web server integration.

The engine is written in C11 and is distributed under the 2-clause BSD license.

Features

  • Lightweight, simple and fast.
  • BM25 and TF-IDF algorithms.
  • Integrates with the Snowball stemmer.
  • Supports fuzzy matching (using the BK-tree with Levenshtein distance).
  • Supports query logic operators, grouping, nesting, etc.
  • Supports filters in Lua for easy extendibility.
  • Basic UTF-8 and internationalization support.

Usage

To try as a web service:

# git submodule update --init --recursive  # ensure you have submodules
docker-compose up app  # spin up the service
open http://127.0.0.1:8000/docs  # documentation page

The NXS_BASEDIR environment variable specifies the base directory where the indexed documents as well as the application data files are stored.

Shell

# Create the index:
curl -XPOST http://127.0.0.1:8000/test-idx

# Index some test documents:
curl -d "cat dog cow" http://127.0.0.1:8000/test-idx/add/1
curl -d "dog cow" http://127.0.0.1:8000/test-idx/add/2
curl -d "cat cat cat" http://127.0.0.1:8000/test-idx/add/3

# Run a query:
curl -s -d "cat" http://127.0.0.1:8000/test-idx/search | jq

Documentation

  • Swagger UI with the endpoint documentation is provided at /docs URL.

  • The Lua filters API can be found HERE.

  • The C API documentation can be found HERE.