› › ›

创建富化策略 API

创建富化策略。

resp = client.enrich.put_policy(
    name="my-policy",
    match={
        "indices": "users",
        "match_field": "email",
        "enrich_fields": [
            "first_name",
            "last_name",
            "city",
            "zip",
            "state"
        ]
    },
)
print(resp)

response = client.enrich.put_policy(
  name: 'my-policy',
  body: {
    match: {
      indices: 'users',
      match_field: 'email',
      enrich_fields: [
        'first_name',
        'last_name',
        'city',
        'zip',
        'state'
      ]
    }
  }
)
puts response

const response = await client.enrich.putPolicy({
  name: "my-policy",
  match: {
    indices: "users",
    match_field: "email",
    enrich_fields: ["first_name", "last_name", "city", "zip", "state"],
  },
});
console.log(response);

PUT /_enrich/policy/my-policy
{
  "match": {
    "indices": "users",
    "match_field": "email",
    "enrich_fields": ["first_name", "last_name", "city", "zip", "state"]
  }
}

请求

编辑

PUT /_enrich/policy/<enrich-policy>

前提条件

编辑

要使用富化策略，你必须拥有：

对任何使用的索引具有 read 索引权限
enrich_user 内置角色

描述

编辑

使用创建富化策略 API 来创建富化策略。

创建后，您无法更新或更改富化策略。相反，您可以

创建并执行新的富化策略。
在任何正在使用的富化处理器或 ES|QL 查询中，将之前的富化策略替换为新的富化策略。
使用删除富化策略 API 或 Kibana 中的索引管理来删除之前的富化策略。

路径参数

编辑

<enrich-policy>: （必需，字符串）要创建或更新的富化策略的名称。

请求体

编辑

<policy-type>

（必需，对象）配置富化策略。字段键是富化策略类型。有效的键值有：

geo_match: 根据 geo_shape 查询将富化数据匹配到传入文档。有关示例，请参阅示例：基于地理位置富化您的数据。
match: 根据 term 查询将富化数据匹配到传入文档。有关示例，请参阅示例：基于精确值富化您的数据。
range: 根据 term 查询，将传入文档中的数字、日期或 IP 地址与富化索引中的范围匹配。有关示例，请参阅示例：通过将值与范围匹配来富化您的数据。

<policy-type> 的属性

indices

（必需，字符串或字符串数组）用于创建富化索引的一个或多个源索引。

如果指定了多个索引，它们必须共享一个公共的 match_field。

match_field

（必需，字符串）源索引中用于匹配传入文档的字段。

enrich_fields

（必需，字符串数组）要添加到匹配的传入文档中的字段。这些字段必须存在于源索引中。

query

（可选，查询 DSL 查询对象）用于过滤富化索引中文档的查询。该策略仅使用与此查询匹配的文档来富化传入文档。默认为 match_all 查询。

« 富化 API 删除富化策略 API »