› › ›

API для получения влиятельных факторов

Возвращает результаты работы задачи обнаружения аномалий для одного или нескольких влиятельных факторов.

Запрос

GET _ml/anomaly_detectors/<job_id>/results/influencers

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

Требуется привилегия кластера monitor_ml. Эта привилегия включена в встроенную роль machine_learning_user.

Описание

Влиятельные факторы — это сущности, которые повлияли на аномалии или являются виновниками аномалий. Результаты по влиятельным факторам доступны только в том случае, если в конфигурации задачи указан influencer_field_name.

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

<job_id>: (Обязательно, строка) Идентификатор задачи обнаружения аномалий.

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

desc: (Необязательно, булево) Если значение равно true, результаты сортируются в порядке убывания.
end: (Необязательно, строка) Возвращает влиятельные факторы с отметками времени, предшествующими этой отметке. По умолчанию значение -1, что означает отсутствие ограничения по отметкам времени.
exclude_interim: (Необязательно, булево) Если значение равно true, вывод исключает промежуточные результаты. По умолчанию значение false, что означает включение промежуточных результатов.
from: (Необязательно, целое число) Пропускает указанное количество влиятельных факторов. По умолчанию значение 0.
influencer_score: (Необязательно, число с плавающей точкой) Возвращает влиятельные факторы с баллами аномалий, не меньшими, чем это значение. По умолчанию значение 0.0.
size: (Необязательно, целое число) Указывает максимальное количество влиятельных факторов для получения. По умолчанию значение 100.
sort: (Необязательно, строка) Указывает поле сортировки для запрашиваемых влиятельных факторов. По умолчанию влиятельные факторы сортируются по значению influencer_score.
start: (Необязательно, строка) Возвращает влиятельные факторы с отметками времени, последующими за этой отметкой. По умолчанию значение -1, что означает отсутствие ограничения по отметкам времени.

Тело запроса

Вы также можете указать параметры запроса в теле запроса; исключениями являются from и size, используйте page вместо них:

page

Свойства page

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

Тело ответа

API возвращает массив объектов влиятельных факторов, у которых есть следующие свойства:

bucket_span: (число) Длительность бакета в секундах. Это значение соответствует значению bucket_span, указанному в задаче.
influencer_score: (число) Нормализованный балл от 0 до 100, основанный на вероятности влиятельного фактора в этом бакете, агрегированной по всем детекторам. В отличие от initial_influencer_score, это значение будет обновляться с помощью процесса повторной нормализации по мере анализа новых данных.
influencer_field_name: (строка) Имя поля влиятельного фактора.
influencer_field_value: (строка) Сущность, которая повлияла на аномалию, или виновник аномалии.
initial_influencer_score: (число) Нормализованный балл от 0 до 100, основанный на вероятности влиятельного фактора, агрегированной по всем детекторам. Это начальное значение, вычисленное в момент обработки бакета.
is_interim: (булево) Если значение равно true, это промежуточный результат. Другими словами, результаты вычисляются на основе частичных входных данных.
job_id: (строка) Идентификатор задачи обнаружения аномалий.
probability: (число) Вероятность того, что у влиятельного фактора есть такое поведение, в диапазоне от 0 до 1. Например, 0.0000109783. Это значение может храниться с высокой точностью, более 300 десятичных знаков, поэтому influencer_score предоставляется как удобочитаемый и понятный интерпретатор.
result_type: (строка) Внутреннее значение. Это значение всегда установлено в значение influencer.
timestamp: (дата) Время начала бакета, для которого были вычислены эти результаты.

Дополнительные свойства влиятельных факторов добавляются в зависимости от анализируемых полей. Например, если анализируется user_name как влиятельный фактор, в документ результата добавляется поле user_name. Эта информация позволяет проще фильтровать результаты аномалий.

Примеры

resp = client.ml.get_influencers(
    job_id="high_sum_total_sales",
    sort="influencer_score",
    desc=True,
)
print(resp)

response = client.ml.get_influencers(
  job_id: 'high_sum_total_sales',
  body: {
    sort: 'influencer_score',
    desc: true
  }
)
puts response

const response = await client.ml.getInfluencers({
  job_id: "high_sum_total_sales",
  sort: "influencer_score",
  desc: true,
});
console.log(response);

GET _ml/anomaly_detectors/high_sum_total_sales/results/influencers
{
  "sort": "influencer_score",
  "desc": true
}

В этом примере API возвращает следующую информацию, отсортированную по баллу влиятельного фактора в порядке убывания:

{
  "count": 189,
  "influencers": [
    {
      "job_id": "high_sum_total_sales",
      "result_type": "influencer",
      "influencer_field_name": "customer_full_name.keyword",
      "influencer_field_value": "Wagdi Shaw",
      "customer_full_name.keyword" : "Wagdi Shaw",
      "influencer_score": 99.02493,
      "initial_influencer_score" : 94.67233079580171,
      "probability" : 1.4784807245686567E-10,
      "bucket_span" : 3600,
      "is_interim" : false,
      "timestamp" : 1574661600000
    },
  ...
  ]
}

© 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/ml-get-influencer.html