The Open API specification for Synapse is now available for download!

Download Open API Spec

TextAnalyzerSettings

org.sagebionetworks.repo.model.search.table.TextAnalyzerSettings

The OpenSearch analyzer configuration. Stores the full definition of how text is analyzed.

Field Type Description
charFilters STRING JSON string defining named character filter configurations. Each key is a filter name, each value is the filter config object.
tokenizer STRING The tokenizer name (e.g., 'standard', 'whitespace'). For custom tokenizers, define in 'tokenizerConfig'.
tokenizerConfig STRING JSON-serialized custom tokenizer configuration object. Must include a 'type' field. Example: {"type":"edge_ngram","min_gram":2,"max_gram":20,"token_chars":["letter","digit"]}
tokenFilters STRING JSON string defining named token filter configurations. Each key is a filter name, each value is the filter config object.
filterOrder ARRAY<STRING> Ordered list of token filter names to apply. Can reference built-in filters (e.g., 'lowercase') or custom ones defined in 'tokenFilters'.
charFilterOrder ARRAY<STRING> Ordered list of character filter names to apply.
synonymAware BOOLEAN Whether the synonym token filter should be appended when synonyms are configured.