› › ›

删除预测 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 天。您可以在预测作业 API 中使用 expires_in 参数指定不同的保留期限。删除预测 API 允许您在预测过期之前删除一个或多个预测。

删除作业时，也会删除与其关联的预测。

有关更多信息，请参阅预测未来。

<forecast_id>: （可选，字符串）逗号分隔的预测标识符列表。如果您未指定此可选参数，或者您指定了 _all 或 *，则 API 会删除作业中的所有预测。
<job_id>: （必填，字符串）异常检测作业的标识符。

allow_no_forecasts: （可选，布尔值）指定在没有预测时是否发生错误。特别是，如果此参数设置为 false 并且作业没有关联的预测，则尝试删除所有预测将返回错误。默认值为 true。
timeout: （可选，时间单位）指定等待删除操作完成的时间段。当此时间段过后，API 将失败并返回错误。默认值为 30s。

response = client.ml.delete_forecast(
  job_id: 'total-requests',
  forecast_id: '_all'
)
puts response

DELETE _ml/anomaly_detectors/total-requests/_forecast/_all

如果请求没有遇到错误，您将收到以下结果

{
  "acknowledged": true
}