Completion field type

Completion field type

To use the completion suggester, map the field from which you want to generate suggestions as type completion. This indexes the field values for fast completions.

  1. resp = client.indices.create(
  2.     index="music",
  3.     mappings={
  4.         "properties": {
  5.             "suggest": {
  6.                 "type": "completion"
  7.             }
  8.         }
  9.     },
  10. )
  11. print(resp)
  1. response = client.indices.create(
  2.   index: 'music',
  3.   body: {
  4.     mappings: {
  5.       properties: {
  6.         suggest: {
  7.           type: 'completion'
  8.         }
  9.       }
  10.     }
  11.   }
  12. )
  13. puts response
  1. const response = await client.indices.create({
  2.   index: "music",
  3.   mappings: {
  4.     properties: {
  5.       suggest: {
  6.         type: "completion",
  7.       },
  8.     },
  9.   },
  10. });
  11. console.log(response);
  1. PUT music
  2. {
  3.   "mappings": {
  4.     "properties": {
  5.       "suggest": {
  6.         "type": "completion"
  7.       }
  8.     }
  9.   }
  10. }

Parameters for completion fields

The following parameters are accepted by completion fields:

analyzer

The index analyzer to use, defaults to simple.

search_analyzer

The search analyzer to use, defaults to value of analyzer.

preserve_separators

Preserves the separators, defaults to true. If disabled, you could find a field starting with Foo Fighters, if you suggest for foof.

preserve_position_increments

Enables position increments, defaults to true. If disabled and using stopwords analyzer, you could get a field starting with The Beatles, if you suggest for b. Note: You could also achieve this by indexing two inputs, Beatles and The Beatles, no need to change a simple analyzer, if you are able to enrich your data.

max_input_length

Limits the length of a single input, defaults to 50 UTF-16 code points. This limit is only used at index time to reduce the total number of characters per input string in order to prevent massive inputs from bloating the underlying datastructure. Most use cases won’t be influenced by the default value since prefix completions seldom grow beyond prefixes longer than a handful of characters.