opensearch-docs-cn/_search-plugins/search-pipelines/retrieving-search-pipeline.md
kolchfa-aws 06527a2772
Add documentation about setting a default model for neural search (#5121)
* Add documentation about setting a default model for neural search

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add new processor to the processor list

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* More tweaks

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Refactor search pipeline documentation

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Refactor retrieving search pipelines

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add working examples

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Implement tech review comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add responses to documentation

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Update _search-plugins/search-pipelines/neural-query-enricher.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-10-04 13:35:37 -04:00

1.2 KiB

layout title nav_order has_children parent grand_parent
default Retrieving search pipelines 25 false Search pipelines Search

Retrieving search pipelines

To retrieve the details of an existing search pipeline, use the Search Pipeline API.

To view all search pipelines, use the following request:

GET /_search/pipeline

{% include copy-curl.html %}

The response contains the pipeline that you set up in the previous section:

Response {: .text-delta}
{
  "my_pipeline" : {
    "request_processors" : [
      {
        "filter_query" : {
          "tag" : "tag1",
          "description" : "This processor is going to restrict to publicly visible documents",
          "query" : {
            "term" : {
              "visibility" : "public"
            }
          }
        }
      }
    ]
  }
}

To view a particular pipeline, specify the pipeline name as a path parameter:

GET /_search/pipeline/my_pipeline

{% include copy-curl.html %}

You can also use wildcard patterns to view a subset of pipelines, for example:

GET /_search/pipeline/my*

{% include copy-curl.html %}