› › ›

API выполнения политики обогащения

Выполняет существующую политику обогащения.

resp = client.enrich.execute_policy(
    name="my-policy",
    wait_for_completion=False,
)
print(resp)

response = client.enrich.execute_policy(
  name: 'my-policy',
  wait_for_completion: false
)
puts response

const response = await client.enrich.executePolicy({
  name: "my-policy",
  wait_for_completion: "false",
});
console.log(response);

PUT /_enrich/policy/my-policy/_execute?wait_for_completion=false

Запрос

PUT /_enrich/policy/<enrich-policy>/_execute

POST /_enrich/policy/<enrich-policy>/_execute

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

Для использования политик обогащения у вас должны быть:

read права индексации для всех используемых индексов
enrich_user встроенная роль

Описание

Используйте API выполнения политики обогащения для создания индекса обогащения для существующей политики обогащения.

Индекс обогащения содержит документы из исходных индексов политики. Индексы обогащения всегда начинаются с .enrich-*, являются только для чтения и сливаются принудительно.

Индексы обогащения должны использоваться только процессором обогащения или командой ES|QL ENRICH. Избегайте использования индексов обогащения для других целей.

После создания вы не можете обновлять или индексировать документы в индексе обогащения. Вместо этого обновите свои исходные индексы и выполните политику обогащения ещё раз. Это создаст новый индекс обогащения из обновлённых исходных индексов. Предыдущий индекс обогащения будет удалён задачей технического обслуживания с задержкой. По умолчанию это выполняется каждые 15 минут.

По умолчанию этот API является синхронным: он возвращает значение, когда политика выполнена. Поскольку выполнение политики выполняет несколько операций, может потребоваться некоторое время для возврата ответа, особенно когда исходные индексы большие. Это может привести к истечению времени ожидания. Чтобы предотвратить истечение времени ожидания, установите параметр wait_for_completion в значение false. Это выполняет запрос асинхронно в фоновом режиме и возвращает идентификатор задачи. Вы можете использовать идентификатор задачи для управления запросом с помощью API управления задачами.

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

<enrich-policy>: (Обязательно, строка) Политика обогащения для выполнения.

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

wait_for_completion: (Необязательно, Булево) Если true, запрос ожидает завершения выполнения. Если false, запрос возвращается немедленно, а выполнение выполняется асинхронно в фоновом режиме. По умолчанию true.

© 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/execute-enrich-policy-api.html