› › ›

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: Сопоставляет число, дату или IP-адрес в входящих документах с диапазоном в индексе обогащения на основе term запроса. Пример см. в Примере: обогащение данных по совпадению значения с диапазоном.

Свойства <policy-type>

indices

(Обязательно, строка или массив строк) Один или несколько исходных индексов, используемых для создания индекса обогащения.

Если указано несколько индексов, они должны иметь общий match_field.

match_field

(Обязательно, строка) Поле в исходных индексах, используемое для сопоставления входящих документов.

enrich_fields

(Обязательно, массив строк) Поля для добавления к совпадающим входящим документам. Эти поля должны присутствовать в исходных индексах.

query

(Необязательно, объект запроса Query DSL) Запрос, используемый для фильтрации документов в индексе обогащения. Политика использует только документы, соответствующие этому запросу, для обогащения входящих документов. По умолчанию используется запрос match_all.

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