Highlighting Methods

Two different highlighting methods are supported and can be used depending on data available:

  1. Highlight document using a search query
    In this case, Highlighter takes the user's query string and finds hits to highlight using internal search engine. Typically, you would use this method when integrating with Elasticsearch or Apache Solr based search solutions.

  2. Highlight document using PDF highlight file
    In this case, terms in PDF are highlighted using position of text in the document. This is the recommended approach if your search tool can generate highlighting files compatible with Adobe’s PDF Highlight File Format; that way, the PDF will have marked the exact terms as found by the search engine. Use this method when integrating with dtSearch based search solutions or NLP tools.

API Documentation

For web service API documentation and all available options, open home URL of your local Highlighter installation http://localhost:8998/ or online at


Self-hosted PDF Highlighter installation comes with a set of examples that you can try at http://localhost:8998/examples/.

Throughout this guide in examples we reference our cloud based Highlighter at or For a self-hosted Highlighter instance, replace this URL with the one pointing to your Highlighter instance (e.g. http://localhost:8998/).

comments powered by Disqus