[SOLR-11801] support customisation of the "highlighting" query response element

• Type: New Feature
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 7.3, 8.0
• Component/s: highlighter
• Assignee: Christine Poerschke
• Reporter: Christine Poerschke
• Created: 28/Dec/17 17:43
• Updated: 28/Aug/18 13:47
• Resolved: 04/Jan/18 15:20

Description

The objective and use case behind the proposed changes is to be able to receive not the out-of-the-box highlighting map

{
  ...
  "highlighting" : {
    "MA147LL/A" : {
      "manu" : [
        "<em>Apple</em> Computer Inc."
      ]
    }
  }
}

as illustrated in https://lucene.apache.org/solr/guide/7_2/highlighting.html#highlighting-in-the-query-response but to be able to alternatively name and customise the highlighting element of the query response to (for example) be like this

{
  ...
  "custom_highlighting" : [
    {
      "id" : "MA147LL/A",
      "snippets" : {
        "manu" : [
          "<em>Apple</em> Computer Inc."
        ]
      }
    }
  ]
}

where the highlighting element itself is a list and where the keys of each list element are 'knowable' in advance i.e. they are not 'unknowable' document ids.

Issue Links

• is related to: SOLR-12706 CloudSolrClient NPE exception when NOT directUpdatesToLeadersOnly
• is related to: SOLR-1954 Highlighter component should expose snippet character offsets and the score.