Skip to content
Java Python
Find file
Latest commit 96bf53c @dadoonet dadoonet Move to elasticsearch repo

IMPORTANT: this project now moved to elasticsearch repository.

Only important bug fixes will be merged here. If you have a question about the plugin, please use If you want to report a bug, please use elasticsearch repository.

Phonetic Analysis for Elasticsearch

The Phonetic Analysis plugin integrates phonetic token filter analysis with elasticsearch.

In order to install the plugin, simply run:

bin/plugin install elasticsearch/elasticsearch-analysis-phonetic/2.7.0
elasticsearch Phonetic Analysis Plugin Docs
master Build from source See below
es-1.7 2.7.0 2.7.0
es-1.6 2.6.0 2.6.0
es-1.5 2.5.0 2.5.0
es-1.4 2.4.3 2.4.3
< 1.4.5 2.4.2 2.4.2
< 1.4.3 2.4.1 2.4.1
es-1.3 2.3.0 2.3.0
es-1.2 2.2.0 2.2.0
es-1.1 2.1.0 2.1.0
es-1.0 2.0.0 2.0.0
es-0.90 1.8.0 1.8.0

To build a SNAPSHOT version, you need to build it with Maven:

mvn clean install
plugin --install analysis-phonetic \
       --url file:target/releases/

User guide

A phonetic token filter that can be configured with different encoder types: metaphone, doublemetaphone, soundex, refinedsoundex, caverphone1, caverphone2, cologne, nysiis, koelnerphonetik, haasephonetik, beidermorse

The replace parameter (defaults to true) controls if the token processed should be replaced with the encoded one (set it to true), or added (set it to false).

    "index" : {
        "analysis" : {
            "analyzer" : {
                "my_analyzer" : {
                    "tokenizer" : "standard",
                    "filter" : ["standard", "lowercase", "my_metaphone"]
            "filter" : {
                "my_metaphone" : {
                    "type" : "phonetic",
                    "encoder" : "metaphone",
                    "replace" : false

Note that beidermorse does not support replace parameter.


If you have questions or comments please use the mailing list instead of Github Issues tracker.


This software is licensed under the Apache 2 license, quoted below.

Copyright 2009-2014 Elasticsearch <>

Licensed under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations under
the License.
Something went wrong with that request. Please try again.