IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Keep Words Token Filter Exclude mode settings example »

› › ›

Keep Types Token Filter

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Keep Types Token Filter

edit

A token filter of type keep_types that only keeps tokens with a token type contained in a predefined set.

Options

edit

types	a list of types to include (default mode) or exclude
mode	if set to `include` (default) the specified token types will be kept, if set to `exclude` the specified token types will be removed from the stream

Settings example

edit

You can set it up like:

PUT /keep_types_example
{
    "settings" : {
        "analysis" : {
            "analyzer" : {
                "my_analyzer" : {
                    "tokenizer" : "standard",
                    "filter" : ["standard", "lowercase", "extract_numbers"]
                }
            },
            "filter" : {
                "extract_numbers" : {
                    "type" : "keep_types",
                    "types" : [ "<NUM>" ]
                }
            }
        }
    }
}

And test it like:

POST /keep_types_example/_analyze
{
  "analyzer" : "my_analyzer",
  "text" : "this is just 1 a test"
}

The response will be:

{
  "tokens": [
    {
      "token": "1",
      "start_offset": 13,
      "end_offset": 14,
      "type": "<NUM>",
      "position": 3
    }
  ]
}

Note how only the <NUM> token is in the output.

« Keep Words Token Filter Exclude mode settings example »