elasticsearch-specification/specification/_json_spec/ml.get_trained_models.json at 4655bee62f2fe9bbf31c2bc9dac25f30e2621c19 · elastic/elasticsearch-specification · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
{
  "ml.get_trained_models": {
    "documentation": {
      "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-trained-models",
      "description": "Get trained model configuration info"
    },
    "stability": "stable",
    "visibility": "public",
    "headers": {
      "accept": ["application/json"]
    },
    "url": {
      "paths": [
        {
          "path": "/_ml/trained_models/{model_id}",
          "methods": ["GET"],
          "parts": {
            "model_id": {
              "type": "string",
              "description": "The ID of the trained models to fetch"
            }
          }
        },
        {
          "path": "/_ml/trained_models",
          "methods": ["GET"]
        }
      ]
    },
    "params": {
      "allow_no_match": {
        "type": "boolean",
        "description": "Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified)",
        "default": true
      },
      "include": {
        "type": "enum",
        "description": "A comma delimited string of optional fields to include in the response\nbody.",
        "options": [
          "definition",
          "feature_importance_baseline",
          "hyperparameters",
          "total_feature_importance",
          "definition_status"
        ]
      },
      "decompress_definition": {
        "type": "boolean",
        "default": true,
        "description": "Should the model definition be decompressed into valid JSON or returned in a custom compressed format. Defaults to true."
      },
      "from": {
        "type": "int",
        "description": "skips a number of trained models",
        "default": 0
      },
      "size": {
        "type": "int",
        "description": "specifies a max number of trained models to get",
        "default": 100
      },
      "tags": {
        "type": "list",
        "description": "A comma-separated list of tags that the model must have."
      },
      "exclude_generated": {
        "type": "boolean",
        "default": false,
        "description": "Omits fields that are illegal to set on model PUT"
      }
    }
  }
}