OpenSearch/README.md

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.0.0.

• For master elasticsearch versions, look at master branch.
• For 1.2.x elasticsearch versions, look at es-1.2 branch.
• For 1.1.x elasticsearch versions, look at es-1.1 branch.
• For 1.0.x elasticsearch versions, look at es-1.0 branch.
• For 0.90.x elasticsearch versions, look at es-0.90 branch.

Phonetic Analysis Plugin	elasticsearch	Release date
3.0.0-SNAPSHOT	master	XXXX-XX-XX

Please read documentation relative to the version you are using:

• 3.0.0-SNAPSHOT

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
                }
            }
        }
    }
}

Questions

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

License

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

Copyright 2009-2014 Elasticsearch <http://www.elasticsearch.org>

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

    http://www.apache.org/licenses/LICENSE-2.0

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.