Elasticsearch/Solr Sandbox for exploring explain information and tweaking
JavaScript HTML CSS
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


The Splainer!

Build Status

The sandbox that explains your search results for you so you don't have to go digging through explain debug! Paste in your Solr URL and go. Try it out here.


You're a search developer trying to tune search results with Solr. You're engaged in search relevancy work.

You're probably stuck with the question of why? Why do search results come back in the order that they do? Solr/Lucene exposes an explain syntax for you to try to explain search scoring. Unfortunately outside the simplest tasks, its a nightmare to read through. There are parsers like explain.solr.pl but they require a lot of manual copy/pasting of explain information to the tool.

Splainer is different by being a sandbox. Paste in your Solr URL, query parameters and all. As you work with your query, changing parameters, Splainer shows you parsed and summarized explain information alongside your documents. Continue working and see how the search results change.

Read the blog post introducing Splainer here

Splainer forms the core of our product Quepid that allows you to do this over multiple queries against expert-graded search results to track search changes over a longer period of time.

Using Splainer

Take the tour to see how you'd use Splainer.

If you want to work locally, we have a Docker image

docker run -d -p 9000:9000 o19s/splainer and then go to http://localhost:9000

Running the code

Npm/Bower Dev Environment

Splainer is written using AngularJS project. It requires npm, grunt, and bower.

Be sure you've installed npm, bower, and grunt on your machine.

Use npm to install Grunt and Bower globally on your system (may require sudo)

npm install -g grunt-cli
npm install -g bower

With Npm/Bower installed

From the root of the project, you should be able to run the following:

npm install
bower install
grunt serve

To build the project, simply run "grunt" static build artifacts will be placed in the dist/ folder


With Docker installed

From the root of the project, you should run:

docker build -t splainer  .


Created by OpenSource Connections


Released under Apache 2