elasticsearchelasticsearch-2.0elasticsearch-7

How do I get Elasticsearch to highlight a partial word from a search_as_you_type field?


I'm having trouble setting up a search_as_you_type field with highlighting following the guide here https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-as-you-type.html

I'll leave a series of commands to reproduce what I'm seeing. Hopefully somebody can weigh in on what I'm missing :)

  1. create mapping
PUT /test_index
{
  "mappings": {
    "properties": {
      "plain_text": {
        "type": "search_as_you_type",
        "index_options": "offsets",
        "term_vector": "with_positions_offsets"
      }
    }
  }
}
  1. insert document
POST /test_index/_doc
{
  "plain_text": "This is some random text"
}
  1. search for document
GET /snippets_test/_search
{
  "query": {
    "multi_match": {
      "query": "rand",
      "type": "bool_prefix",
      "fields": [
        "plain_text",
        "plain_text._2gram",
        "plain_text._3gram",
        "plain_text._index_prefix"
      ]
    }
  },
  "highlight" : {
    "fields" : [
      {
        "plain_text": {
          "number_of_fragments": 1,
          "no_match_size": 100
        } 
      }
    ]
  }
}
  1. response
{
  "took" : 1,
  "timed_out" : false,
  "_shards" : {
    "total" : 1,
    "successful" : 1,
    "skipped" : 0,
    "failed" : 0
  },
  "hits" : {
    "total" : {
      "value" : 1,
      "relation" : "eq"
    },
    "max_score" : 1.0,
    "hits" : [
      {
        "_index" : "test_index",
        "_type" : "_doc",
        "_id" : "rLZkjm8BDC17cLikXRbY",
        "_score" : 1.0,
        "_source" : {
          "plain_text" : "This is some random text"
        },
        "highlight" : {
          "plain_text" : [
            "This is some random text"
          ]
        }
      }
    ]
  }
}

The response I get back does not have the highlighting I expect Idealy the highlight is: This is some <em>ran</em>dom text


Solution

  • In order to achieve highlighting of n-grams (chars) you'll need:

    Here's the configuration:

    {
      "settings": {
        "analysis": {
          "analyzer": {
            "partial_words" : {
              "type": "custom",
              "tokenizer": "ngrams",
              "filter": ["lowercase"]
            }
          },
          "tokenizer": {
            "ngrams": {
              "type": "ngram",
              "min_gram": 3,
              "max_gram": 4
            }
          }
        }
      },
      "mappings": {
        "properties": {
          "plain_text": {
            "type": "text",
            "fields": {
              "shingles": { 
                "type": "search_as_you_type"
              },
              "ngrams": {
                "type": "text",
                "analyzer": "partial_words",
                "search_analyzer": "standard",
                "term_vector": "with_positions_offsets"
              }
            }
          }
        }
      }
    }
    

    the query:

    {
      "query": {
        "multi_match": {
          "query": "rand",
          "type": "bool_prefix",
          "fields": [
            "plain_text.shingles",
            "plain_text.shingles._2gram",
            "plain_text.shingles._3gram",
            "plain_text.shingles._index_prefix",
            "plain_text.ngrams"
          ]
        }
      },
      "highlight" : {
        "fields" : [
          {
            "plain_text.ngrams": { } 
          }
        ]
      }
    }
    

    and the result:

        "hits": [
            {
                "_index": "test_index",
                "_type": "_doc",
                "_id": "FkHLVHABd_SGa-E-2FKI",
                "_score": 2,
                "_source": {
                    "plain_text": "This is some random text"
                },
                "highlight": {
                    "plain_text.ngrams": [
                        "This is some <em>rand</em>om text"
                    ]
                }
            }
        ]
    

    Note: in some cases, this config might be expensive for memory usage and storage.