Get an enrich policy Generally available; Added in 7.5.0

GET /_enrich/policy/{name}

Returns information about an enrich policy.

Path parameters

  • name string | array[string] Required

    Comma-separated list of enrich policy names used to limit the request. To return information for all enrich policies, omit this parameter.

Query parameters

  • master_timeout string

    Period to wait for a connection to the master node.

    Values are -1 or 0.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • policies array[object] Required
      Hide policies attribute Show policies attribute object
      • config object Required
        Hide config attribute Show config attribute object
        • * object Additional properties
          Hide * attributes Show * attributes object
          • enrich_fields string | array[string] Required
          • indices string | array[string] Required
          • match_field string Required

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • query object

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

            External documentation
            Hide query attributes Show query attributes object
            • bool
            • boosting
            • common object Deprecated
            • combined_fields
            • constant_score
            • dis_max
            • distance_feature
            • exists
            • function_score
            • fuzzy object

              Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.

            • geo_bounding_box
            • geo_distance
            • geo_grid object

              Matches geo_point and geo_shape values that intersect a grid cell from a GeoGrid aggregation.

            • geo_polygon
            • geo_shape
            • has_child
            • has_parent
            • ids
            • intervals object

              Returns documents based on the order and proximity of matching terms.

            • knn
            • match object

              Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.

            • match_all
            • match_bool_prefix object

              Analyzes its input and constructs a bool query from the terms. Each term except the last is used in a term query. The last term is used in a prefix query.

            • match_none
            • match_phrase object

              Analyzes the text and creates a phrase query out of the analyzed text.

            • match_phrase_prefix object

              Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.

            • more_like_this
            • multi_match
            • nested
            • parent_id
            • percolate
            • pinned
            • prefix object

              Returns documents that contain a specific prefix in a provided field.

            • query_string
            • range object

              Returns documents that contain terms within a provided range.

            • rank_feature
            • regexp object

              Returns documents that contain terms matching a regular expression.

            • rule
            • script
            • script_score
            • semantic
            • shape
            • simple_query_string
            • span_containing
            • span_field_masking
            • span_first
            • span_multi
            • span_near
            • span_not
            • span_or
            • span_term object

              Matches spans containing a term.

            • span_within
            • sparse_vector
            • term object

              Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.

            • terms
            • terms_set object

              Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.

            • text_expansion object Deprecated Generally available; Added in 8.8.0

              Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.

            • weighted_tokens object Deprecated Generally available; Added in 8.13.0

              Supports returning text_expansion query results by sending in precomputed tokens with the query.

            • wildcard object

              Returns documents that contain terms matching a wildcard pattern.

            • wrapper
            • type
          • name string
          • elasticsearch_version string
GET /_enrich/policy/{name}
GET /_enrich/policy/my-policy
curl \
 --request GET 'http://api.example.com/_enrich/policy/{name}'

Documentation preview

This is a preview of your version @2025-06-09 which is not yet released.