enrich.asciidoc 1.4 KB

12345678910111213141516171819202122
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[enrich-processor]]
  4. === Enrich Processor
  5. The `enrich` processor can enrich documents with data from another index.
  6. See <<ingest-enriching-data,enrich data>> section for more information how to set this up and
  7. check out the <<ingest-enriching-data,tutorial>> to get familiar with enrich policies and related APIs.
  8. [[enrich-options]]
  9. .Enrich Options
  10. [options="header"]
  11. |======
  12. | Name | Required | Default | Description
  13. | `policy_name` | yes | - | The name of the enrich policy to use.
  14. | `field` | yes | - | The field in the input document that matches the policies match_field used to retrieve the enrichment data.
  15. | `target_field` | yes | - | The field that will be used for the enrichment data.
  16. | `ignore_missing` | no | false | If `true` and `field` does not exist, the processor quietly exits without modifying the document
  17. | `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.
  18. | `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.
  19. include::common-options.asciidoc[]
  20. |======