Spec-Zone.ru › Elasticsearch 8
›Elasticsearch Guide [8.17] ›REST API ›API синонимов

Получение набора синонимов

Справочник новых API

Для получения наиболее актуальных данных об API обратитесь к API синонимов.

Извлекает набор синонимов.

Запрос

GET _synonyms/<synonyms_set>

Предварительные условия

Требуется привилегия кластера manage_search_synonyms.

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

<synonyms_set>
(Обязательный, строка) Идентификатор набора синонимов для извлечения.

Параметры запроса

from
(Необязательный, целое число) Начальное смещение для извлечения правил синонимов. По умолчанию 0.
size
(Необязательный, целое число) Указывает максимальное количество правил синонимов для извлечения. По умолчанию 10.

Коды ответов

400
Идентификатор synonyms_set не был указан.
404 (Отсутствующие ресурсы)
Не найдено ни одного набора синонимов с идентификатором synonyms_set.

Примеры

В следующем примере извлекается набор синонимов с именем my-synonyms-set:

resp = client.synonyms.get_synonym(
    id="my-synonyms-set",
)
print(resp)
response = client.synonyms.get_synonym(
  id: 'my-synonyms-set'
)
puts response
const response = await client.synonyms.getSynonym({
  id: "my-synonyms-set",
});
console.log(response);
GET _synonyms/my-synonyms-set

Информация о наборе синонимов, которая возвращается, будет включать общее количество правил синонимов, содержащихся в наборе синонимов, и правила синонимов в соответствии с параметрами from и size.

Пример ответа:

{
  "count": 3,
  "synonyms_set": [
    {
      "id": "test-1",
      "synonyms": "hello, hi"
    },
    {
      "id": "test-2",
      "synonyms": "bye, goodbye"
    },
    {
      "id": "test-3",
      "synonyms": "test => check"
    }
  ]
}

© 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/8.17/get-synonyms-set.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API