› › ›

API получения снимков моделей

Получает информацию о снимках моделей.

Запрос

GET _ml/anomaly_detectors/<job_id>/model_snapshots

GET _ml/anomaly_detectors/<job_id>/model_snapshots/<snapshot_id>

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

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

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

<job_id>

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

<snapshot_id>

(Необязательно, строка) Идентификатор снимка модели.

Вы можете получить информацию о нескольких снимках, используя список, разделенный запятыми, или выражение с подстановкой. Вы можете получить все снимки, используя _all, указав * в качестве идентификатора снимка или опустив идентификатор снимка.

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

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

Тело запроса

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

page

Свойства page

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

Тело ответа

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

description: (строка) Необязательное описание задания.
job_id: (строка) Числовая строка, которая однозначно идентифицирует задание, для которого был создан моментальный снимок.
latest_record_time_stamp: (дата) Отметка времени последней обработанной записи.
latest_result_time_stamp: (дата) Отметка времени последнего результата корзины.
min_version: (строка) Минимальный номер версии конфигурации машинного обучения, необходимой для восстановления моментального снимка модели.

Начиная с Elasticsearch 8.10.0, используется новый номер версии для отслеживания изменений конфигурации и состояния в плагине машинного обучения. Этот новый номер версии не связан с версией продукта и будет увеличиваться независимо. Значение min_version представляет новый номер версии.

model_size_stats

(объект) Сводная информация, описывающая модель.

Свойства model_size_stats

assignment_memory_basis

(строка) Указывает, где найти требования к памяти, используемые для определения места выполнения задания. Возможные значения:

model_memory_limit: Требования к памяти задания рассчитываются исходя из предположения, что память модели будет увеличиваться до значения model_memory_limit, указанного в analysis_limits конфигурации.
current_model_bytes: Требования к памяти задания рассчитываются исходя из предположения, что текущий размер памяти модели хорошо отражает её будущий размер.
peak_model_bytes: Требования к памяти задания рассчитываются исходя из предположения, что максимальный размер памяти модели хорошо отражает будущий размер модели.

bucket_allocation_failures_count

(длинное целое число) Количество корзин, для которых сущности не были обработаны из-за ограничений по памяти.

categorized_doc_count

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

categorization_status

(строка) Статус категоризации для этого задания. Содержит одно из следующих значений.

ok: Категоризация выполняется приемлемо (или вообще не используется).
warn: Категоризация обнаруживает распределение категорий, которое предполагает, что входные данные неподходят для категоризации. Проблемы могут заключаться в том, что существует только одна категория, более 90% категорий редкие, количество категорий больше 50% от количества категоризованных документов, нет часто встречающихся категорий или более 50% категорий являются устаревшими.

dead_category_count

(длинное целое число) Количество категорий, созданных категоризацией, которые больше никогда не будут назначены, потому что определение другой категории делает её супермножеством устаревшей категории. (Устаревшие категории — побочный эффект того, что категоризация не имеет предварительной подготовки.)

failed_category_count

(длинное целое число) Количество раз, когда категоризация хотела создать новую категорию, но не смогла, потому что задание достигло своего model_memory_limit. Этот счетчик не отслеживает, какие именно категории не были созданы. Поэтому вы не можете использовать это значение для определения количества уникальных категорий, которые были пропущены.

frequent_category_count

(длинное целое число) Количество категорий, которые соответствуют более чем 1% категоризованных документов.

job_id

(строка) Идентификатор задания обнаружения аномалий.

log_time

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

memory_status

(строка) Статус памяти по отношению к её model_memory_limit. Содержит одно из следующих значений.

hard_limit: Внутренние модели требуют больше места, чем заданный предел памяти. Некоторые входящие данные не могли быть обработаны.
ok: Внутренние модели оставались ниже заданного значения.
soft_limit: Внутренние модели требуют более 60% заданного предела памяти, и будет выполнено более агрессивное удаление, чтобы попытаться освободить место.

model_bytes

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

model_bytes_exceeded

(длинное целое число) Количество байтов, превышающих верхний предел использования памяти при последней ошибке выделения.

model_bytes_memory_limit

(длинное целое число) Верхний предел использования памяти, проверяемый при увеличении значений.

peak_model_bytes

(длинное целое число) Максимальное зарегистрированное значение использования памяти модели.

rare_category_count

(длинное целое число) Количество категорий, которые соответствуют только одному категоризованному документу.

result_type

(строка) Внутреннее. Это значение всегда model_size_stats.

timestamp

(дата) Отметка времени записи model_size_stats, согласно временной метке корзины данных.

total_by_field_count

(длинное целое число) Количество анализируемых значений поля by. Обратите внимание, что они подсчитываются отдельно для каждого детектора и раздела.

total_category_count

(длинное целое число) Количество созданных категорий категоризацией.

total_over_field_count

(длинное целое число) Количество анализируемых значений поля over. Обратите внимание, что они подсчитываются отдельно для каждого детектора и раздела.

total_partition_field_count

(длинное целое число) Количество анализируемых значений поля partition.

retain

(Булево) Если true, этот моментальный снимок не будет удален во время автоматической очистки моментальных снимков, старше model_snapshot_retention_days. Однако этот моментальный снимок будет удален при удалении задания. Значение по умолчанию - false.

snapshot_id

(строка) Числовая строка, которая однозначно идентифицирует моментальный снимок модели. Например: "1491852978".

snapshot_doc_count

(длинное целое число) Только для внутреннего использования.

timestamp

(дата) Отметка времени создания моментального снимка.

Примеры

resp = client.ml.get_model_snapshots(
    job_id="high_sum_total_sales",
    start="1575402236000",
)
print(resp)

response = client.ml.get_model_snapshots(
  job_id: 'high_sum_total_sales',
  body: {
    start: '1575402236000'
  }
)
puts response

const response = await client.ml.getModelSnapshots({
  job_id: "high_sum_total_sales",
  start: 1575402236000,
});
console.log(response);

GET _ml/anomaly_detectors/high_sum_total_sales/model_snapshots
{
  "start": "1575402236000"
}

В этом примере API предоставляет один результат:

{
  "count" : 1,
  "model_snapshots" : [
    {
      "job_id" : "high_sum_total_sales",
      "min_version" : "6.4.0",
      "timestamp" : 1575402237000,
      "description" : "State persisted due to job close at 2019-12-03T19:43:57+0000",
      "snapshot_id" : "1575402237",
      "snapshot_doc_count" : 1,
      "model_size_stats" : {
        "job_id" : "high_sum_total_sales",
        "result_type" : "model_size_stats",
        "model_bytes" : 1638816,
        "model_bytes_exceeded" : 0,
        "model_bytes_memory_limit" : 10485760,
        "total_by_field_count" : 3,
        "total_over_field_count" : 3320,
        "total_partition_field_count" : 2,
        "bucket_allocation_failures_count" : 0,
        "memory_status" : "ok",
        "categorized_doc_count" : 0,
        "total_category_count" : 0,
        "frequent_category_count" : 0,
        "rare_category_count" : 0,
        "dead_category_count" : 0,
        "categorization_status" : "ok",
        "log_time" : 1575402237000,
        "timestamp" : 1576965600000
      },
      "latest_record_time_stamp" : 1576971072000,
      "latest_result_time_stamp" : 1576965600000,
      "retain" : false
    }
  ]
}

© 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-snapshot.html