Return ML defaults and limits Added in 6.3.0

GET /_ml/info

Returns defaults and limits used by machine learning. This endpoint is designed to be used by a user interface that needs to fully understand machine learning configurations where some options are not specified, meaning that the defaults should be used. This endpoint may be used to find out what those defaults are. It also provides information about the maximum size of machine learning jobs that could run in the current cluster configuration.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • defaults object Required

      Additional properties are allowed.

      Hide defaults attributes Show defaults attributes object
      • anomaly_detectors object Required

        Additional properties are allowed.

        Hide anomaly_detectors attributes Show anomaly_detectors attributes object
        • categorization_analyzer string | object Required

          One of:
        • model_memory_limit string Required
      • datafeeds object Required

        Additional properties are allowed.

        Hide datafeeds attribute Show datafeeds attribute object
    • limits object Required

      Additional properties are allowed.

      Hide limits attributes Show limits attributes object
    • upgrade_mode boolean Required
    • native_code object Required

      Additional properties are allowed.

      Hide native_code attributes Show native_code attributes object
GET /_ml/info
curl \
 -X GET http://api.example.com/_ml/info
Response examples (200)
{
  "defaults": {
    "anomaly_detectors": {
      "": "string",
      "categorization_examples_limit": 42.0,
      "model_memory_limit": "string",
      "model_snapshot_retention_days": 42.0,
      "daily_model_snapshot_retention_after_days": 42.0
    },
    "datafeeds": {
      "scroll_size": 42.0
    }
  },
  "limits": {
    "max_model_memory_limit": "string",
    "effective_max_model_memory_limit": "string",
    "total_ml_memory": "string"
  },
  "upgrade_mode": true,
  "native_code": {
    "build_hash": "string",
    "version": "string"
  }
}