Standard retriever

A standard retriever returns top documents from a traditional query.

query

(Optional, query object)

Defines a query to retrieve a set of top documents.

filter

(Optional, query object or list of query objects)

Applies a boolean query filter to this retriever, where all documents must match this query but do not contribute to the score.

search_after

(Optional, search after object)

Defines a search after object parameter used for pagination.

terminate_after

(Optional, integer) Maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting.

Important

Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.

sort

(Optional, sort object) A sort object that specifies the order of matching documents.

min_score

(Optional, float)

Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.

collapse

(Optional, collapse object)

Collapses the top documents by a specified key into a single top document per key.

When a retriever tree contains a compound retriever (a retriever with two or more child retrievers) the search after parameter is not supported.

GET /restaurants/_search
{
  "retriever": {
    "standard": {
      "query": {
        "bool": {
          "should": [
            {
              "match": {
                "region": "Austria"
              }
            }
          ],
          "filter": [
            {
              "term": {
                "year": "2019"
              }
            }
          ]
        }
      }
    }
  }
}

1. Opens the retriever object.
2. The standard retriever is used for defining traditional Elasticsearch queries.
3. The entry point for defining the search query.
4. The bool object allows for combining multiple query clauses logically.
5. The should array indicates conditions under which a document will match. Documents matching these conditions will have increased relevancy scores.
6. The match object finds documents where the region field contains the word "Austria."
7. The filter array provides filtering conditions that must be met but do not contribute to the relevancy score.
8. The term object is used for exact matches, in this case, filtering documents by the year field.
9. The exact value to match in the year field.