Запрос с оценкой функций

Функция script_score позволяет обернуть другой запрос и настроить оценку его, необязательно с вычислением, полученным из других числовых значений поля в документе с помощью скриптового выражения. Вот простой пример:

GET /_search
{
  "query": {
    "function_score": {
      "query": {
        "match": { "message": "elasticsearch" }
      },
      "script_score": {
        "script": {
          "source": "Math.log(2 + doc['my-int'].value)"
        }
      }
    }
  }
}

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

Компиляция скриптов кэшируется для более быстрого выполнения. Если скрипт должен учитывать параметры, предпочтительно повторно использовать тот же скрипт и предоставить ему параметры:

GET /_search
{
  "query": {
    "function_score": {
      "query": {
        "match": { "message": "elasticsearch" }
      },
      "script_score": {
        "script": {
          "params": {
            "a": 5,
            "b": 1.2
          },
          "source": "params.a / Math.pow(params.b, doc['my-int'].value)"
        }
      }
    }
  }
}

Обратите внимание, что в отличие от запроса custom_score, рейтинг запроса умножается на результат вычисления рейтинга скриптом. Если вы хотите запретить это, установите "boost_mode": "replace"

Рейтинг weight позволяет вам умножить рейтинг на предоставленное значение weight. Иногда это может быть желательно, так как значения усиления, установленные для определенных запросов, нормализуются, в то время как для этой функции вычисления рейтинга это не так. Значение числового типа - float.

"weight" : number

random_score генерирует рейтинги, равномерно распределённые от 0 до, но не включая 1. По умолчанию он использует внутренние идентификаторы документов Lucene в качестве источника случайности, что очень эффективно, но, к сожалению, не воспроизводимо, так как документы могут быть переименованы слияниями.

В случае, если вы хотите, чтобы рейтинги были воспроизводимыми, можно предоставить seed и field. Конечный рейтинг будет затем вычислен на основе этого зерна, минимального значения field для рассматриваемого документа и соли, вычисленной на основе имени индекса и идентификатора фрагмента, так что документы с одинаковым значением, но хранящиеся в разных индексах, получают разные рейтинги. Обратите внимание, что документы, которые находятся в одном фрагменте и имеют одинаковое значение для field, однако, получат одинаковый рейтинг, поэтому обычно желательно использовать поле, имеющее уникальные значения для всех документов. Хорошим выбором по умолчанию может быть использование поля _seq_no, единственным недостатком которого является то, что рейтинги изменятся, если документ обновляется, поскольку операции обновления также обновляют значение поля _seq_no.

GET /_search
{
  "query": {
    "function_score": {
      "random_score": {
        "seed": 10,
        "field": "_seq_no"
      }
    }
  }
}

Функция field_value_factor позволяет использовать поле из документа для влияния на рейтинг. Она похожа на использование функции script_score, но избегает накладных расходов на скриптинг. Если используется для многозначного поля, в расчётах используется только первое значение поля.

Например, представьте, что у вас есть документ, индексированный с числовым полем my-int, и вы хотите повлиять на рейтинг документа с этим полем. Пример использования:

GET /_search
{
  "query": {
    "function_score": {
      "field_value_factor": {
        "field": "my-int",
        "factor": 1.2,
        "modifier": "sqrt",
        "missing": 1
      }
    }
  }
}

Что переведётся в следующую формулу для расчёта рейтинга:

sqrt(1.2 * doc['my-int'].value)

Функция field_value_factor имеет несколько опций:

Функции затухания оценивают документ с помощью функции, которая затухает в зависимости от расстояния числового значения поля документа от заданного пользователем начального значения. Это похоже на запрос по диапазону, но с плавными краями вместо прямоугольников.

Для использования оценки расстояния в запросе, содержащем числовые поля, пользователь должен определить origin и scale для каждого поля. origin необходим для определения «центральной точки», от которой вычисляется расстояние, а scale для определения скорости затухания. Функция затухания задается как

"DECAY_FUNCTION": { 
    "FIELD_NAME": { 
          "origin": "11, 12",
          "scale": "2km",
          "offset": "0km",
          "decay": 0.33
    }
}

В приведенном выше примере поле является geo_point, а начало координат можно указать в формате геокоординат. scale и offset в этом случае должны быть указаны с единицей измерения. Если ваше поле — поле даты, вы можете задать scale и offset как дни, недели и так далее. Пример:

GET /_search
{
  "query": {
    "function_score": {
      "gauss": {
        "@timestamp": {
          "origin": "2013-09-17", 
          "scale": "10d",
          "offset": "5d",         
          "decay": 0.5            
        }
      }
    }
  }
}

В первом примере документы могут представлять отели и содержать геолокационное поле. Вы хотите вычислить функцию затухания в зависимости от того, как далеко отель находится от заданного местоположения. Вы, возможно, не сразу поймёте, какую шкалу выбрать для функции Гаусса, но можете сказать что-то вроде: «На расстоянии 2 км от желаемого местоположения оценка должна быть уменьшена до одной трети». Затем параметр «масштаб» будет автоматически скорректирован, чтобы гарантировать, что функция оценки вычисляет оценку 0,33 для отелей, удалённых на 2 км от желаемого местоположения.

Во втором примере документы со значением поля между 2013-09-12 и 2013-09-22 получат вес 1,0, а документы, удалённые от этой даты на 15 дней, — вес 0,5.

    "DECAY_FUNCTION": {
        "FIELD_NAME": {
              "origin": ...,
              "scale": ...
        },
        "multi_value_mode": "avg"
    }

Предположим, вы ищете отель в определенном городе. Ваш бюджет ограничен. Кроме того, вы хотите, чтобы отель был недалеко от центра города, поэтому чем дальше отель от желаемого места, тем меньше вероятность, что вы забронируете его.

Вы хотите, чтобы результаты поиска, соответствующие вашим критериям (например, "отель, Нэнси, некурящий"), были оценены с учетом расстояния до центра города и цены.

Интуитивно вы хотите определить центр города как начало отсчёта и, возможно, вы готовы пройти пешком 2 км до центра города от отеля.
В этом случае ваше начало отсчёта для поля местоположения — центр города, а масштаб — около 2 км.

Если ваш бюджет ограничен, вы, вероятно, предпочтёте что-то дешёвое, чем что-то дорогое. Для поля цены начало отсчёта будет 0 евро, а масштаб зависит от того, сколько вы готовы платить, например, 20 евро.

В этом примере поля могут называться "цена" для цены отеля и "местоположение" для координат этого отеля.

Функция для price в этом случае будет

"gauss": { 
    "price": {
          "origin": "0",
          "scale": "20"
    }
}

и для location:

"gauss": { 
    "location": {
          "origin": "11, 12",
          "scale": "2km"
    }
}

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

GET /_search
{
  "query": {
    "function_score": {
      "functions": [
        {
          "gauss": {
            "price": {
              "origin": "0",
              "scale": "20"
            }
          }
        },
        {
          "gauss": {
            "location": {
              "origin": "11, 12",
              "scale": "2km"
            }
          }
        }
      ],
      "query": {
        "match": {
          "properties": "balcony"
        }
      },
      "score_mode": "multiply"
    }
  }
}

Далее мы покажем, как выглядит вычисленный балл для каждой из трёх возможных функций затухания.

Нормальное затухание, ключевое слово gauss

При выборе gauss в качестве функции затухания в приведённом выше примере контурная и поверхностная диаграммы множителя выглядят следующим образом:

Предположим, что результаты вашего исходного поиска соответствуют трём отелям:

• "Backback Nap"
• "Drink n Drive"
• "BnB Bellevue".

"Drink n Drive" находится довольно далеко от вашего определённого местоположения (почти 2 км) и не слишком дешёвый (около 13 евро), поэтому он получает низкий множитель 0,56. "BnB Bellevue" и "Backback Nap" оба находятся довольно близко к определённому местоположению, но "BnB Bellevue" дешевле, поэтому он получает множитель 0,86, а "Backpack Nap" — 0,66.

Экспоненциальное затухание, ключевое слово exp

При выборе exp в качестве функции затухания в приведённом выше примере контурная и поверхностная диаграммы множителя выглядят следующим образом:

Линейное затухание, ключевое слово linear

При выборе linear в качестве функции затухания в приведённом выше примере контурная и поверхностная диаграммы множителя выглядят следующим образом:

Поддерживаются только числовые, датированные и геокоординатные поля.

Если числовое поле отсутствует в документе, функция вернёт 1.