トレーニング済みモデルAPI

トレーニング済みモデルの構成情報を取得します。

リクエスト

GET _ml/trained_models/

GET _ml/trained_models/<model_id>

GET _ml/trained_models/_all

GET _ml/trained_models/<model_id1>,<model_id2>

GET _ml/trained_models/<model_id_pattern*>

前提条件

monitor_ml クラスター権限が必要です。この権限は machine_learning_user ビルトインロールに含まれています。

パスパラメータ

  • <model_id>
  • （オプション、文字列）トレーニング済みモデルの一意の識別子またはモデルエイリアス。
    カンマ区切りのモデルIDリストまたはワイルドカード式を使用することで、単一のAPIリクエストで複数のトレーニング済みモデルの情報を取得できます。

クエリパラメータ

  • allow_no_match
  • （オプション、ブール値）リクエスト時の動作を指定します：
    • ワイルドカード式を含み、一致するモデルがない場合。
    • _all 文字列を含むか、識別子がない場合で、一致するものがない場合。
    • ワイルドカード式を含み、部分一致のみがある場合。
      デフォルト値は true で、一致がない場合は空の配列を返し、部分一致がある場合は結果のサブセットを返します。このパラメータが false の場合、一致がないか部分一致のみの場合、リクエストは 404 ステータスコードを返します。
  • decompress_definition
  • （オプション、ブール値）含まれるモデル定義をJSONマップ（true）として返すか、カスタム圧縮形式（false）で返すかを指定します。デフォルトは true です。
  • exclude_generated
  • （オプション、ブール値）特定のフィールドを取得時に構成から削除するかどうかを示します。これにより、構成が取得可能な形式になり、別のクラスターに追加できるようになります。デフォルトはfalseです。
  • from
  • （オプション、整数）指定された数のモデルをスキップします。デフォルト値は 0 です。
  • include
  • （オプション、文字列）レスポンスボディに含めるオプションフィールドのカンマ区切り文字列。デフォルト値は空で、オプションフィールドは含まれません。有効なオプションは：
    • definition：モデル定義を含めます。
    • feature_importance_baseline：特徴重要度値のベースラインを含めます。
    • hyperparameters：モデルをトレーニングするために使用されたハイパーパラメータに関する情報を含めます。この情報は、値、ハイパーパラメータの絶対的および相対的重要性、ユーザーによって指定されたか、ハイパーパラメータ最適化中に調整されたかを示す指標で構成されます。
    • total_feature_importance：トレーニングデータセットの総特徴重要度を含めます。
    • definition_status：完全なモデル定義が存在するかどうかを示すフィールド fully_defined を含めます。ベースラインと総特徴重要度値は、レスポンスボディの metadata フィールドに返されます。
  • size
  • （オプション、整数）取得するモデルの最大数を指定します。デフォルト値は 100 です。
  • tags
  • （オプション、文字列）タグのカンマ区切り文字列。トレーニング済みモデルは多くのタグを持つことができるか、持たないこともあります。提供された場合、提供されたすべてのタグを含むトレーニング済みモデルのみが返されます。

トレーニング済みモデルAPI

トレーニング済みモデルの構成情報を取得します。

レスポンスコード

  • 400
  • include_model_definition が true の場合、このコードは複数のモデルがIDパターンに一致することを示します。
  • 404 （リソースが見つかりません）
  • allow_no_match が false の場合、このコードはリクエストに一致するリソースがないか、リクエストに対して部分的に一致するのみであることを示します。

例

以下の例は、すべてのトレーニング済みモデルの構成情報を取得します:

Python

  1. resp = client.ml.get_trained_models()
  2. print(resp)

Ruby

  1. response = client.ml.get_trained_models
  2. puts response

Js

  1. const response = await client.ml.getTrainedModels();
  2. console.log(response);

コンソール

  1. GET _ml/trained_models/