Body
-
analyzer string
The name of the analyzer that should be applied to the provided
text
. This could be a built-in analyzer, or an analyzer that’s been configured in the index. -
attributes array[string]
Array of token attributes used to filter the output of the
explain
parameter. -
char_filter array[string | object]
Array of character filters used to preprocess characters before the tokenizer.
-
explain boolean
If
true
, the response includes token attributes and additional details. -
field string
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
filter array[string | object]
Array of token filters used to apply after the tokenizer.
One of: analysis:TokenFilter string analysis:AsciiFoldingTokenFilter object analysis:CommonGramsTokenFilter object analysis:ConditionTokenFilter object analysis:DelimitedPayloadTokenFilter object analysis:EdgeNGramTokenFilter object analysis:ElisionTokenFilter object analysis:FingerprintTokenFilter object analysis:HunspellTokenFilter object analysis:HyphenationDecompounderTokenFilter object analysis:KeepTypesTokenFilter object analysis:KeepWordsTokenFilter object analysis:KeywordMarkerTokenFilter object analysis:KStemTokenFilter object analysis:LengthTokenFilter object analysis:LimitTokenCountTokenFilter object analysis:LowercaseTokenFilter object analysis:MultiplexerTokenFilter object analysis:NGramTokenFilter object analysis:NoriPartOfSpeechTokenFilter object analysis:PatternCaptureTokenFilter object analysis:PatternReplaceTokenFilter object analysis:PorterStemTokenFilter object analysis:PredicateTokenFilter object analysis:RemoveDuplicatesTokenFilter object analysis:ReverseTokenFilter object analysis:ShingleTokenFilter object analysis:SnowballTokenFilter object analysis:StemmerOverrideTokenFilter object analysis:StemmerTokenFilter object analysis:StopTokenFilter object analysis:SynonymGraphTokenFilter object analysis:SynonymTokenFilter object analysis:TrimTokenFilter object analysis:TruncateTokenFilter object analysis:UniqueTokenFilter object analysis:UppercaseTokenFilter object analysis:WordDelimiterGraphTokenFilter object analysis:WordDelimiterTokenFilter object analysis:KuromojiStemmerTokenFilter object analysis:KuromojiReadingFormTokenFilter object analysis:KuromojiPartOfSpeechTokenFilter object analysis:IcuCollationTokenFilter object analysis:IcuFoldingTokenFilter object analysis:IcuNormalizationTokenFilter object analysis:IcuTransformTokenFilter object analysis:PhoneticTokenFilter object analysis:DictionaryDecompounderTokenFilter object -
normalizer string
Normalizer to use to convert text into a single token.
text string | array[string]
tokenizer string | object
One of: analysis:Tokenizer string analysis:CharGroupTokenizer object analysis:EdgeNGramTokenizer object analysis:KeywordTokenizer object analysis:LetterTokenizer object analysis:LowercaseTokenizer object analysis:NGramTokenizer object analysis:NoriTokenizer object analysis:PathHierarchyTokenizer object analysis:StandardTokenizer object analysis:UaxEmailUrlTokenizer object analysis:WhitespaceTokenizer object analysis:KuromojiTokenizer object analysis:PatternTokenizer object analysis:IcuTokenizer object
POST /_analyze
curl \
-X POST http://api.example.com/_analyze \
-H "Content-Type: application/json" \
-d '{"analyzer":"string","attributes":["string"],"char_filter":["string"],"explain":true,"field":"string","filter":["string"],"normalizer":"string","":"string"}'