機械学習異常検知API - 予測を削除（Delete forecasts） - 《Elasticsearchガイドv8.15》日本語

予測削除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を使用すると、予測が期限切れになる前に1つまたは複数の予測を削除できます。

ジョブを削除すると、その関連する予測も削除されます。

詳細については、未来の予測を参照してください。

<forecast_id>
（オプション、文字列）予測識別子のカンマ区切りリスト。オプションのこのパラメータを指定しない場合、または _all または * を指定した場合、APIはジョブからすべての予測を削除します。
<job_id>
（必須、文字列）異常検出ジョブの識別子。

allow_no_forecasts
（オプション、Boolean）予測がない場合にエラーが発生するかどうかを指定します。特に、このパラメータが 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
}