Spec-Zone.ru › Elasticsearch 8
›Elasticsearch Guide [8.17] ›REST API ›API для обнаружения аномалий с машинным обучением

API удаления прогнозов

Справочник по новым API

Для получения самых актуальных сведений об API обратитесь к API для обнаружения аномалий с машинным обучением.

Удаляет прогнозы из задания машинного обучения.

Запрос

DELETE _ml/anomaly_detectors/<job_id>/_forecast

DELETE _ml/anomaly_detectors/<job_id>/_forecast/<forecast_id>

DELETE _ml/anomaly_detectors/<job_id>/_forecast/_all

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

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

Описание

По умолчанию прогнозы сохраняются в течение 14 дней. Вы можете указать другой срок хранения с помощью параметра expires_in в API заданий прогнозов. API удаления прогнозов позволяет удалить один или несколько прогнозов до их истечения срока действия.

При удалении задания связанные с ним прогнозы также удаляются.

Дополнительную информацию можно найти в Прогнозирование будущего.

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

<forecast_id>
(Необязательный, строка) Список идентификаторов прогнозов, разделённых запятыми. Если этот необязательный параметр не указан или указаны _all или *, API удаляет все прогнозы из задания.
<job_id>
(Обязательный, строка) Идентификатор задания обнаружения аномалий.

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

allow_no_forecasts
(Необязательный, булево) Указывает, возникает ли ошибка при отсутствии прогнозов. В частности, если этот параметр установлен в значение false и прогнозов, связанных с заданием, нет, попытки удалить все прогнозы возвращают ошибку. Значение по умолчанию — true.
timeout
(Необязательный, единицы времени) Указывает период ожидания завершения операции удаления. По истечении этого периода API завершается неудачно и возвращает ошибку. Значение по умолчанию — 30s.

Примеры

resp = client.ml.delete_forecast(
    job_id="total-requests",
    forecast_id="_all",
)
print(resp)
response = client.ml.delete_forecast(
  job_id: 'total-requests',
  forecast_id: '_all'
)
puts response
const response = await client.ml.deleteForecast({
  job_id: "total-requests",
  forecast_id: "_all",
});
console.log(response);
DELETE _ml/anomaly_detectors/total-requests/_forecast/_all

Если запрос не вызовет ошибок, вы получите следующий результат:

{
  "acknowledged": true
}

© 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-delete-forecast.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API