Rust BKTree

A simple BKTree written in rust. It can be used as a library in your own code or as an API.

It is designed to allow for easy auto-complete or suggestions based off of a given word and corpus that it was built upon. It can be used for incredbily efficient lookup to enhance programs. Some use cases of this could be "did you mean" for words or for commands. It could also be used for a basic spell-check.

🚀 Getting Started

API

If you would like to use the api, you can get started by making a get request to the following link.

https://bktree-api.dev.benl.dev/words?query=test&distance=2&limit=0

This will make a request to the API, and give words within a "edit" distance of 2 with no limit. It auto-completes from the standard unix dictonary.

What the paramaters do is as followed.

Query: The word that you want auto-complete or suggestions for.
Distance: The amount of potential 'edits' to a word that the API will return.
Limit: If you only want x amount of words returned form the API instead of all of them.

Library

Currently, the library is not published on on crates.io, but you can import it as a Github repository if you would like to use it.

Add the following to your Cargo.toml file.

[dependencies]
bktree-rs = { git = https://github.com/tempor1s/bktree-rs }

Contributors

Anyone is welcome to contribute!

Ben Lafferty 💻