IT eSky.pl

RSS

Serwis autocomplete z użyciem Elasticsearch krok po kroku – część 2/3

Wstęp

Pierwsza część niniejszej serii traktowała o podstawach pracy z Elasticsearch, w kontekście tworzenia systemu podpowiadania wpisywanych fraz. Powstało spójne środowisko z użyciem dockera, oraz omówione zostały podstawowe sposoby konstruowania zapytań do Elasticsearch. Bazując na tej wiedzy można zacząć tworzyć bardziej skomplikowane zapytania, które w większym lub mniejszym stopniu przybliżać będą nas do realizacji mechanizmu podpowiadania wpisanych fraz. Proces powstawania tego mechanizmu został podzielony na iteracje, w każdej z nich przedstawiona zostanie część problemu wraz z proponowanym jego rozwiązaniem. Jeżeli nie zaznaczono inaczej to przykłady operują na danych z poprzedniego wpisu.

Autocomplete iteracja 1: Dopasowanie wildcard

Celem powstania aplikacji jest umożliwienie podpowiadania nazw lotnisk na podstawie fragmentu wpisanego przez użytkownika. Na początek chcemy dopasowywać te lotniska, których nazwa zaczyna się wpisaną przez użytkownika frazą. Rozwiązaniem, które samo się nasuwa jest stworzenie zapytania, które w pewien sposób dopasowuje dane z użyciem wildcarda.

Pośród zaindeksowanych danych znajdują się Strachowice i Stansted, zakładamy że użytkownik wpisał frazę St.

Niestety odpowiedź zawiera zero dopasowanych dokumentów.

Powtórzmy to samo zapytanie, tym razem pytając o ciąg zawierający tylko małe litery.

W tym przypadku odpowiedź zawiera oba lotniska pasujące do wzorca.

By wyjaśnić dlaczego tak się dzieje sięgnijmy do dokumentacji Elasticsearch. Przeczytać tam można że zapytanie typu wildcard dopasowuje wyniki nie analizując ich. Domyślnie jednak pola tekstowe w Elasticsearch są analizowane przy użyciu standardowego analizera. Standardowy analizer zaś składa się ze standardowego tokenizera oraz standardowych filtrów, w tym filtra lowercase. Wyjaśniając, oznacza to że podczas zapytania wpisana fraza nie jest w żaden sposób analizowana, jednak przy wprowadzaniu (indeksacji) danych, zostały one w standardowy dla Elasticsearch sposób przeanalizowane. Między innymi wykonano na nich operacje sprowadzania do tylko małych liter. Elasticsearch posiada wbudowany mechanizm wizualizacji analizowania danych, endpoint _analyze:

By wykonać analizę tekstu Wrocław Strachowice używając standardowego analizera należy wykonać request

Odpowiedź zawiera listę wygenerowanych dla tego tekstu tokenów:

Podczas indeksacji tekst Wrocław Strachowice został przetworzony w ten sposób, że powstały dwa tokeny wrocław i strachowice. Wyjaśnia to dlaczego nie znaleziono wyników dla zapytania o lotniska zaczynające się od frazy St.

Warto zapamiętać:

  • analiza danych w Elasticsearch może następować zarówno podczas indeksacji jak i wyszukiwania
  • niektóre zapytania (na przykład wildcard) operują na nie analizowanych danych
  • domyślnie podczas indeksacji dane są analizowane przy użyciu standardowego analizera
  • poprzez endpoint _analyze można przeprowadzić analizę tekstu z użyciem wybranego analizera

Autocomplete iteracja 2: Brak analizy podczas indeksacji

Domyślnie Elasticsearch analizuje wprowadzane dane w standardowy sposób, w tym przypadku jest to działanie niepożądane. By to zmienić należy wrócić do momentu tworzenia indeksu. Wiadomo że Elasticsearch potrafi sam stworzyć mapowanie pól w typie na podstawie wprowadzanych danych. Wymusić sposób ich mapowania można tworząc model mapowania podczas tworzenia typu, tak jak robi się to w relacyjnych bazach danych. Przykładowy mapping dla typu airport z jednym polem name, które nie będzie analizowane podczas indeksacji wygląda jak poniżej:

By upewnić się że operacja przebiegła poprawnie można sprawdzić mapowanie zapytaniem zapytaniu

Pole name pozostanie nie analizowane. Reszta pól, tak jak poprzednio zostanie utworzona automatycznie. Po załadowaniu danych jak poprzednio, pamiętając o zmianie docelowego indeksu na airports_2 sprawdźmy czy teraz zapytanie typu wildcard zadziała dla obu przypadków:

Odpowiedź wygląda zgodnie z oczekiwaniami:

Jednak w aktualnej konfiguracji fraza wpisana małymi literami nie zwróci wyników. Dzieje się tak dlatego że dane w indeksie nie są w żaden sposób analizowane, więc zachowana jest ich oryginalna pisownia.

Warto zapamiętać:

  • mapowanie pól można wymusić podczas tworzenia typu w indeksie
  • zapytanie typu wildcard nie jest dobrym wyborem, gdy chcemy wyszukiwać ignorując wielkość liter

Autocomplete iteracja 3: Inne sposoby wyszukiwania

Rozwiązanie z użyciem zapytania typu wildcard okazało się być problematycznym, gdyż dane mają różną wielkość liter. Wiadomo że dane przy dodawaniu są analizowane, rozbijane na tokeny i wykonywane na nich są pewne standardowe operacje, jak zmiana na małe litery. Wiadomo że poza wyjątkami jak wildcard Elasticsearch wykonuje operacje wyszukiwania na właśnie tych tokenach. Wiemy jak sprawdzić jakie tokeny zostały wygenerowane dla danego tekstu. Wracając do lotniska we Wrocławiu, z nazwy Strachowice powstaje token strachowice i na nim wykonywane są operacje wyszukiwania. Wyszukiwanie pełnotekstowe, które wykonywane jest w Elasticsearch polega na dokładnym dopasowaniu tokenów. By wynik został dopasowany, muszą istnieć tokeny równe tokenom powstałym z szukanego tekstu. W aktualnej konfiguracji nie jest możliwe dopasowanie po części wpisanego słowa. Nie istnieje token strach dla frazy strachowice. By przeprowadzać takie operacje należy wygenerować tokeny będące podciągami szukanego tekstu. Wracając do dokumentacji, przeczytać w niej możemy że: An analyzer of type standard is built using the Standard Tokenizer with the Standard Token Filter, Lower Case Token Filter, and Stop Token Filter. Wnioskiem z tego jest że proces analizy tekstu w ElasticSearch składa się z etapu tokenizacji i filtrowania.

By sprawdzić zachowanie standardowego tokenizera należy wykonać zapytanie:

Odpowiedź:

Standardowy tokenizer dla frazy Strachowice wygenerował tylko jeden token Strachowice. Token zawiera wielkie litery ponieważ jeszcze nie został na nim wykonany filtr lowercase.

Celem jest wygenerowanie większej ilości tokenów, zawierających podciągi zadanego tekstu. Osiągnąć to można przy pomocy filtra nGram, który generuje n-gramy, czyli podciągi danego ciągu. By sprawdzić zachowanie tokenizera typu nGram należy wykonać:

Rezultatem jest lista tokenów, powstała poprzez podzielenie zadanego tekstu na podciągi o długości od 1 do 2.

By zmienić sposób tokenizacji podczas indeksowania danych należy stworzyć niestandardowy filtr i zaaplikować go w niestandardowym analizerze. Indeks airports_3 z wymaganą konfiguracją wygląda jak niżej:

Podczas indeksacji utworzone przy użyciu filtra typu nGram zostaną tokeny o długości od 1 do 20 znaków. By upewnić się że wszystko przebiegło w porządku wykonać można:

Oczekiwany wynik:

Po utworzeniu indeksu z nowym analizerem można wykonywać przy jego użyciu analizy:

Rezultatem jest lista tokenów powstałych z działania analizera autocomplete_analyzer, na których wykonano filtr lowercase i autocomplete_filter typu nGram.

Przykładowe zapytanie na nowo powstałym indeksie airports_3 wygląda jak niżej:

W rezultacie zwrócone zostanie o wiele więcej wyników niż wynikałoby z wpisanej frazy str. By przekonać się o wewnętrznym algorytmie wyszukiwania należy do zapytania dodać parametr explain. Do odpowiedzi zostanie dołączony schemat, według którego Elasticsearch dopasował wynik.

Odpowiedź jest długa, sprawdźmy więc fragment wyjaśniający dlaczego w wynikach umieszczone zostały Pyrzowice:

W szczegółach sekcji _explanation widnieje fragment name:r in 0, oznacza on że w polu name znaleziono token r i na tej podstawie dopasowano wynik naliczając odpowiedni score. Fraza str podczas wyszukiwania została przeanalizowana tym samym analizerem co wprowadzane dane, w rezultacie powstały także tokeny o długości jeden. By osiągnąć zamierzony efekt należy zmienić sposób analizowania danych podczas fazy wyszukiwania, chcemy by cała wpisana fraza traktowana była jako jeden ciąg. Do tego celu wykorzystamy standardowy analizer, zmodyfikowane zapytanie, wciąż z parametrem explain wygląda jak poniżej:

Odpowiedź jest bardziej szczegółowa i zawiera tylko jeden wynik. Patrząc w analogiczne miejsce w sekcji explanation zauważyć można że tym razem dopasowany został pełen wpisany podczas wyszukiwania ciąg name:str in 1.

Warto zapamiętać:

  • proces analizy tekstu w Elasticsearch składa się z procesu tokenizacji i filtrowania (w tej kolejności)
  • standardowo podczas wyszukiwania i indeksacji używany jest ten sam analizer
  • podczas zapytania można zmienić analizer, którym analizowana będzie szukana fraza
  • dodanie do zapytania parametru explain wyświetli w odpowiedzi dokładny algorytm dopasowania wyniku i wyliczania jego wyniku (score)

Autocomplete iteracja 4: Wyszukiwanie po wielu polach

Do tej pory wyszukiwanie przeprowadzane było jedynie po polu name. Łatwo sobie wyobrazić scenariusz, w którym wymagane będzie dopasowanie po wielu polach. W naszym przypadku chcemy dopasowywać zarówno po nazwie lotniska jak i po nazwie miasta. Dla każdego z pól definiuje się osobne mapowanie. Indeks airports_4 z dwoma mapowanymi polami wygląda jak poniżej:

Wymagane jest by wyszukiwanie prowadzone było zarówno po polu name jak i po polu cityName. W Elasticsearch możliwe jest to przy pomocy wyszukiwania typu multi_match, którego parametrem jest lista pól, po których ma być wykonane wyszukiwanie. Najprostsza konfiguracja wygląda jak poniżej:

Dla frazy warszawa zwrócone zostaną dwa wyniki, gdy rozszerzymy frazę o drugi człon będący nazwą lotniska i wyszukamy tym samym sposobem warszawa okęcie nadal zwrócone zostaną oba wyniki. Wynika to z faktu iż domyślnym operatorem zapytania multi_match jest or. Fraza jest wyszukiwana w polu name lub w polu cityName. Dodatkowo każde z pól traktowane jest osobno. By poprawić sytuację należy dodatkowo skonfigurować zapytanie zmieniając jego typ oraz operator łączący jego elementy. Zmodyfikowane zapytanie wygląda następująco.

Zwrócony zostanie dokładnie jeden wynik. Dzieje się tak ponieważ wyszukanie typu cross_fields traktuje pola wylistowane w sekcji fields jako jedno, aplikując na nich wyszukiwanie. Dodatkowo operator and powoduje że zostaną wyszukane tylko wyniki zawierające oba wpisane tokeny.

Warto zapamiętać:

  • każde z pól może zawierać osobne mapowanie
  • wyszukiwanie po wielu polach prowadzi się używając wyszukiwania typu multi_match

Autocomplete iteracja 5: Wyszukiwanie po wielu polach inaczej

Zapytanie z poprzedniego przykładu nieco się rozrosło, dodatkowo coraz trudniej zrozumieć mechanizm wyszukiwania. Istnieje jeszcze jeden sposób wyszukiwania po wielu polach, który rozwiązuje ten problem. Polega on na utworzeniu w momencie indeksacji dodatkowego pola, zawierającego dane z obu pól, które służyć będzie do wyszukiwania. Zmieńmy zatem format danych oraz mapowanie pól:

Nowo przygotowane dane zawierają dodatkowe pole fullName, zawierające dane z pól, po których prowadzić chcemy wyszukiwanie:

Dysponując jednym polem wyszukiwanie wraca do prostej formy, jedyną zmianą jest ustawienie operatora na and, tak by wymagane było znalezienie wszystkich tokenów.

Warto zapamiętać:

  • format danych ma wpływ na stopień skomplikowania zapytania

Podsumowanie

Dzięki wypróbowaniu w praktyce kilku sposobów wyszukiwania w Elasticsearch dokładniej poznaliśmy wewnętrzne mechanizmy tego silnika. Dysponując wiedzą o sposobach analizy tekstu w momencie indeksacji i wyszukiwania, jesteśmy w stanie lepiej kontrolować proces wyszukiwania. Dzięki zastosowaniu n-gramów podczas indeksacji możemy prowadzić wyszukiwanie po części wpisanej frazy. Z wykonywanych wyszukań zaczyna wyłaniać się zarys systemu podpowiadania wpisanych fraz. Dysponując mechanizmem wyszukiwania wpisanego tekstu, w kolejnej części skupimy się na dodatkowych funkcjonalnościach, które taki system powinien posiadać, takich jak ignorowanie znaków diakrytycznych czy podświetlanie wpisanej frazy. Na koniec zwrócimy uwagę na ciągłość działania systemu, oraz połączymy wszystko w całość.


Zobacz również