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.

  One of:

  analysis:CharFilter string analysis:HtmlStripCharFilter object analysis:MappingCharFilter object analysis:PatternReplaceCharFilter object analysis:IcuNormalizationCharFilter object analysis:KuromojiIterationMarkCharFilter object

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is html_strip.

  • escaped_tags array[string]

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is mapping.

  • mappings array[string]
  • mappings_path string

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is pattern_replace.

  • flags string
  • pattern string Required
  • replacement string

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is icu_normalizer.

  • mode string

    Values are decompose or compose.

  • name string

    Values are nfc, nfkc, or nfkc_cf.

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is kuromoji_iteration_mark.

  • normalize_kana boolean Required
  • normalize_kanji boolean Required
• 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

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is asciifolding.

  • preserve_original boolean | string

    Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

    Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

    One of:

    _spec_utils:Stringifiedboolean boolean _spec_utils:Stringifiedboolean string

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is common_grams.

  • common_words array[string]
  • common_words_path string
  • ignore_case boolean
  • query_mode boolean

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is condition.

  • filter array[string] Required
  • script object Required
    Hide script attributes Show script attributes object

    • source string

      The script source.

    • id string
    • params object

      Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

    • lang
    • options object

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is delimited_payload.

  • delimiter string
  • encoding string

    Values are int, float, or identity.

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is edge_ngram.

  • max_gram number
  • min_gram number
  • side string

    Values are front or back.

  • preserve_original boolean | string

    Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

    Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

    One of:

    _spec_utils:Stringifiedboolean boolean _spec_utils:Stringifiedboolean string

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is elision.

  • articles array[string]
  • articles_path string

  • articles_case boolean | string

    Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

    Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

    One of:

    _spec_utils:Stringifiedboolean boolean _spec_utils:Stringifiedboolean string

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is fingerprint.

  • max_output_size number
  • separator string

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is hunspell.

  • dedup boolean
  • dictionary string
  • locale string Required
  • longest_only boolean

  Hide attributes Show attributes

  • version string
  • hyphenation_patterns_path string
  • max_subword_size number
  • min_subword_size number
  • min_word_size number
  • only_longest_match boolean
  • word_list array[string]
  • word_list_path string
  • type string Required

    Value is hyphenation_decompounder.

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is keep_types.

  • mode string

    Values are include or exclude.

  • types array[string]

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is keep.

  • keep_words array[string]
  • keep_words_case boolean
  • keep_words_path string

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is keyword_marker.

  • ignore_case boolean
  • keywords array[string]
  • keywords_path string
  • keywords_pattern string

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is kstem.

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is length.

  • max number
  • min number

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is limit.

  • consume_all_tokens boolean

  • max_token_count number | string

    Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

    Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

    One of:

    _spec_utils:Stringifiedinteger number _spec_utils:Stringifiedinteger string

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is lowercase.

  • language string

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is multiplexer.

  • filters array[string] Required

  • preserve_original boolean | string

    Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

    Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

    One of:

    _spec_utils:Stringifiedboolean boolean _spec_utils:Stringifiedboolean string

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is ngram.

  • max_gram number
  • min_gram number

  • preserve_original boolean | string

    Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

    Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

    One of:

    _spec_utils:Stringifiedboolean boolean _spec_utils:Stringifiedboolean string

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is nori_part_of_speech.

  • stoptags array[string]

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is pattern_capture.

  • patterns array[string] Required

  • preserve_original boolean | string

    Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

    Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

    One of:

    _spec_utils:Stringifiedboolean boolean _spec_utils:Stringifiedboolean string

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is pattern_replace.

  • all boolean
  • flags string
  • pattern string Required
  • replacement string

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is porter_stem.

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is predicate_token_filter.

  • script object Required
    Hide script attributes Show script attributes object

    • source string

      The script source.

    • id string
    • params object

      Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

    • lang
    • options object

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is remove_duplicates.

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is reverse.

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is shingle.

  • filler_token string

  • max_shingle_size number | string

    One of:

    number-1 number string-2 string

  • min_shingle_size number | string

    One of:

    number-1 number string-2 string
  • output_unigrams boolean
  • output_unigrams_if_no_shingles boolean
  • token_separator string

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is snowball.

  • language string

    Values are Armenian, Basque, Catalan, Danish, Dutch, English, Finnish, French, German, German2, Hungarian, Italian, Kp, Lovins, Norwegian, Porter, Portuguese, Romanian, Russian, Spanish, Swedish, or Turkish.

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is stemmer_override.

  • rules array[string]
  • rules_path string

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is stemmer.

  • language string

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is stop.

  • ignore_case boolean
  • remove_trailing boolean

  • stopwords string | array[string]

    Language value, such as arabic or thai. Defaults to english. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words.

    One of:

    analysis:StopWords string analysis:StopWords array[string]
  • stopwords_path string

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is synonym_graph.

  • expand boolean
  • format string

    Values are solr or wordnet.

  • lenient boolean
  • synonyms array[string]
  • synonyms_path string
  • synonyms_set string
  • tokenizer string
  • updateable boolean

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is synonym.

  • expand boolean
  • format string

    Values are solr or wordnet.

  • lenient boolean
  • synonyms array[string]
  • synonyms_path string
  • synonyms_set string
  • tokenizer string
  • updateable boolean

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is trim.

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is truncate.

  • length number

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is unique.

  • only_on_same_position boolean

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is uppercase.

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is word_delimiter_graph.

  • adjust_offsets boolean
  • catenate_all boolean
  • catenate_numbers boolean
  • catenate_words boolean
  • generate_number_parts boolean
  • generate_word_parts boolean
  • ignore_keywords boolean

  • preserve_original boolean | string

    Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

    Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

    One of:

    _spec_utils:Stringifiedboolean boolean _spec_utils:Stringifiedboolean string
  • protected_words array[string]
  • protected_words_path string
  • split_on_case_change boolean
  • split_on_numerics boolean
  • stem_english_possessive boolean
  • type_table array[string]
  • type_table_path string

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is word_delimiter.

  • catenate_all boolean
  • catenate_numbers boolean
  • catenate_words boolean
  • generate_number_parts boolean
  • generate_word_parts boolean

  • preserve_original boolean | string

    Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

    Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

    One of:

    _spec_utils:Stringifiedboolean boolean _spec_utils:Stringifiedboolean string
  • protected_words array[string]
  • protected_words_path string
  • split_on_case_change boolean
  • split_on_numerics boolean
  • stem_english_possessive boolean
  • type_table array[string]
  • type_table_path string

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is kuromoji_stemmer.

  • minimum_length number Required

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is kuromoji_readingform.

  • use_romaji boolean Required

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is kuromoji_part_of_speech.

  • stoptags array[string] Required

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is icu_collation.

  • alternate string

    Values are shifted or non-ignorable.

  • case_first string

    Values are lower or upper.

  • case_level boolean
  • country string
  • decomposition string

    Values are no or identical.

  • hiragana_quaternary_mode boolean
  • language string
  • numeric boolean
  • rules string
  • strength string

    Values are primary, secondary, tertiary, quaternary, or identical.

  • variable_top string
  • variant string

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is icu_folding.

  • unicode_set_filter string Required

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is icu_normalizer.

  • name string Required

    Values are nfc, nfkc, or nfkc_cf.

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is icu_transform.

  • dir string

    Values are forward or reverse.

  • id string Required

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is phonetic.

  • encoder string Required

    Values are metaphone, double_metaphone, soundex, refined_soundex, caverphone1, caverphone2, cologne, nysiis, koelnerphonetik, haasephonetik, beider_morse, or daitch_mokotoff.

  • languageset string | array[string]

    One of:

    analysis:PhoneticLanguage string array-2 array[string]

    Values are any, common, cyrillic, english, french, german, hebrew, hungarian, polish, romanian, russian, or spanish.

    Values are any, common, cyrillic, english, french, german, hebrew, hungarian, polish, romanian, russian, or spanish.

  • max_code_len number
  • name_type string

    Values are generic, ashkenazi, or sephardic.

  • replace boolean
  • rule_type string

    Values are approx or exact.

  Hide attributes Show attributes

  • version string
  • hyphenation_patterns_path string
  • max_subword_size number
  • min_subword_size number
  • min_word_size number
  • only_longest_match boolean
  • word_list array[string]
  • word_list_path string
  • type string Required

    Value is dictionary_decompounder.

• normalizer string

  Normalizer to use to convert text into a single token.

• text string | array[string]

  One of:

  analyze:TextToAnalyze string analyze:TextToAnalyze 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

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is char_group.

  • tokenize_on_chars array[string] Required
  • max_token_length number

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is edge_ngram.

  • custom_token_chars string
  • max_gram number Required
  • min_gram number Required
  • token_chars array[string] Required

    Values are letter, digit, whitespace, punctuation, symbol, or custom.

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is keyword.

  • buffer_size number Required

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is letter.

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is lowercase.

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is ngram.

  • custom_token_chars string
  • max_gram number Required
  • min_gram number Required
  • token_chars array[string] Required

    Values are letter, digit, whitespace, punctuation, symbol, or custom.

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is nori_tokenizer.

  • decompound_mode string

    Values are discard, none, or mixed.

  • discard_punctuation boolean
  • user_dictionary string
  • user_dictionary_rules array[string]

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is path_hierarchy.

  • buffer_size number | string

    Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

    Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

    One of:

    _spec_utils:Stringifiedinteger number _spec_utils:Stringifiedinteger string
  • delimiter string
  • replacement string

  • reverse boolean | string

    Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

    Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

    One of:

    _spec_utils:Stringifiedboolean boolean _spec_utils:Stringifiedboolean string

  • skip number | string

    Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

    Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

    One of:

    _spec_utils:Stringifiedinteger number _spec_utils:Stringifiedinteger string

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is standard.

  • max_token_length number

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is uax_url_email.

  • max_token_length number

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is whitespace.

  • max_token_length number

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is kuromoji_tokenizer.

  • discard_punctuation boolean
  • mode string Required

    Values are normal, search, or extended.

  • nbest_cost number
  • nbest_examples string
  • user_dictionary string
  • user_dictionary_rules array[string]
  • discard_compound_token boolean

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is pattern.

  • flags string
  • group number
  • pattern string

  Hide attributes Show attributes

  • version string
  • type string Required

    Value is icu_tokenizer.

  • rule_files string Required