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

Neural query enricher processor

The neural_query_enricher search request processor is designed to set a default machine learning (ML) model ID at the index or field level for neural search queries. To learn more about ML models, see Using ML models within OpenSearch and Connecting to remote models.

Request fields

The following table lists all available request fields.

Example

The following example request creates a search pipeline with a neural_query_enricher search request processor. The processor sets a default model ID at the index level and provides different default model IDs for two specific fields in the index:

PUT /_search/pipeline/default_model_pipeline 
{
  "request_processors": [
    {
      "neural_query_enricher" : {
        "tag": "tag1",
        "description": "Sets the default model ID at index and field levels",
        "default_model_id": "u5j0qYoBMtvQlfhaxOsa",
        "neural_field_default_id": {
           "my_field_1": "uZj0qYoBMtvQlfhaYeud",
           "my_field_2": "upj0qYoBMtvQlfhaZOuM"
        }
      }
    }
  ]
}