Założenia

W chwili obecnej serwis analizuje zapytania Solr w wersji 3.x i jest przygotowywany pod wersję 4.0.

Wizualizacja danych explain

W chwili obecnej serwis wizualizuje wartości score osiągnięte przez znalezione dokumenty.

Aby dodać nowy explain i zobaczyć jego wizualizację należy dodać do zapytania parametr debugQuery=on, a następnie wkleić dane zwrócone przez Solr do okna aplikacji explain.solr.pl (w przypadku przeglądarki wklejamy zawartość źródła strony). Naciśnięcie przycisku „Create explain” spowoduje dodanie nowego explain’a i pokazanie strony z wizualizacją. W chwili obecnej aplikacja explain.solr.pl obsługuje jedynie dane w formacie XML, należy więc przekazać w zapytaniu parametr wt=xml lub nie przekazywać go w ogóle.

Istnieje również możliwość weryfikacji trafień dla dowolnych, innych dokumentów (podanych przez parametr explainOther zapytania). Przydatne jest to np. w sytuacji sprawdzania, dlaczego w wyniku nie pojawił się dany dokument.

Dostępne informacje

Po stworzeniu nowej wizualizacji danych explain, dostępny jest szereg informacji. Dane na temat zapytania, pokazywane są raz dla całego explain’a, reszta informacji pokazywana jest dla każdego z dokumentów, którego dotyczy.

Dane na temat zapytania

W tej części explain.solr.pl widoczne są:

1. Identyfikator wygenerowanego explain’a.
2. Informacja o tym, iż nie wykorzystano parametru debugOther.
3. Zapytanie.
4. Informacja o tym, iż explain widoczny jest w zakładce „history„.

Widoczne w wynikach wyszukiwania pola

W tej części explain.solr.pl dostępna jest informacja na temat pól, które dostępne były w wynikach wyszukiwania.

Wizualizacja wpływu poszczególnych elementów na score

Widoczne w tej części explain.solr.pl informacje to:

1. Procentowy wpływ poszczególnych wartości na ogólną wartość score dokumentu.
2. Wykres kołowy wizualizujący dane widoczne w lewej kolumnie.

Powrót do już dodanego explain’a

W celu powrotu do już dodanego explain’a należy wejść na stronę: http://explain.solr.pl/explains/EXPLAIN_ID, gdzie EXPLAIN_ID jest unikalnym identyfikatorem, który podawany jest podczas stworzenia explaina. Jeżeli nie pamiętasz identyfikatora wcześniej dodanego explain’a należy odnaleźć odpowiedni explain w zakładce „history„.

Ukrywanie swojego explain’a

Aby Twój explain nie był widoczny w historii dodanych explainów należy podczas dodawania nowego explain’a odznaczyć opcję „I want this explain to be visible on history page„. Należy jednak pamiętać, że aby wrócić do explain’a, który nie jest dostępny publicznie należy pamiętać jego identyfikator.

Zgłaszanie błędów

Aby zgłosić błąd który znalazło się w aplikacji explain.solr.pl, prosimy o stworzenie zgłoszenia na https://github.com/solrpl/explain lub wysłanie maila na explain(at)solr(dot)pl.

Prośba

Mamy także małą prośbę, jeżeli macie jakieś uwagi, trafiliście na błąd lub chcielibyście jakąś nową funkcjonalność prosimy piszcie na explain(at)solr(dot)pl. Pozwoli nam to na lepsze dostosowanie explain.solr.pl do Waszych potrzeb.

Coś na koniec

Na sam koniec chcielibyśmy pokazać, jak wyglądał proces tworzenia kodu http://explain.solr.pl wizualizowany przy użyciu narzędzia gsource. Miłego oglądania.