機械学習モデル一覧取得

検索条件に一致する機械学習モデル一覧を取得します。

必要な権限

MEMBER以上のロールが必要です。

HTTPリクエスト

cURL例

curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/machine-learning/models

リクエストパラメータ

正常応答

{
  "total_count": 1,
  "models": [
    {
      "guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "type": "random_forest",
      "type_name": "ランダムフォレスト",
      "user_guid": "11111111-2222-3333-4444-555555555555",
      "user_name": "admin",
      "name": "異常トラフィック分類",
      "description": "ネットワークトラフィック異常検知モデル",
      "dataset_guid": "99999999-8888-7777-6666-555555555555",
      "dataset_name": "トラフィック学習データセット",
      "fields": [
        {
          "name": "src_ip",
          "type": "string"
        },
        {
          "name": "label",
          "type": "string",
          "target": true,
          "values": ["normal", "anomaly"],
          "cardinality": 2,
          "importance": 0.83
        }
      ],
      "parameters": {
        "max_depth": "5",
        "n_estimators": "100"
      },
      "trained": true,
      "train_progress": 100.0,
      "schema": null,
      "accuracy": 0.95,
      "precision": 0.93,
      "recall": 0.91,
      "f1": 0.92,
      "confusion": [[120, 5], [8, 110]],
      "created": 1718668225000,
      "updated": 1718668225000
    }
  ]
}

• total_count (32ビット整数): 検索条件に一致する全件数
• models (配列): 機械学習モデル一覧
  • guid (文字列): モデル識別子
  • type (文字列): モデルタイプコード
  • type_name (文字列): ローカライズされたモデルタイプ名
  • user_guid (文字列): 作成したユーザの識別子
  • user_name (文字列): 作成したユーザの名前
  • name (文字列): モデル名
  • description (文字列): モデルの説明
  • dataset_guid (文字列, nullable): 学習データセット識別子
  • dataset_name (文字列): 学習データセット名
  • fields (配列): モデルフィールド一覧
    • name (文字列): フィールド名
    • type (文字列): フィールドのデータタイプ
    • target (ブール, オプション): 対象フィールドかどうか。trueの場合のみ含まれます
    • values (文字列リスト, オプション): カテゴリ値一覧。設定されている場合のみ含まれます
    • cardinality (32ビット整数, オプション): カテゴリ値の個数。valuesが設定されている場合のみ含まれます
    • importance (64ビット実数, オプション): フィールド重要度。0より大きい場合のみ含まれます
  • parameters (マップ): ハイパーパラメータのキー/値
  • trained (ブール): 学習完了かどうか
  • train_progress (64ビット実数): 学習進捗率（パーセント）
  • schema (マップ, nullable): モデルスキーマ
  • accuracy (64ビット実数): 正解率
  • precision (64ビット実数): 適合率
  • recall (64ビット実数): 再現率
  • f1 (64ビット実数): F1スコア
  • confusion (配列, nullable): 混同行列。32ビット整数配列の配列で、各行は[実際][予測]の形式です
  • created (日付): 作成時刻。epochミリ秒の数値です
  • updated (日付): 更新時刻。epochミリ秒の数値です

エラー応答

offset, limitの値が整数でない場合

HTTPステータスコード 400 応答

{
  "error_code": "invalid-argument",
  "error_msg": "'offset' parameter should be int type"
}

権限がない場合

HTTPステータスコード 500 応答

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}