WARNING: Version 5.x 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.

› ›

indices.analyze

edit

indices.analyze

edit

client.indices.analyze({
  index: string,
  analyzer: string,
  char_filter: string | string[],
  field: string,
  filter: string | string[],
  index: string,
  prefer_local: boolean,
  text: string | string[],
  tokenizer: string,
  explain: boolean,
  attributes: string | string[],
  format: 'detailed' | 'text',
  body: object
})

Reference

`index`	`string` - The name of the index to scope the operation
`analyzer`	`string` - The name of the analyzer to use
`char_filter` or `charFilter`	`string \| string[]` - 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[]` - A comma-separated list of filters to use for the analysis
`index`	`string` - The name of the index to scope the operation
`prefer_local` or `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[]` - 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[]` - A comma-separated list of token attributes to output, this parameter works only with `explain=true`
`format`	`'detailed' \| 'text'` - Format of the output Default: `detailed`
`body`	`object` - The text on which the analysis should be performed

« index indices.clearCache »