Skip to content

Commit

Permalink
Correct the type of the 'analyzer' parameter in the _analyze docs. (#…
Browse files Browse the repository at this point in the history
…56650)

This optional parameter can only be a string. To test out a transient custom
analysis chain, users are expected to use the 'tokenizer', 'filter', and
'char_filter' parameters.
  • Loading branch information
jtibshirani committed May 13, 2020
1 parent 32820b9 commit e47601e
Showing 1 changed file with 4 additions and 8 deletions.
12 changes: 4 additions & 8 deletions docs/reference/indices/analyze.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ the `analyzer` or `<field>` parameter overrides this value.
If no analyzer or field are specified,
the analyze API uses the default analyzer for the index.

If no index is specified
If no index is specified
or the index does not have a default analyzer,
the analyze API uses the <<analysis-standard-analyzer,standard analyzer>>.
--
Expand All @@ -56,11 +56,9 @@ the analyze API uses the <<analysis-standard-analyzer,standard analyzer>>.
`analyzer`::
+
--
(Optional, string or <<analysis-custom-analyzer,custom analyzer object>>)
Analyzer used to analyze for the provided `text`.

See <<analysis-analyzers>> for a list of built-in analyzers.
You can also provide a <<analysis-custom-analyzer,custom analyzer>>.
(Optional, string)
The name of the analyzer that should be applied to the provided `text`. This could be a
<<analysis-analyzers, built-in analyzer>>, or an analyzer that's been configured in the index.

If this parameter is not specified,
the analyze API uses the analyzer defined in the field's mapping.
Expand Down Expand Up @@ -187,8 +185,6 @@ GET /_analyze
}
--------------------------------------------------

deprecated[5.0.0, Use `filter`/`char_filter` instead of `filters`/`char_filters` and `token_filters` has been removed]

Custom tokenizers, token filters, and character filters can be specified in the request body as follows:

[source,console]
Expand Down

0 comments on commit e47601e

Please sign in to comment.