﻿---
title: Analysis Predicate Context
description: Use a painless script to determine whether or not the current token in an analysis chain matches a predicate. The standard Painless API is available. 
url: https://www.elastic.co/elastic/docs-builder/docs/2744/reference/scripting-languages/painless/painless-analysis-predicate-context
products:
  - Elasticsearch
  - Painless
applies_to:
  - Elastic Cloud Serverless: Generally available
  - Elastic Stack: Generally available
---

# Analysis Predicate Context
Use a painless script to determine whether or not the current token in an analysis chain matches a predicate.
<tip>
  This is an advanced feature for customizing text analysis and token filtering. To learn more, refer to [Text analysis](https://docs-v3-preview.elastic.dev/elastic/docs-builder/docs/2744/manage-data/data-store/text-analysis).
</tip>


## Variables

<definitions>
  <definition term="params (Map, read-only)">
    User-defined parameters passed in as part of the query.
  </definition>
  <definition term="token.term (CharSequence, read-only)">
    The characters of the current token
  </definition>
  <definition term="token.position (int, read-only)">
    The position of the current token
  </definition>
  <definition term="token.positionIncrement (int, read-only)">
    The position increment of the current token
  </definition>
  <definition term="token.positionLength (int, read-only)">
    The position length of the current token
  </definition>
  <definition term="token.startOffset (int, read-only)">
    The start offset of the current token
  </definition>
  <definition term="token.endOffset (int, read-only)">
    The end offset of the current token
  </definition>
  <definition term="token.type (String, read-only)">
    The type of the current token
  </definition>
  <definition term="token.keyword (boolean, read-only)">
    Whether or not the current token is marked as a keyword
  </definition>
</definitions>


## Return

<definitions>
  <definition term="boolean">
    Whether or not the current token matches the predicate
  </definition>
</definitions>


## API

The standard [Painless API](https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-api-reference-shared.html) is available.

## Example

To run the example, first [install the eCommerce sample data](/elastic/docs-builder/docs/2744/reference/scripting-languages/painless/painless-context-examples#painless-sample-data-install).
This example ensures that only properly formatted SKUs are processed. The analyzer checks that SKU codes start with "ZO" and are exactly thirteen characters long, filtering out malformed or invalid product codes that could break inventory systems or search functionality.
```json
PUT sku_analysis
{
  "settings": {
    "analysis": {
      "analyzer": {
        "sku_search_analyzer": {
          "tokenizer": "whitespace",
          "filter": [
            "sku_validator"
          ]
        }
      },
      "filter": {
        "sku_validator": {
          "type": "predicate_token_filter",
          "script": {
            "source": """
              return token.term.length() == 12 && token.term.toString().startsWith('ZO');
            """
          }
        }
      }
    }
  }
}
```

Test it using the following request:
```json
GET sku_analysis/_analyze
{
  "analyzer": "sku_search_analyzer",
  "text": "ZO0240302403 ZO0236402364 INVALID123 SHORT AB1234567890123"
}
```

Result:
```json
{
  "tokens": [
    {
      "token": "ZO0240302403",
      "start_offset": 0,
      "end_offset": 12,
      "type": "word",
      "position": 0
    },
    {
      "token": "ZO0236402364",
      "start_offset": 13,
      "end_offset": 25,
      "type": "word",
      "position": 1
    }
  ]
}
```