Query parameters

  • allow_no_matchboolean

    Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the _all string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If true, the API returns an empty array when there are no matches and the subset of results when there are partial matches. If false, the API returns a 404 status code when there are no matches or only partial matches.

  • bytesstring

    The unit used to display byte values.

    Values are b, kb, mb, gb, tb, or pb.

  • hstring | array[string]

    A comma-separated list of column names to display.

    Values are create_time, ct, created_by, c, createdBy, data_frame_analytics_id, df, dataFrameAnalytics, dfid, 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, or v.

  • sstring | array[string]

    A comma-separated list of column names or aliases used to sort the response.

    Values are create_time, ct, created_by, c, createdBy, data_frame_analytics_id, df, dataFrameAnalytics, dfid, 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, or v.

  • fromnumber

    Skips the specified number of transforms.

  • sizenumber

    The maximum number of transforms to display.

  • timestring

    Unit used to display time values.

    Values are nanos, micros, ms, s, m, h, or d.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • idstring
    • created_bystring

      Information about the creator of the model.

    • heap_sizenumber | string

      One of:
      ByteSizenumberByteSizestring
    • operationsstring

      The estimated number of operations to use the model. This number helps to measure the computational complexity of the model.

    • licensestring

      The license level of the model.

    • create_timestring | number

      A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

      One of:
      DateTimestringUnitMillisnumber

      Time unit for milliseconds

    • versionstring
    • descriptionstring

      A description of the model.

    • ingest.pipelinesstring

      The number of pipelines that are referencing the model.

    • ingest.countstring

      The total number of documents that are processed by the model.

    • ingest.timestring

      The total time spent processing documents with thie model.

    • ingest.currentstring

      The total number of documents that are currently being handled by the model.

    • ingest.failedstring

      The total number of failed ingest attempts with the model.

    • data_frame.idstring

      The identifier for the data frame analytics job that created the model. Only displayed if the job is still available.

    • data_frame.create_timestring

      The time the data frame analytics job was created.

    • data_frame.source_indexstring

      The source index used to train in the data frame analysis.

    • data_frame.analysisstring

      The analysis used by the data frame to build the model.

    • typestring Generally available; Added in 8.0.0
GET /_cat/ml/trained_models
GET _cat/ml/trained_models?v=true&format=json

resp = client.cat.ml_trained_models(
    v=True,
    format="json",
)
const response = await client.cat.mlTrainedModels({
  v: "true",
  format: "json",
});
response = client.cat.ml_trained_models(
  v: "true",
  format: "json"
)
$resp = $client->cat()->mlTrainedModels([
    "v" => "true",
    "format" => "json",
]);
curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/ml/trained_models?v=true&format=json"
Response examples (200)
A successful response from `GET _cat/ml/trained_models?v=true&format=json`.
[
  {
    "id": "ddddd-1580216177138",
    "heap_size": "0b",
    "operations": "196",
    "create_time": "2025-03-25T00:01:38.662Z",
    "type": "pytorch",
    "ingest.pipelines": "0",
    "data_frame.id": "__none__"
  },
  {
    "id": "lang_ident_model_1",
    "heap_size": "1mb",
    "operations": "39629",
    "create_time": "2019-12-05T12:28:34.594Z",
    "type": "lang_ident",
    "ingest.pipelines": "0",
    "data_frame.id": "__none__"
  }
]