Skip to main content

Toolkit for Elasticsearch Synonym files.

Project description

![Elasticsearch Synonyms](docs/banner.png)

[![Build Status][travis-img-url]][travis-href]
[![PyPI Version][pypi-v-shield-url]][pypi-href]

This repository contains a curated dataset of synonyms in [Solr Format][1]. These
synonyms can be used for [Elasticsearch Synonym Token Filter][2] configuration.

Additional helper tools in this repository:

- `synlint`: Commandline tool to lint and validate the synonym files.
- `synonyms.sublime-syntax`: Syntax highlighting file for Sublime Text 3.

If you're using Elasticssearch with Django, you might find [`dj-elasticsearch-flex`][es_flex] useful.

## Why?

Trying to configure Synonyms in Elasticsearch, I found that docs for it are surprisingly scattered.
The docs that are available do not do much justice either and miss out many corner cases.

For instance, an incorrect Solr mapping: `hello, world,` would be happily added in index configuration.
However, as soon as you'd try to re-open the index, you'd get a `malform_input_exception` [(discussion thread)][4].

This repository solves such problems by with a linter tool that can be used to validate the synonym
files beforehand.

## Datasets

The synonym files in `data/` can be used directly in elasticsearch configuration.

Following datasets are currently available:
- `be-ae`: British English and American English Spellings. From [](

## Installation

If you want to use the `synlint` tool, install the package from PIP using:
pip install elasticsearch-synonym-toolkit

The Python Package is installed as `es_synonyms`. This will also install a linter tool,
`es-synlint`. Use it with:

es-synlint [synonymfile]

## Usage

In most cases, you'd want to use this module as a helper for loading validated synonyms from a file or a url:
from es_synonyms import load_synonyms

# Load synonym file at some URL:
be_ae_syns = load_synonyms('')
# Or, from filesystem:
other_syns = load_synonyms('data/be-ae.synonyms')

Configuring [Synonym Tokenfilter][2] with [Elasticsearch DSL Py][3], is very easy, too:
from elasticsearch_dsl import analyzer, token_filter

be_ae_syns = load_synonyms('')

# Create a tokenfilter
brit_spelling_tokenfilter = token_filter(
'my_tokenfilter', # Any name for the filter
'synonym', # Synonym filter type
synonyms=be_ae_syns # Synonyms mapping will be inlined
# Create analyzer
brit_english_analyzer = analyzer(

To use the underlying linter, you can import `SynLint` class.

## Development

- Clone this repository.
- Install package dependencies via `pip` with: `pip install -r requirements.txt`.
- To run tests:
./panda test:all

## License

The tools and codes are licensed under MIT.
The datasets are used under fair use and are derivative of the original sources.


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

elasticsearch-synonym-toolkit-0.2.3.tar.gz (7.1 kB view hashes)

Uploaded Source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page