cat trained model API

cat APIは、コマンドラインまたはKibanaコンソールを使用して人間が消費することを目的としています。アプリケーションによる使用は意図されていません。アプリケーションでの使用には、get trained models APIを使用してください。

推論トレーニングモデルに関する設定と使用情報を返します。

Request

GET /_cat/ml/trained_models

Prerequisites

Elasticsearchのセキュリティ機能が有効になっている場合、次の権限が必要です：

  • cluster: monitor_ml

詳細については、Security privilegesおよびMachine learning security privilegesを参照してください。

Query parameters

  • bytes
  • （オプション、バイトサイズ単位）バイト値を表示するために使用される単位。
  • format
  • （オプション、文字列）HTTP accept headerの短縮版。 有効な値にはJSON、YAMLなどが含まれます。
  • h
  • （オプション、文字列）表示する列名のカンマ区切りリスト。
    列を指定しない場合、APIはデフォルトの列を返します。1つ以上の列を明示的に指定した場合、指定された列のみを返します。
    有効な列は：
    • create_time, ct
    • トレーニングモデルが作成された時刻。
    • created_by, c, createdBy
    • トレーニングモデルの作成者に関する情報。
    • data_frame_analytics_id, df, dataFrameAnalytics
    • モデルを作成したデータフレーム分析ジョブの識別子。まだ利用可能な場合のみ表示されます。
    • description, d
    • トレーニングモデルの説明。
    • heap_size, hs, modelHeapSize
    • （デフォルト）トレーニングモデルをメモリに保持するための推定ヒープサイズ。
    • id
    • （デフォルト）トレーニングモデルの識別子。
    • ingest.count, ic, ingestCount
    • モデルによって処理されるドキュメントの総数。
    • ingest.current, icurr, ingestCurrent
    • 現在トレーニングモデルによって処理されているドキュメントの総数。
    • ingest.failed, if, ingestFailed
    • トレーニングモデルでの失敗したインジェスト試行の総数。
    • ingest.pipelines, ip, ingestPipelines
    • （デフォルト）トレーニングモデルを参照しているインジェストパイプラインの総数。
    • ingest.time, it, ingestTime
    • トレーニングモデルでドキュメントを処理するのにかかる総時間。
    • license, l
    • トレーニングモデルのライセンスレベル。
    • operations, o, modelOperations
    • （デフォルト）トレーニングモデルを使用するための推定操作数。この数値はモデルの計算複雑性を測定するのに役立ちます。
    • version, v
    • トレーニングモデルが作成されたElasticsearchのバージョン番号。
  • help
  • （オプション、ブール値）trueの場合、応答にはヘルプ情報が含まれます。デフォルトはfalseです。
  • s
  • （オプション、文字列）応答をソートするために使用される列名または列エイリアスのカンマ区切りリスト。
  • time
  • （オプション、時間単位）時間値を表示するために使用される単位。
  • v
  • （オプション、ブール値）trueの場合、応答には列見出しが含まれます。デフォルトはfalseです。

Examples

Python

  1. resp = client.cat.ml_trained_models(
  2.    h="c,o,l,ct,v",
  3.    v="ture",
  4. )
  5. print(resp)

Js

  1. const response = await client.cat.mlTrainedModels({
  2.   h: "c,o,l,ct,v",
  3.   v: "ture",
  4. });
  5. console.log(response);

Console

  1. GET _cat/ml/trained_models?h=c,o,l,ct,v&v=ture

Console-Result

  1. id                           created_by operations license  create_time              version
  2. ddddd-1580216177138              _xpack 196        PLATINUM 2020-01-28T12:56:17.138Z 8.0.0
  3. flight-regress-1580215685537     _xpack 102        PLATINUM 2020-01-28T12:48:05.537Z 8.0.0
  4. lang_ident_model_1               _xpack 39629      BASIC    2019-12-05T12:28:34.594Z 7.6.0