History

uboness b40186652c updated the elasticsearch versioning format Moving to from `X.Y.Z.beta1`/`X.Y.Z.RC1` to `X.Y.Z-beta1`/`X.Y.Z-rc1`		2015-07-13 20:26:37 +02:00
..
licenses	[build] include in plugins only needed jars	2015-07-01 21:37:27 +02:00
rest-api-spec/test/analysis_phonetic	[phonetic] move integration tests to REST tests	2015-07-08 10:17:43 +02:00
src	[phonetic] move integration tests to REST tests	2015-07-08 10:04:18 +02:00
LICENSE.txt	Added LICENSE and NOTICE files for all plugins	2015-06-23 12:50:31 +02:00
NOTICE.txt	Added LICENSE and NOTICE files for all plugins	2015-06-23 12:50:31 +02:00
README.md	add analysis-phonetic module	2015-06-05 13:12:20 +02:00
pom.xml	updated the elasticsearch versioning format	2015-07-13 20:26:37 +02:00

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

elasticsearch	Phonetic Analysis Plugin	Docs
master	Build from source	See below
es-1.x	Build from source	2.6.0-SNAPSHOT
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/elasticsearch-analysis-phonetic-X.X.X-SNAPSHOT.zip

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.

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.