policy_name |
yes |
- |
The name of the enrich policy to use. |
field |
yes |
- |
The field in the input document that matches the policies match_field used to retrieve the enrichment data. Supports template snippets. |
target_field |
yes |
- |
Field added to incoming documents to contain enrich data. This field contains both the match_field and enrich_fields specified in the enrich policy. Supports template snippets. |
ignore_missing |
no |
false |
If true and field does not exist, the processor quietly exits without modifying the document |
override |
no |
true |
If processor will update fields with pre-existing non-null-valued field. When set to false, such fields will not be touched. |
max_matches |
no |
1 |
The maximum number of matched documents to include under the configured target field. The target_field will be turned into a json array if max_matches is higher than 1, otherwise target_field will become a json object. In order to avoid documents getting too large, the maximum allowed value is 128. |
shape_relation |
no |
INTERSECTS |
A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index. This option is only used for geo_match enrich policy types. See Spatial Relations for operators and more information. |
description |
no |
- |
Description of the processor. Useful for describing the purpose of the processor or its configuration. |
if |
no |
- |
Conditionally execute the processor. See Conditionally run a processor. |
ignore_failure |
no |
false |
Ignore failures for the processor. See Handling pipeline failures. |
on_failure |
no |
- |
Handle failures for the processor. See Handling pipeline failures. |
tag |
no |
- |
Identifier for the processor. Useful for debugging and metrics. |