This version of the OpenSearch documentation is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Search processors

Search processors can be of the following types:

Search request processors

A search request processor intercepts a search request (the query and the metadata passed in the request), performs an operation with or on the search request, and submits the search request to the index.

The following table lists all supported search request processors.

ProcessorDescriptionEarliest available version
scriptAdds a script that is run on newly indexed documents.2.8
filter_queryAdds a filtering query that is used to filter requests.2.8

Search response processors

A search response processor intercepts a search response and search request (the query, results, and metadata passed in the request), performs an operation with or on the search response, and returns the search response.

The following table lists all supported search response processors.

ProcessorDescriptionEarliest available version
rename_fieldRenames an existing field.2.8
personalize_search_rankingUses Amazon Personalize to rerank search results (requires setting up the Amazon Personalize service).2.9

Search phase results processors

A search phase results processor runs between search phases at the coordinating node level. It intercepts the results retrieved from one search phase and transforms them before passing them to the next search phase.

The following table lists all supported search phase results processors.

ProcessorDescriptionEarliest available version
normalization-processorIntercepts the query phase results and normalizes and combines the document scores before passing the documents to the fetch phase.2.10

Viewing available processor types

You can use the Nodes Search Pipelines API to view the available processor types:

  1. GET /_nodes/search_pipelines

copy

The response contains the search_pipelines object that lists the available request and response processors:

Response

  1. {
  2.   "_nodes" : {
  3.     "total" : 1,
  4.     "successful" : 1,
  5.     "failed" : 0
  6.   },
  7.   "cluster_name" : "runTask",
  8.   "nodes" : {
  9.     "36FHvCwHT6Srbm2ZniEPhA" : {
  10.       "name" : "runTask-0",
  11.       "transport_address" : "127.0.0.1:9300",
  12.       "host" : "127.0.0.1",
  13.       "ip" : "127.0.0.1",
  14.       "version" : "3.0.0",
  15.       "build_type" : "tar",
  16.       "build_hash" : "unknown",
  17.       "roles" : [
  18.         "cluster_manager",
  19.         "data",
  20.         "ingest",
  21.         "remote_cluster_client"
  22.       ],
  23.       "attributes" : {
  24.         "testattr" : "test",
  25.         "shard_indexing_pressure_enabled" : "true"
  26.       },
  27.       "search_pipelines" : {
  28.         "request_processors" : [
  29.           {
  30.             "type" : "filter_query"
  31.           },
  32.           {
  33.             "type" : "script"
  34.           }
  35.         ],
  36.         "response_processors" : [
  37.           {
  38.             "type" : "rename_field"
  39.           }
  40.         ]
  41.       }
  42.     }
  43.   }
  44. }

In addition to the processors provided by OpenSearch, additional processors may be provided by plugins.