IMPORTANT: elasticsearch.js has been replaced by the new Elasticsearch JavaScript client. We strongly advise you to migrate to the new client. To learn more, see the migration guide.

« cluster.stats indices.clearCache »

› ›

indices.analyze

edit

`indices.analyze`

edit

client.indices.analyze([params, [callback]])

Perform the analysis process on a text and return the tokens breakdown of the text.

Check the API Conventions and the elasticsearch docs for more information pertaining to this method.

Params

`analyzer`	`String` — The name of the analyzer to use
`charFilter`	`String`, `String[]`, `Boolean` — A comma-separated list of character filters to use for the analysis
`field`	`String` — Use the analyzer configured for this field (instead of passing the analyzer name)
`filter`	`String`, `String[]`, `Boolean` — A comma-separated list of filters to use for the analysis
`index`	`String` — The name of the index to scope the operation
`preferLocal`	`Boolean` — With `true`, specify that a local shard should be used if available, with `false`, use a random shard (default: true)
`text`	`String`, `String[]`, `Boolean` — The text on which the analysis should be performed (when request body is not used)
`tokenizer`	`String` — The name of the tokenizer to use for the analysis
`explain`	`Boolean` — With `true`, outputs more advanced details. (default: false)
`attributes`	`String`, `String[]`, `Boolean` — A comma-separated list of token attributes to output, this parameter works only with `explain=true`
`[format=detailed]`	`String` — Format of the output Options `"detailed"` `"text"`
`body`	`Object`, `JSON` — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

« cluster.stats indices.clearCache »