Stop Word

Stop Word (stop-word)

Remove or mask common stop words from textual content.

Transform json

Minimal example

actions:
  - stop-word: {}

JSON

{
  "actions": [
    {
      "stop-word": {}
    }
  ]
}

Contents

• Minimal example

• Fields

• General

• Input

• Output

• Behaviour

Fields

Field	Type	Required	Description
description General	string		Describe this step.
condition General	lua-expression (string)		Only run this action if the condition is met. Examples: 2 * count()
input-field Input	field (string)		Field containing the input text. Examples: data_field
tokens-field Input	field (string)		Field containing an existing array of tokens to filter. Examples: data_field
output-field Output	field (string)		Field to write the filtered output to (defaults to input when unset). Examples: data_field
language Behaviour	string		Named language profile for the built-in stop word lists.
custom Behaviour	string[]		Custom stop words to merge with the language profile.
case-sensitive Behaviour	boolean (bool)		Treat comparisons as case sensitive.
preserve-phrases Behaviour	boolean (bool)		Preserve multi-word phrases when present in the input.
metrics-field Output	field (string)		Optional field to capture statistics about removals. Examples: data_field

General

Show fields

Field	Type	Required	Description
description	string		Describe this step.
condition	lua-expression (string)		Only run this action if the condition is met. Examples: 2 * count()

Input

Show fields

Field	Type	Required	Description
input-field	field (string)		Field containing the input text. Examples: data_field
tokens-field	field (string)		Field containing an existing array of tokens to filter. Examples: data_field

Output

Show fields

Field	Type	Required	Description
output-field	field (string)		Field to write the filtered output to (defaults to input when unset). Examples: data_field
metrics-field	field (string)		Optional field to capture statistics about removals. Examples: data_field

Behaviour

Show fields

Field	Type	Required	Description
language	string		Named language profile for the built-in stop word lists.
custom	string[]		Custom stop words to merge with the language profile.
case-sensitive	boolean (bool)		Treat comparisons as case sensitive.
preserve-phrases	boolean (bool)		Preserve multi-word phrases when present in the input.