2.8 KiB
2.8 KiB
layout | title | nav_order | has_children | parent | grand_parent |
---|---|---|---|---|---|
default | Search processors | 50 | true | Search pipelines | Search |
Search processors
Search processors can be of the following types:
Search request processors
The following table lists all supported search request processors.
Processor | Description | Earliest available version |
---|---|---|
script |
Adds a script that is run on newly indexed documents. | 2.8 |
filter_query |
Adds a filtering query that is used to filter requests. | 2.8 |
Search response processors
The following table lists all supported search response processors.
Processor | Description | Earliest available version |
---|---|---|
rename_field |
Renames an existing field. | 2.8 |
personalize_search_ranking |
Uses Amazon Personalize to rerank search results (requires setting up the Amazon Personalize service). | 2.9 |
Viewing available processor types
You can use the Nodes Search Pipelines API to view the available processor types:
GET /_nodes/search_pipelines
{% include copy-curl.html %}
The response contains the search_pipelines
object that lists the available request and response processors:
Response
{: .text-delta}{
"_nodes" : {
"total" : 1,
"successful" : 1,
"failed" : 0
},
"cluster_name" : "runTask",
"nodes" : {
"36FHvCwHT6Srbm2ZniEPhA" : {
"name" : "runTask-0",
"transport_address" : "127.0.0.1:9300",
"host" : "127.0.0.1",
"ip" : "127.0.0.1",
"version" : "3.0.0",
"build_type" : "tar",
"build_hash" : "unknown",
"roles" : [
"cluster_manager",
"data",
"ingest",
"remote_cluster_client"
],
"attributes" : {
"testattr" : "test",
"shard_indexing_pressure_enabled" : "true"
},
"search_pipelines" : {
"request_processors" : [
{
"type" : "filter_query"
},
{
"type" : "script"
}
],
"response_processors" : [
{
"type" : "rename_field"
}
]
}
}
}
}
In addition to the processors provided by OpenSearch, additional processors may be provided by plugins. {: .note}