Поиск

Оператор поиска

Оператор поиска определяет, как поиск должен вести себя, когда пользователь ввел несколько поисковых запросов. Существует два возможных значения:

• “или” — результаты должны соответствовать хотя бы одному термину (по умолчанию для Elasticsearch)
• “и” — результаты должны соответствовать всем терминам (по умолчанию для поиска в базе данных)

Оба оператора имеют свои преимущества и недостатки. Оператор «или» вернет гораздо больше результатов, но, вероятно, будет содержать много нерелевантных результатов. Оператор «и» возвращает только результаты, содержащие все поисковые запросы, но требует от пользователя большей точности в запросе.

Мы рекомендуем использовать оператор «или» при упорядочении по релевантности и оператор «и» при упорядочении по чему-либо другому (прим.: бэкенд базы данных в настоящее время не поддерживает упорядочивание по релевантности).

Вот пример использования ключевого слова operator:

# The database contains a "Thing" model with the following items:
# - Hello world
# - Hello
# - World


# Search with the "or" operator
>>> s = get_search_backend()
>>> s.search("Hello world", Things, operator="or")

# All records returned as they all contain either "hello" or "world"
[<Thing: Hello World>, <Thing: Hello>, <Thing: World>]


# Search with the "and" operator
>>> s = get_search_backend()
>>> s.search("Hello world", Things, operator="and")

# Only "hello world" returned as that's the only item that contains both terms
[<Thing: Hello world>]

Для моделей страниц, изображений и документов ключевое слово operator также поддерживается в методе search QuerySet:

>>> Page.objects.search("Hello world", operator="or")

# All pages containing either "hello" or "world" are returned
[<Page: Hello World>, <Page: Hello>, <Page: World>]

Поиск фраз

Поиск фраз используется для поиска целых предложений или фраз, а не отдельных терминов. Термины должны появляться вместе и в том же порядке.

Например:

>>> from wagtail.search.query import Phrase

>>> Page.objects.search(Phrase("Hello world"))
[<Page: Hello World>]

>>> Page.objects.search(Phrase("World hello"))
[<Page: World Hello day>]

Если вы хотите реализовать запросы фраз с помощью синтаксиса двойных кавычек, см. Разбор строки запроса.

Сложные запросы поиска

С помощью классов запросов поиска Wagtail также поддерживает построение запросов поиска в виде Python-объектов, которые можно оборачивать и комбинировать с другими запросами поиска. Доступны следующие классы:

PlainText(query_string, operator=None, boost=1.0)

Этот класс оборачивает строку отдельных терминов. Это то же самое, что поиск без классов запросов.

Он принимает строку запроса, оператор и boost.

Например:

>>> from wagtail.search.query import PlainText
>>> Page.objects.search(PlainText("Hello world"))

# Multiple plain text queries can be combined. This example will match both "hello world" and "Hello earth"
>>> Page.objects.search(PlainText("Hello") & (PlainText("world") | PlainText("earth")))

Phrase(query_string)

Этот класс оборачивает строку, содержащую фразу. См. предыдущий раздел о том, как это работает.

Например:

# This example will match both the phrases "hello world" and "Hello earth"
>>> Page.objects.search(Phrase("Hello world") | Phrase("Hello earth"))

Boost(query, boost)

Этот класс повышает рейтинг другого запроса.

Например:

>>> from wagtail.search.query import PlainText, Boost

# This example will match both the phrases "hello world" and "Hello earth" but matches for "hello world" will be ranked higher
>>> Page.objects.search(Boost(Phrase("Hello world"), 10.0) | Phrase("Hello earth"))

Обратите внимание, что это не поддерживается бэкендами поиска PostgreSQL или баз данных.

Разбор строки запроса

Предыдущие разделы показывают, как вручную сконструировать запрос поиска фразы, но многие поисковые системы (включая административную панель Wagtail, попробуйте!) поддерживают написание запросов фраз путем обертывания фразы двойными кавычками. Кроме фраз, вы также можете разрешить пользователям добавлять фильтры в запрос с использованием синтаксиса двоеточия (hello world published:yes).

Эти две функции могут быть реализованы с помощью функции-утилиты parse_query_string. Эта функция принимает строку запроса, введенную пользователем, и возвращает объект запроса и словарь фильтров:

Например:

>>> from wagtail.search.utils import parse_query_string
>>> filters, query = parse_query_string('my query string "this is a phrase" this-is-a:filter', operator='and')

>>> filters
{
    'this-is-a': 'filter',
}

>>> query
And([
    PlainText("my query string", operator='and'),
    Phrase("this is a phrase"),
])

Вот пример использования этой функции в представлении поиска:

from wagtail.search.utils import parse_query_string

def search(request):
    query_string = request.GET['query']

    # Parse query
    filters, query = parse_query_string(query_string, operator='and')

    # Published filter
    # An example filter that accepts either `published:yes` or `published:no` and filters the pages accordingly
    published_filter = filters.get('published')
    published_filter = published_filter and published_filter.lower()
    if published_filter in ['yes', 'true']:
        pages = pages.filter(live=True)
    elif published_filter in ['no', 'false']:
        pages = pages.filter(live=False)

    # Search
    pages = pages.search(query)

    return render(request, 'search_results.html', {'pages': pages})

Настройка сортировки

По умолчанию результаты поиска упорядочены по релевантности, если бэкенд это поддерживает. Чтобы сохранить существующую сортировку QuerySet, ключевое слово order_by_relevance должно быть установлено в значение False в методе search().

Например:

# Get a list of events ordered by date
>>> EventPage.objects.order_by('date').search("Event", order_by_relevance=False)

# Events ordered by date
[<EventPage: Easter>, <EventPage: Halloween>, <EventPage: Christmas>]

Аннотирование результатов с оценкой

Для каждого совпавшего результата Elasticsearch вычисляет «оценку», которая представляет собой число, отражающее релевантность результата запросу пользователя. Результаты обычно упорядочиваются на основе оценки.

В некоторых случаях доступ к оценке полезен (например, для программно объединения двух запросов для разных моделей). Вы можете добавить оценку к каждому результату, вызвав метод .annotate_score(field) в SearchQuerySet.

Например:

>>> events = EventPage.objects.search("Event").annotate_score("_score")
>>> for event in events:
...    print(event.title, event._score)
...
("Easter", 2.5),
("Halloween", 1.7),
("Christmas", 1.5),

Обратите внимание, что сама оценка условна и полезна только для сравнения результатов для одного и того же запроса.