Simulate pipeline API

Executes an ingest pipeline against a set of provided documents.

  1. POST /_ingest/pipeline/my-pipeline-id/_simulate
  2. {
  3.   "docs": [
  4.     {
  5.       "_index": "index",
  6.       "_id": "id",
  7.       "_source": {
  8.         "foo": "bar"
  9.       }
  10.     },
  11.     {
  12.       "_index": "index",
  13.       "_id": "id",
  14.       "_source": {
  15.         "foo": "rab"
  16.       }
  17.     }
  18.   ]
  19. }

Request

POST /_ingest/pipeline/<pipeline>/_simulate

GET /_ingest/pipeline/<pipeline>/_simulate

POST /_ingest/pipeline/_simulate

GET /_ingest/pipeline/_simulate

Description

The simulate pipeline API executes a specific pipeline against a set of documents provided in the body of the request.

You can either specify an existing pipeline to execute against the provided documents or supply a pipeline definition in the body of the request.

Path parameters

<pipeline>

(Optional, string) Pipeline ID used to simulate an ingest.

Query parameters

verbose

(Optional, boolean) If true, the response includes output data for each processor in the executed pipeline.

Request body

description

(Optional, string) Description of the ingest pipeline.

processors

(Optional, array of processor objects) Array of processors used to pre-process documents during ingest.

Processors are executed in the order provided.

See Processors for processor object definitions and a list of built-in processors.

docs

(Required, array) Array of documents ingested by the pipeline.

Document object parameters include:

  • _index

    (Optional, string) Name of the index containing the document.

    _id

    (Optional, string) Unique identifier for the document. This ID is only unique within the index.

    _source

    (Required, object) JSON body for the document.

Examples

Specify a pipeline as a path parameter

  1. POST /_ingest/pipeline/my-pipeline-id/_simulate
  2. {
  3.   "docs": [
  4.     {
  5.       "_index": "index",
  6.       "_id": "id",
  7.       "_source": {
  8.         "foo": "bar"
  9.       }
  10.     },
  11.     {
  12.       "_index": "index",
  13.       "_id": "id",
  14.       "_source": {
  15.         "foo": "rab"
  16.       }
  17.     }
  18.   ]
  19. }

The API returns the following response:

  1. {
  2.    "docs": [
  3.       {
  4.          "doc": {
  5.             "_id": "id",
  6.             "_index": "index",
  7.             "_type": "_doc",
  8.             "_source": {
  9.                "field2": "_value",
  10.                "foo": "bar"
  11.             },
  12.             "_ingest": {
  13.                "timestamp": "2017-05-04T22:30:03.187Z"
  14.             }
  15.          }
  16.       },
  17.       {
  18.          "doc": {
  19.             "_id": "id",
  20.             "_index": "index",
  21.             "_type": "_doc",
  22.             "_source": {
  23.                "field2": "_value",
  24.                "foo": "rab"
  25.             },
  26.             "_ingest": {
  27.                "timestamp": "2017-05-04T22:30:03.188Z"
  28.             }
  29.          }
  30.       }
  31.    ]
  32. }

Specify a pipeline in the request body

  1. POST /_ingest/pipeline/_simulate
  2. {
  3.   "pipeline" :
  4.   {
  5.     "description": "_description",
  6.     "processors": [
  7.       {
  8.         "set" : {
  9.           "field" : "field2",
  10.           "value" : "_value"
  11.         }
  12.       }
  13.     ]
  14.   },
  15.   "docs": [
  16.     {
  17.       "_index": "index",
  18.       "_id": "id",
  19.       "_source": {
  20.         "foo": "bar"
  21.       }
  22.     },
  23.     {
  24.       "_index": "index",
  25.       "_id": "id",
  26.       "_source": {
  27.         "foo": "rab"
  28.       }
  29.     }
  30.   ]
  31. }

The API returns the following response:

  1. {
  2.    "docs": [
  3.       {
  4.          "doc": {
  5.             "_id": "id",
  6.             "_index": "index",
  7.             "_type": "_doc",
  8.             "_source": {
  9.                "field2": "_value",
  10.                "foo": "bar"
  11.             },
  12.             "_ingest": {
  13.                "timestamp": "2017-05-04T22:30:03.187Z"
  14.             }
  15.          }
  16.       },
  17.       {
  18.          "doc": {
  19.             "_id": "id",
  20.             "_index": "index",
  21.             "_type": "_doc",
  22.             "_source": {
  23.                "field2": "_value",
  24.                "foo": "rab"
  25.             },
  26.             "_ingest": {
  27.                "timestamp": "2017-05-04T22:30:03.188Z"
  28.             }
  29.          }
  30.       }
  31.    ]
  32. }

View verbose results

You can use the simulate pipeline API to see how each processor affects the ingest document as it passes through the pipeline. To see the intermediate results of each processor in the simulate request, you can add the verbose parameter to the request.

  1. POST /_ingest/pipeline/_simulate?verbose
  2. {
  3.   "pipeline" :
  4.   {
  5.     "description": "_description",
  6.     "processors": [
  7.       {
  8.         "set" : {
  9.           "field" : "field2",
  10.           "value" : "_value2"
  11.         }
  12.       },
  13.       {
  14.         "set" : {
  15.           "field" : "field3",
  16.           "value" : "_value3"
  17.         }
  18.       }
  19.     ]
  20.   },
  21.   "docs": [
  22.     {
  23.       "_index": "index",
  24.       "_id": "id",
  25.       "_source": {
  26.         "foo": "bar"
  27.       }
  28.     },
  29.     {
  30.       "_index": "index",
  31.       "_id": "id",
  32.       "_source": {
  33.         "foo": "rab"
  34.       }
  35.     }
  36.   ]
  37. }

The API returns the following response:

  1. {
  2.    "docs": [
  3.       {
  4.          "processor_results": [
  5.             {
  6.                "doc": {
  7.                   "_id": "id",
  8.                   "_index": "index",
  9.                   "_type": "_doc",
  10.                   "_source": {
  11.                      "field2": "_value2",
  12.                      "foo": "bar"
  13.                   },
  14.                   "_ingest": {
  15.                      "timestamp": "2017-05-04T22:46:09.674Z",
  16.                      "pipeline": "_simulate_pipeline"
  17.                   }
  18.                }
  19.             },
  20.             {
  21.                "doc": {
  22.                   "_id": "id",
  23.                   "_index": "index",
  24.                   "_type": "_doc",
  25.                   "_source": {
  26.                      "field3": "_value3",
  27.                      "field2": "_value2",
  28.                      "foo": "bar"
  29.                   },
  30.                   "_ingest": {
  31.                      "timestamp": "2017-05-04T22:46:09.675Z",
  32.                      "pipeline": "_simulate_pipeline"
  33.                   }
  34.                }
  35.             }
  36.          ]
  37.       },
  38.       {
  39.          "processor_results": [
  40.             {
  41.                "doc": {
  42.                   "_id": "id",
  43.                   "_index": "index",
  44.                   "_type": "_doc",
  45.                   "_source": {
  46.                      "field2": "_value2",
  47.                      "foo": "rab"
  48.                   },
  49.                   "_ingest": {
  50.                      "timestamp": "2017-05-04T22:46:09.676Z",
  51.                      "pipeline": "_simulate_pipeline"
  52.                   }
  53.                }
  54.             },
  55.             {
  56.                "doc": {
  57.                   "_id": "id",
  58.                   "_index": "index",
  59.                   "_type": "_doc",
  60.                   "_source": {
  61.                      "field3": "_value3",
  62.                      "field2": "_value2",
  63.                      "foo": "rab"
  64.                   },
  65.                   "_ingest": {
  66.                      "timestamp": "2017-05-04T22:46:09.677Z",
  67.                      "pipeline": "_simulate_pipeline"
  68.                   }
  69.                }
  70.             }
  71.          ]
  72.       }
  73.    ]
  74. }