Terms enum API

Terms enum API

The terms enum API can be used to discover terms in the index that match a partial string. Supported field types are keyword, constant_keyword and flattened. This is used for auto-complete:

  1. POST stackoverflow/_terms_enum
  2. {
  3.     "field" : "tags",
  4.     "string" : "kiba"
  5. }

The API returns the following response:

  1. {
  2.   "_shards": {
  3.     "total": 1,
  4.     "successful": 1,
  5.     "failed": 0
  6.   },
  7.   "terms": [
  8.     "kibana"
  9.   ],
  10.   "complete" : true
  11. }

If the complete flag is false, the returned terms set may be incomplete and should be treated as approximate. This can occur due to a few reasons, such as a request timeout or a node error.

Request

GET /<target>/_terms_enum

Description

The terms_enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios.

Path parameters

<target>

(Required, string) Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*). To search all data streams or indices, omit this parameter or use * or _all.

Request body

field

(Mandatory, string) Which field to match

string

(Optional, string) The string to match at the start of indexed terms. If not provided, all terms in the field are considered.

size

(Optional, integer) How many matching terms to return. Defaults to 10

timeout

(Optional, time value) The maximum length of time to spend collecting results. Defaults to “1s” (one second). If the timeout is exceeded the complete flag set to false in the response and the results may be partial or empty.

case_insensitive

(Optional, boolean) When true the provided search string is matched against index terms without case sensitivity. Defaults to false.

index_filter

(Optional, query object Allows to filter an index shard if the provided query rewrites to match_none.

search_after

(Optional, string) The string after which terms in the index should be returned. Allows for a form of pagination if the last result from one request is passed as the search_after parameter for a subsequent request.