From 492e4085263e699a29ab4c5dfa288a4af658584f Mon Sep 17 00:00:00 2001 From: Owais Date: Tue, 24 Sep 2024 15:40:44 -0700 Subject: [PATCH 1/2] Adds documentation for providing search pipeline id in the request Signed-off-by: Owais --- .../search-pipelines/using-search-pipeline.md | 26 ++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/_search-plugins/search-pipelines/using-search-pipeline.md b/_search-plugins/search-pipelines/using-search-pipeline.md index ecb988ad110..30ff32c06da 100644 --- a/_search-plugins/search-pipelines/using-search-pipeline.md +++ b/_search-plugins/search-pipelines/using-search-pipeline.md @@ -27,8 +27,32 @@ GET /my_index/_search?search_pipeline=my_pipeline For a complete example of using a search pipeline with a `filter_query` processor, see [`filter_query` processor example]({{site.url}}{{site.baseurl}}/search-plugins/search-pipelines/filter-query-processor#example). ## Using a temporary search pipeline for a request +1. You can provide a search pipeline id in the search request: -As an alternative to creating a search pipeline, you can define a temporary search pipeline to be used for only the current query: +```json +GET /my-index/_search +{ + "query": { + "match_all": {} + }, + "from": 0, + "size": 10, + "search_pipeline": "my_pipeline" +} +``` + +or for msearch +```json +GET /_msearch +{ "index": "test"} +{ "query": { "match_all": {} }, "from": 0, "size": 10, "search_pipeline": "my_pipeline"} +{ "index": "test-1", "search_type": "dfs_query_then_fetch"} +{ "query": { "match_all": {} }, "search_pipeline": "my_pipeline1" } + +``` +{% include copy-curl.html %} + +2. As an alternative to creating a search pipeline, you can define a temporary search pipeline to be used for only the current query: ```json POST /my-index/_search From cbcd31d66b6938a9e1c386f4e953126c5b57095e Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Thu, 26 Sep 2024 11:18:44 -0400 Subject: [PATCH 2/2] Doc review Signed-off-by: Fanit Kolchina --- .../search-pipelines/using-search-pipeline.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/_search-plugins/search-pipelines/using-search-pipeline.md b/_search-plugins/search-pipelines/using-search-pipeline.md index 30ff32c06da..b6dbbdc5d0d 100644 --- a/_search-plugins/search-pipelines/using-search-pipeline.md +++ b/_search-plugins/search-pipelines/using-search-pipeline.md @@ -17,17 +17,20 @@ You can use a search pipeline in the following ways: ## Specifying an existing search pipeline for a request -After you [create a search pipeline]({{site.url}}{{site.baseurl}}/search-plugins/search-pipelines/creating-search-pipeline/), you can use the pipeline with a query by specifying the pipeline name in the `search_pipeline` query parameter: +After you [create a search pipeline]({{site.url}}{{site.baseurl}}/search-plugins/search-pipelines/creating-search-pipeline/), you can use the pipeline with a query in the following ways. For a complete example of using a search pipeline with a `filter_query` processor, see [`filter_query` processor example]({{site.url}}{{site.baseurl}}/search-plugins/search-pipelines/filter-query-processor#example). + +### Specifying the pipeline in a query parameter + +You can specify the pipeline name in the `search_pipeline` query parameter as follows: ```json GET /my_index/_search?search_pipeline=my_pipeline ``` {% include copy-curl.html %} -For a complete example of using a search pipeline with a `filter_query` processor, see [`filter_query` processor example]({{site.url}}{{site.baseurl}}/search-plugins/search-pipelines/filter-query-processor#example). +### Specifying the pipeline in the request body -## Using a temporary search pipeline for a request -1. You can provide a search pipeline id in the search request: +You can provide a search pipeline ID in the search request body as follows: ```json GET /my-index/_search @@ -40,8 +43,10 @@ GET /my-index/_search "search_pipeline": "my_pipeline" } ``` +{% include copy-curl.html %} + +For multi-search, you can provide a search pipeline ID in the search request body as follows: -or for msearch ```json GET /_msearch { "index": "test"} @@ -52,7 +57,9 @@ GET /_msearch ``` {% include copy-curl.html %} -2. As an alternative to creating a search pipeline, you can define a temporary search pipeline to be used for only the current query: +## Using a temporary search pipeline for a request + +As an alternative to creating a search pipeline, you can define a temporary search pipeline to be used for only the current query: ```json POST /my-index/_search