Search-as-you-type field type

    Mapping a search-as-you-type field creates n-gram subfields of this field, where n is in the range [2, ]. Additionally, it creates an index prefix subfield.

    Create a mapping with a search-as-you-type field:

    copy

    In addition to the suggestions field, this creates suggestions._2gram, suggestions._3gram, and suggestions._index_prefix fields.

    Index a document with a search-as-you-type field:

    1. PUT books/_doc/1
    2. {
    3.   "suggestions": "one two three four"
    4. }

    To match terms in any order, use a bool_prefix or multi-match query. These queries rank the documents in which search terms are in the specified order higher than the documents in which terms are out of order.

    copy

    The response contains the matching document:

    1. {
    2.   "took" : 13,
    3.   "timed_out" : false,
    4.   "_shards" : {
    5.     "total" : 1,
    6.     "successful" : 1,
    7.     "skipped" : 0,
    8.     "failed" : 0
    9.   },
    10.   "hits" : {
    11.     "total" : {
    12.       "value" : 1,
    13.       "relation" : "eq"
    14.     },
    15.     "max_score" : 1.0,
    16.     "hits" : [
    17.       {
    18.         "_index" : "books",
    19.         "_type" : "_doc",
    20.         "_id" : "1",
    21.         "_score" : 1.0,
    22.         "_source" : {
    23.           "suggestions" : "one two three four"
    24.       }
    25.     ]
    26.   }
    27. }

    To match terms in order, use a match_phrase_prefix query:

    copy

    1. {
    2.   "took" : 23,
    3.   "timed_out" : false,
    5.     "total" : 1,
    6.     "successful" : 1,
    7.     "skipped" : 0,
    8.     "failed" : 0
    9.   },
    10.   "hits" : {
    11.     "total" : {
    12.       "value" : 1,
    13.       "relation" : "eq"
    14.     },
    15.     "max_score" : 0.4793051,
    16.     "hits" : [
    17.       {
    18.         "_index" : "books",
    19.         "_type" : "_doc",
    20.         "_id" : "1",
    21.         "_score" : 0.4793051,
    22.         "_source" : {
    23.           "suggestions" : "one two three four"
    24.         }
    25.       }
    26.   }
    27. }

    To match the last terms exactly, use a match_phrase query:

    copy

    Response:

    1. {
    2.   "took" : 2,
    3.   "timed_out" : false,
    4.   "_shards" : {
    5.     "total" : 1,
    6.     "successful" : 1,
    7.     "skipped" : 0,
    8.     "failed" : 0
    9.   },
    10.   "hits" : {
    11.     "total" : {
    12.       "value" : 1,
    13.       "relation" : "eq"
    14.     },
    15.     "max_score" : 0.2876821,
    17.       {
    18.         "_index" : "books",
    19.         "_type" : "_doc",
    20.         "_id" : "1",
    21.         "_score" : 0.2876821,
    22.         "_source" : {
    23.           "suggestions" : "one two three four"
    24.         }
    25.       }
    26.     ]
    27.   }

    Parameters

    The following table lists the parameters accepted by search-as-you-type field types. All parameters are optional.