This is a cache of https://www.elastic.co/guide/en/elasticsearch/painless/8.19/painless-analysis-predicate-context.html. It is a snapshot of the page as it appeared on 2025-11-22T03:19:06.062+0000.
Analysis Predicate Context | Painless Scripting Language [8.<strong>19</strong>] | Elastic
« Bucket selector aggregation context Watcher condition context »
Elastic Docs ›Painless Scripting Language [8.19] ›Painless contexts

Analysis Predicate Context

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

Analysis Predicate Context

edit

Use a painless script to determine whether or not the current token in an analysis chain matches a predicate.

Variables

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

Return

boolean
Whether or not the current token matches the predicate

API

The standard Painless API is available.

« Bucket selector aggregation context Watcher condition context »