Use this endpoint to execute a specific pipeline with the provided parameters. It is a generic pipeline endpoint where you can choose the pipeline and pass the necessary parameters for execution. This endpoint is ideal for testing purposes.
It is recommended to create an endpoint wrapper for the pipeline with all parameters documented.
Parameter | Type | Description |
---|---|---|
pipeline_name | string | The name of the pipeline to execute |
Parameter | Type | Description |
---|---|---|
exclude | array | A list of keys to exclude from the final response. |
include | array | A list of keys to include in the final response. If a key is not included, it will be omitted. |
Parameter | Type | Description |
---|---|---|
(parameters) | object | Body parameters to be fed into the pipeline. The parameters vary depending on the specific pipeline. The creator of the pipeline is responsible for documenting these parameters. |
POST /es/api/v1/pipeline/execute/{pipeline_name} { "param1": "value1", "param2": "value2" }
{ "stage1": "Something", "stage2": { ... } }
{ "detail": [ { "loc": ["body", "param1"], "msg": "Field required", "type": "value_error.missing" } ] }
Use this endpoint to get the UI configuration of a specific pipeline. You can choose the pipeline by specifying the pipeline name. This endpoint is ideal for testing purposes.
Parameter | Type | Description |
---|---|---|
pipeline_name | string | The name of the pipeline to execute |
Parameter | Type | Description |
---|---|---|
exclude | array | A list of keys to exclude from the final response. |
include | array | A list of keys to include in the final response. If a key is not included, it will be omitted. |
Parameter | Type | Description |
---|---|---|
(parameters) | object | Body parameters to be fed into the pipeline. The parameters vary depending on the specific pipeline. The creator of the pipeline is responsible for documenting these parameters. |
POST /es/api/v1/pipeline/ui/{pipeline_name} { "param1": "value1", "param2": "value2" }
{ "stage1": "Something", "stage2": { ... } }
{ "detail": [ { "loc": ["body", "param1"], "msg": "Field required", "type": "value_error.missing" } ] }
Use this endpoint to get a list of all available pipelines.
This endpoint does not require any parameters.
GET /es/api/v1/pipeline
{ "pipelines": [ "search_metadata", "typeahead", "search" ] }
Use this endpoint to get the configuration of a pipeline, including the list of stages
Parameter | Type | Description |
---|---|---|
pipeline_name | string | The name of the pipeline to execute |
GET /es/api/v1/pipeline/{pipeline_name}
{ "enable": true, "stages": [ { "type": "Stage", "enable": true, "name": "stage1" }, { "type": "Stage", "enable": true, "name": "stage2" }, { "type": "Stage", "enable": true, "name": "stage3" }, { "type": "Stage", "enable": true, "name": "stage4" } ] }
{ "detail": [ { "loc": [ "string", 0 ], "msg": "string", "type": "string" } ] }