elasticsearch/docs/reference/ingestion-tools/enrich-processor/enrich-processor.md
Craig Taverner 94cad286bc
Restructure query-languages docs files for clarity (#124797)
In a few previous PR's we restructured the ES|QL docs to make it possible to generate them dynamically.

This PR just moves a few files around to make the query languages docs easier to work with, and a little more organized like the ES|QL docs.

A bit part of this was setting up redirects to the new locations, so other repo's could correctly link to the elasticsearch docs.
2025-03-17 17:58:58 +01:00

3 KiB

navigation_title mapped_pages
Enrich
https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-processor.html

Enrich processor [enrich-processor]

The enrich processor can enrich documents with data from another index. See enrich data section for more information about how to set this up.

$$$enrich-options$

Name Required Default Description
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.