执行富化策略 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。 这将在后台异步运行请求,并返回一个任务 ID。 您可以使用任务 ID 通过 任务管理 API 管理请求。

路径参数

编辑
<enrich-policy>
(必需,字符串)要执行的富化策略。

查询参数

编辑
wait_for_completion
(可选,布尔值)如果为 true,则请求会阻塞,直到执行完成。 如果为 false,则请求会立即返回,并在后台异步运行执行。 默认为 true