データフレーム分析ジョブAPIの更新

既存のデータフレーム分析ジョブを更新します。

リクエスト

POST _ml/data_frame/analytics/<data_frame_analytics_id>/_update

前提条件

次の権限が必要です：

  • クラスター: manage_ml（machine_learning_admin ビルトインロールがこの権限を付与します）
  • ソースインデックス: read, view_index_metadata
  • デスティネーションインデックス: read, create_index, manage および index

データフレーム分析ジョブは、更新時にユーザーが持っていたロールを記憶します。ジョブを開始すると、同じロールを使用して分析を実行します。セカンダリアイソリューションヘッダーを提供すると、それらの資格情報が代わりに使用されます。

説明

このAPIは、ソースインデックスに対して分析を実行し、その結果をデスティネーションインデックスに保存する既存のデータフレーム分析ジョブを更新します。

パスパラメータ

  • <data_frame_analytics_id>
  • （必須、文字列）データフレーム分析ジョブの識別子。この識別子は、小文字の英数字（a-zおよび0-9）、ハイフン、アンダースコアを含むことができます。英数字で始まり、英数字で終わる必要があります。

リクエストボディ

  • allow_lazy_start
  • （オプション、ブール値）このジョブが、ノードに即座に割り当てられるための機械学習ノードの容量が不足している場合に開始できるかどうかを指定します。デフォルトは false です。ジョブを実行するための容量を持つ機械学習ノードが即座に見つからない場合、APIはエラーを返します。ただし、これはクラスター全体の xpack.ml.max_lazy_ml_nodes 設定にも依存します。高度な機械学習設定を参照してください。このオプションが true に設定されている場合、APIはエラーを返さず、ジョブは十分な機械学習ノードの容量が利用可能になるまで starting 状態で待機します。
  • description
  • （オプション、文字列）ジョブの説明。
  • max_num_threads
  • （オプション、整数）分析に使用される最大スレッド数。デフォルト値は 1 です。より多くのスレッドを使用すると、分析を完了するのに必要な時間が短縮される可能性がありますが、CPUの使用量が増加します。プロセスは、分析自体以外の操作機能のために追加のスレッドを使用する場合があります。
  • _meta
  • （オプション、オブジェクト）高度な構成オプション。ジョブに関するカスタムメタデータを含みます。たとえば、カスタムURL情報を含むことができます。
  • model_memory_limit
  • （オプション、文字列）分析処理に許可されるおおよその最大メモリリソース量。データフレーム分析ジョブのデフォルト値は 1gb です。xpack.ml.max_model_memory_limit 設定に値を指定すると、その設定値を超える model_memory_limit 値を持つジョブを作成しようとするとエラーが発生します。詳細については、機械学習設定を参照してください。

例

モデルメモリ制限の更新例

以下の例は、既存のデータフレーム分析構成のモデルメモリ制限を更新する方法を示しています。

Python

  1. resp = client.ml.update_data_frame_analytics(
  2.    id="loganalytics",
  3.    model_memory_limit="200mb",
  4. )
  5. print(resp)

Js

  1. const response = await client.ml.updateDataFrameAnalytics({
  2.   id: "loganalytics",
  3.   model_memory_limit: "200mb",
  4. });
  5. console.log(response);

コンソール

  1. POST _ml/data_frame/analytics/loganalytics/_update
  2. {
  3.   "model_memory_limit": "200mb"
  4. }

ジョブが更新されると、応答には更新された値を持つ構成が含まれます。たとえば：

コンソール-結果

  1. {
  2.   "id" : "loganalytics",
  3.   "create_time" : 1656364565517,
  4.   "version" : "8.4.0",
  5.   "authorization" : {
  6.    "roles" : [
  7.    "superuser"
  8.    ]
  9.   },
  10.   "description" : "Outlier detection on log data",
  11.   "source" : {
  12.    "index" : [
  13.    "logdata"
  14.    ],
  15.    "query" : {
  16.    "match_all" : { }
  17.    }
  18.   },
  19.   "dest" : {
  20.    "index" : "logdata_out",
  21.    "results_field" : "ml"
  22.   },
  23.   "analysis" : {
  24.    "outlier_detection" : {
  25.    "compute_feature_influence" : true,
  26.    "outlier_fraction" : 0.05,
  27.    "standardization_enabled" : true
  28.    }
  29.   },
  30.   "model_memory_limit" : "200mb",
  31.   "allow_lazy_start" : false,
  32.   "max_num_threads" : 1
  33. }