---
title: Conditional token filter
description: Applies a set of token filters to tokens that match conditions in a provided predicate script. This filter uses Lucene’s ConditionalTokenFilter. The following...
url: https://www.elastic.co/elastic/docs-builder/docs/3028/reference/text-analysis/analysis-condition-tokenfilter
products:
  - Elasticsearch
---

# Conditional token filter
Applies a set of token filters to tokens that match conditions in a provided predicate script.
This filter uses Lucene’s [ConditionalTokenFilter](https://lucene.apache.org/core/10_0_0/analysis/common/org/apache/lucene/analysis/miscellaneous/ConditionalTokenFilter.md).

## Example

The following [analyze API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-analyze) request uses the `condition` filter to match tokens with fewer than 5 characters in `THE QUICK BROWN FOX`. It then applies the [`lowercase`](https://www.elastic.co/elastic/docs-builder/docs/3028/reference/text-analysis/analysis-lowercase-tokenfilter) filter to those matching tokens, converting them to lowercase.
```json

{
  "tokenizer": "standard",
  "filter": [
    {
      "type": "condition",
      "filter": [ "lowercase" ],
      "script": {
        "source": "token.getTerm().length() < 5"
      }
    }
  ],
  "text": "THE QUICK BROWN FOX"
}
```

The filter produces the following tokens:
```text
[ the, QUICK, BROWN, fox ]
```


## Configurable parameters

<definitions>
  <definition term="filter">
    (Required, array of token filters) Array of token filters. If a token matches the predicate script in the `script` parameter, these filters are applied to the token in the order provided.
  </definition>
</definitions>

These filters can include custom token filters defined in the index mapping.
<definitions>
  <definition term="script">
    (Required, [script object](https://docs-v3-preview.elastic.dev/elastic/docs-builder/docs/3028/explore-analyze/scripting/modules-scripting-using)) Predicate script used to apply token filters. If a token matches this script, the filters in the `filter` parameter are applied to the token.
  </definition>
</definitions>

For valid parameters, see [*How to write scripts*](https://docs-v3-preview.elastic.dev/elastic/docs-builder/docs/3028/explore-analyze/scripting/modules-scripting-using). Only inline scripts are supported. Painless scripts are executed in the [analysis predicate context](https://www.elastic.co/elastic/docs-builder/docs/3028/reference/scripting-languages/painless/painless-analysis-predicate-context) and require a `token` property.

## Customize and add to an analyzer

To customize the `condition` filter, duplicate it to create the basis for a new custom token filter. You can modify the filter using its configurable parameters.
For example, the following [create index API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create) request uses a custom `condition` filter to configure a new [custom analyzer](https://docs-v3-preview.elastic.dev/elastic/docs-builder/docs/3028/manage-data/data-store/text-analysis/create-custom-analyzer). The custom `condition` filter matches the first token in a stream. It then reverses that matching token using the [`reverse`](https://www.elastic.co/elastic/docs-builder/docs/3028/reference/text-analysis/analysis-reverse-tokenfilter) filter.
```json

{
  "settings": {
    "analysis": {
      "analyzer": {
        "whitespace_reverse_first_token": {
          "tokenizer": "whitespace",
          "filter": [ "reverse_first_token" ]
        }
      },
      "filter": {
        "reverse_first_token": {
          "type": "condition",
          "filter": [ "reverse" ],
          "script": {
            "source": "token.getPosition() === 0"
          }
        }
      }
    }
  }
}
```