12345678910111213141516171819202122 |
- [role="xpack"]
- [testenv="basic"]
- [[enrich-processor]]
- === Enrich Processor
- The `enrich` processor can enrich documents with data from another index.
- See <<ingest-enriching-data,enrich data>> section for more information how to set this up and
- check out the <<ingest-enriching-data,tutorial>> to get familiar with enrich policies and related APIs.
- [[enrich-options]]
- .Enrich Options
- [options="header"]
- |======
- | 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.
- | `target_field` | yes | - | The field that will be used for the enrichment data.
- | `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. In order to avoid documents getting too large, the maximum allowed value is 128.
- include::common-options.asciidoc[]
- |======
|