kibana/api_docs/kbn_ml_trained_models_utils.devdocs.json

{
  "id": "@kbn/ml-trained-models-utils",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [
      {
        "parentPluginId": "@kbn/ml-trained-models-utils",
        "id": "def-common.GetElserOptions",
        "type": "Interface",
        "tags": [],
        "label": "GetElserOptions",
        "description": [],
        "path": "x-pack/packages/ml/trained_models_utils/src/constants/trained_models.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/ml-trained-models-utils",
            "id": "def-common.GetElserOptions.version",
            "type": "CompoundType",
            "tags": [],
            "label": "version",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/ml-trained-models-utils",
                "scope": "common",
                "docId": "kibKbnMlTrainedModelsUtilsPluginApi",
                "section": "def-common.ElserVersion",
                "text": "ElserVersion"
              },
              " | undefined"
            ],
            "path": "x-pack/packages/ml/trained_models_utils/src/constants/trained_models.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/ml-trained-models-utils",
        "id": "def-common.ModelDefinition",
        "type": "Interface",
        "tags": [],
        "label": "ModelDefinition",
        "description": [],
        "path": "x-pack/packages/ml/trained_models_utils/src/constants/trained_models.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/ml-trained-models-utils",
            "id": "def-common.ModelDefinition.version",
            "type": "number",
            "tags": [],
            "label": "version",
            "description": [],
            "path": "x-pack/packages/ml/trained_models_utils/src/constants/trained_models.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ml-trained-models-utils",
            "id": "def-common.ModelDefinition.config",
            "type": "Uncategorized",
            "tags": [],
            "label": "config",
            "description": [],
            "signature": [
              "object"
            ],
            "path": "x-pack/packages/ml/trained_models_utils/src/constants/trained_models.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ml-trained-models-utils",
            "id": "def-common.ModelDefinition.description",
            "type": "string",
            "tags": [],
            "label": "description",
            "description": [],
            "path": "x-pack/packages/ml/trained_models_utils/src/constants/trained_models.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ml-trained-models-utils",
            "id": "def-common.ModelDefinition.os",
            "type": "string",
            "tags": [],
            "label": "os",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "x-pack/packages/ml/trained_models_utils/src/constants/trained_models.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ml-trained-models-utils",
            "id": "def-common.ModelDefinition.arch",
            "type": "string",
            "tags": [],
            "label": "arch",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "x-pack/packages/ml/trained_models_utils/src/constants/trained_models.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ml-trained-models-utils",
            "id": "def-common.ModelDefinition.default",
            "type": "CompoundType",
            "tags": [],
            "label": "default",
            "description": [],
            "signature": [
              "boolean | undefined"
            ],
            "path": "x-pack/packages/ml/trained_models_utils/src/constants/trained_models.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ml-trained-models-utils",
            "id": "def-common.ModelDefinition.recommended",
            "type": "CompoundType",
            "tags": [],
            "label": "recommended",
            "description": [],
            "signature": [
              "boolean | undefined"
            ],
            "path": "x-pack/packages/ml/trained_models_utils/src/constants/trained_models.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "@kbn/ml-trained-models-utils",
        "id": "def-common.BUILT_IN_MODEL_TAG",
        "type": "string",
        "tags": [],
        "label": "BUILT_IN_MODEL_TAG",
        "description": [],
        "signature": [
          "\"prepackaged\""
        ],
        "path": "x-pack/packages/ml/trained_models_utils/src/constants/trained_models.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/ml-trained-models-utils",
        "id": "def-common.BUILT_IN_MODEL_TYPE",
        "type": "string",
        "tags": [],
        "label": "BUILT_IN_MODEL_TYPE",
        "description": [],
        "path": "x-pack/packages/ml/trained_models_utils/src/constants/trained_models.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/ml-trained-models-utils",
        "id": "def-common.DeploymentState",
        "type": "Type",
        "tags": [],
        "label": "DeploymentState",
        "description": [],
        "signature": [
          "\"started\" | \"starting\" | \"stopping\""
        ],
        "path": "x-pack/packages/ml/trained_models_utils/src/constants/trained_models.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/ml-trained-models-utils",
        "id": "def-common.ElasticModelId",
        "type": "Type",
        "tags": [],
        "label": "ElasticModelId",
        "description": [],
        "signature": [
          "string"
        ],
        "path": "x-pack/packages/ml/trained_models_utils/src/constants/trained_models.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/ml-trained-models-utils",
        "id": "def-common.ElserVersion",
        "type": "Type",
        "tags": [],
        "label": "ElserVersion",
        "description": [],
        "signature": [
          "2 | 1"
        ],
        "path": "x-pack/packages/ml/trained_models_utils/src/constants/trained_models.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/ml-trained-models-utils",
        "id": "def-common.ModelDefinitionResponse",
        "type": "Type",
        "tags": [],
        "label": "ModelDefinitionResponse",
        "description": [],
        "signature": [
          {
            "pluginId": "@kbn/ml-trained-models-utils",
            "scope": "common",
            "docId": "kibKbnMlTrainedModelsUtilsPluginApi",
            "section": "def-common.ModelDefinition",
            "text": "ModelDefinition"
          },
          " & { name: string; }"
        ],
        "path": "x-pack/packages/ml/trained_models_utils/src/constants/trained_models.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/ml-trained-models-utils",
        "id": "def-common.SupportedPytorchTasksType",
        "type": "Type",
        "tags": [],
        "label": "SupportedPytorchTasksType",
        "description": [],
        "signature": [
          "\"text_expansion\" | \"ner\" | \"question_answering\" | \"zero_shot_classification\" | \"text_classification\" | \"text_embedding\" | \"fill_mask\""
        ],
        "path": "x-pack/packages/ml/trained_models_utils/src/constants/trained_models.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/ml-trained-models-utils",
        "id": "def-common.TrainedModelType",
        "type": "Type",
        "tags": [],
        "label": "TrainedModelType",
        "description": [],
        "signature": [
          "\"pytorch\" | \"tree_ensemble\" | \"lang_ident\""
        ],
        "path": "x-pack/packages/ml/trained_models_utils/src/constants/trained_models.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": [
      {
        "parentPluginId": "@kbn/ml-trained-models-utils",
        "id": "def-common.DEPLOYMENT_STATE",
        "type": "Object",
        "tags": [],
        "label": "DEPLOYMENT_STATE",
        "description": [],
        "signature": [
          "{ readonly STARTED: \"started\"; readonly STARTING: \"starting\"; readonly STOPPING: \"stopping\"; }"
        ],
        "path": "x-pack/packages/ml/trained_models_utils/src/constants/trained_models.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/ml-trained-models-utils",
        "id": "def-common.ELASTIC_MODEL_DEFINITIONS",
        "type": "Object",
        "tags": [],
        "label": "ELASTIC_MODEL_DEFINITIONS",
        "description": [],
        "signature": [
          "{ [x: string]: ",
          {
            "pluginId": "@kbn/ml-trained-models-utils",
            "scope": "common",
            "docId": "kibKbnMlTrainedModelsUtilsPluginApi",
            "section": "def-common.ModelDefinition",
            "text": "ModelDefinition"
          },
          "; }"
        ],
        "path": "x-pack/packages/ml/trained_models_utils/src/constants/trained_models.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/ml-trained-models-utils",
        "id": "def-common.SUPPORTED_PYTORCH_TASKS",
        "type": "Object",
        "tags": [],
        "label": "SUPPORTED_PYTORCH_TASKS",
        "description": [],
        "signature": [
          "{ readonly NER: \"ner\"; readonly QUESTION_ANSWERING: \"question_answering\"; readonly ZERO_SHOT_CLASSIFICATION: \"zero_shot_classification\"; readonly TEXT_CLASSIFICATION: \"text_classification\"; readonly TEXT_EMBEDDING: \"text_embedding\"; readonly FILL_MASK: \"fill_mask\"; readonly TEXT_EXPANSION: \"text_expansion\"; }"
        ],
        "path": "x-pack/packages/ml/trained_models_utils/src/constants/trained_models.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/ml-trained-models-utils",
        "id": "def-common.TRAINED_MODEL_TYPE",
        "type": "Object",
        "tags": [],
        "label": "TRAINED_MODEL_TYPE",
        "description": [],
        "signature": [
          "{ readonly PYTORCH: \"pytorch\"; readonly TREE_ENSEMBLE: \"tree_ensemble\"; readonly LANG_IDENT: \"lang_ident\"; }"
        ],
        "path": "x-pack/packages/ml/trained_models_utils/src/constants/trained_models.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ]
  }
}