› › ›

API перечисления терминов

API перечисления терминов может использоваться для поиска терминов в индексе, которые соответствуют частичной строке. Поддерживаемые типы полей: keyword, constant_keyword и flattened. Это используется для автозаполнения:

POST stackoverflow/_terms_enum
{
    "field" : "tags",
    "string" : "kiba"
}

API возвращает следующий ответ:

{
  "_shards": {
    "total": 1,
    "successful": 1,
    "failed": 0
  },
  "terms": [
    "kibana"
  ],
  "complete" : true
}

Если флаг complete имеет значение false, возвращаемый набор terms может быть неполным и должен рассматриваться как приблизительный. Это может произойти по нескольким причинам, таким как истечение времени ожидания запроса или ошибка узла.

Запрос

GET /<target>/_terms_enum

Описание

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

Параметры пути

<target>: (Обязательно, строка) Список данных потоков, индексов и псевдонимов для поиска, разделенных запятыми. Поддерживаются подстановочные знаки (*). Чтобы выполнить поиск по всем потокам данных или индексам, опустите этот параметр или используйте * или _all.

Тело запроса

field: (Обязательно, строка) Какое поле сопоставлять

string: (Необязательно, строка) Строка для сопоставления в начале индексированных терминов. Если не указано, все термины в поле рассматриваются.

size: (Необязательно, целое число) Количество возвращаемых сопоставляемых терминов. По умолчанию 10

timeout: (Необязательно, значение времени) Максимальное время, затрачиваемое на сбор результатов. По умолчанию "1s" (одна секунда). Если время ожидания истекло, флаг complete в ответе будет установлен в false, а результаты могут быть частичными или пустыми.

case_insensitive: (Необязательно, логическое значение) Если true, предоставленная строка поиска сопоставляется с терминами индекса без учета регистра. По умолчанию false.

index_filter: (Необязательно, объект запроса) Позволяет отфильтровать фрагмент индекса, если предоставленный запрос переписывается в match_none.

search_after: (Необязательно, строка) Строка после которой должны возвращаться термины в индексе. Позволяет использовать пагинацию, если последний результат из одного запроса передается как параметр search_after для последующего запроса.

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/7.17/search-terms-enum.html