删除预测 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 天。您可以使用 预测任务 API 中的 expires_in 参数指定不同的保留期限。删除预测 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
}