WARNING: Version 0.90 of Elasticsearch has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Performs the analysis process on a text and return the tokens breakdown of the text.
Can be used without specifying an index against one of the many built in analyzers:
curl -XGET 'localhost:9200/_analyze?analyzer=standard' -d 'this is a test'
Or by building a custom transient analyzer out of tokenizers and filters:
curl -XGET 'localhost:9200/_analyze?tokenizer=keyword&filters=lowercase' -d 'this is a test'
It can also run against a specific index:
curl -XGET 'localhost:9200/test/_analyze?text=this+is+a+test'
The above will run an analysis on the "this is a test" text, using the
default index analyzer associated with the
test index. An
can also be provided to use a different analyzer:
curl -XGET 'localhost:9200/test/_analyze?analyzer=whitespace' -d 'this is a test'
Also, the analyzer can be derived based on a field mapping, for example:
curl -XGET 'localhost:9200/test/_analyze?field=obj1.field1' -d 'this is a test'
Will cause the analysis to happen based on the analyzer configure in the
obj1.field1 (and if not, the default index analyzer).
Also, the text can be provided as part of the request body, and not as a parameter.
By default, the format the tokens are returned in are in json and its
text format value provides the analyzed data in
a text stream that is a bit more readable.