Elasticsearch. Highlight search results

July 1, 2016 24 Yehor Rykhnov

Elasticsearch. Part 6, highlighting search results in Elasticsearch. Previous part: Elasticsearch. Full-text search.

Often the need to allocate a search phrase in the search results. Elasticsearch has built-in mechanisms for the selection and framing of the search result to HTML tags. An example of the highlighting of search results in Elasticsearch using CURL, PHP and Yii2.

Highlight of tags search results.

Command:

  1. GET /megacorp/employee/_search
    {
  2.     "query" : 
  3.     {    
  4.         "match_phrase" : 
  5.         {    
  6.             "about" : "rock climbing"
  7.         }
  8.     },
  9.     "highlight": 
  10.     {
  11.         "fields" : 
  12.         {    
  13.             "about" : {}
  14.         }
  15.     }
  16. }

Highlighting of search results in CURL:

  1. $curl -XPOST 'localhost:9200/megacorp/employee/_search?pretty' -d '
  2. {
  3.     "query" : 
  4.     {
  5.         "match_phrase" : 
  6.         {
  7.             "about" : "rock climbing"
  8.         }
  9.     },
  10.     "highlight": 
  11.     {
  12.         "fields" : 
  13.         {
  14.             "about" : {}
  15.         }
  16.     }
  17. }'

Highlighting of search results in PHP:

  1. require '../vendor/autoload.php';
  2. $client = Elasticsearch\ClientBuilder::create()->build();
  3. $params = [
  4.             'index' => 'megacorp',
  5.             'type'  => 'employee',
  6.             'body'  => [
  7.                 'query' => [
  8.                     'match' => [
  9.                         "about" => "rock climbing"
  10.                     ],                
  11.         ], 
  12.         'highlight' => [
  13.                     "pre_tags"  => "<em>",
  14.                     "post_tags" => "</em>",
  15.                     'fields'    => [
  16.                        'about' => new \stdClass()
  17.                     ]
  18.                 ],
  19.             ]
  20.         ];
  21. try {            
  22.     $response = $client->search($params);
  23. } catch (Exception $e) {            
  24.     var_dump($e->getMessage());        
  25. }
  26. var_dump($response);

'about' => new \stdClass() - stdClass it is used for the proper formation of JSON.

Highlighting of search results in Yii2:

  1. $params = [
  2.             'match' => [
  3.                 "about" => "rock climbing"
  4.             ]
  5.         ];
  6. $model = Megacorp::find()
  7.                 ->query($params)
  8.                 ->highlight([
  9.                     "pre_tags"  => "<em>",
  10.                     "post_tags" => "</em>",
  11.                     'fields'    => [
  12.                         'about' => new \stdClass()
  13.                     ]
  14.                 ])
  15.                 ->all();
  16. var_dump($model);

Additionally

Detailed documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-highlighting.html

Yii Framework 2,  yii2,  PHP,  Elasticsearch