Path parameters

  • model_idstring | array[string] Required

    The unique identifier of the trained model or a model alias.

    You can get information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression.

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, it returns an empty array when there are no matches and the subset of results when there are partial matches.

  • decompress_definitionboolean

    Specifies whether the included model definition should be returned as a JSON map (true) or in a custom compressed format (false).

  • exclude_generatedboolean

    Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.

  • fromnumber

    Skips the specified number of models.

  • includestring

    A comma delimited string of optional fields to include in the response body.

    Supported values include:

    • definition: Includes the model definition.
    • feature_importance_baseline: Includes the baseline for feature importance values.
    • hyperparameters: Includes the information about hyperparameters used to train the model. This information consists of the value, the absolute and relative importance of the hyperparameter as well as an indicator of whether it was specified by the user or tuned during hyperparameter optimization.
    • total_feature_importance: Includes the total feature importance for the training data set. The baseline and total feature importance values are returned in the metadata field in the response body.
    • definition_status: Includes the model definition status.

    Values are definition, feature_importance_baseline, hyperparameters, total_feature_importance, or definition_status.

  • include_model_definitionboolean Deprecated

    parameter is deprecated! Use [include=definition] instead

  • sizenumber

    Specifies the maximum number of models to obtain.

  • tagsstring | array[string]

    A comma delimited string of tags. A trained model can have many tags, or none. When supplied, only trained models that contain all the supplied tags are returned.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • countnumber Required
    • trained_model_configsarray[object] Required

      An array of trained model resources, which are sorted by the model_id value in ascending order.

      Hide trained_model_configs attributes Show trained_model_configs attributes object
      • model_idstring Required
      • model_typestring

        Values are tree_ensemble, lang_ident, or pytorch.

      • tagsarray[string] Required

        A comma delimited string of tags. A trained model can have many tags, or none.

      • versionstring
      • compressed_definitionstring
      • created_bystring

        Information on the creator of the trained 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

      • default_field_mapobject

        Any field map described in the inference configuration takes precedence.

        Hide default_field_map attribute Show default_field_map attribute object
        • *string Additional properties
      • descriptionstring

        The free-text description of the trained model.

      • estimated_heap_memory_usage_bytesnumber

        The estimated heap usage in bytes to keep the trained model in memory.

      • estimated_operationsnumber

        The estimated number of operations to use the trained model.

      • fully_definedboolean

        True if the full model definition is present.

      • inference_configobject

        Inference configuration provided when storing the model config

        Hide inference_config attributes Show inference_config attributes object
        • regressionobject
          Hide regression attributes Show regression attributes object
        • classificationobject
          Hide classification attributes Show classification attributes object
          • num_top_classesnumber

            Specifies the number of top class predictions to return. Defaults to 0.

          • num_top_feature_importance_valuesnumber

            Specifies the maximum number of feature importance values per document.

          • prediction_field_typestring

            Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false.

          • results_fieldstring

            The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.

          • top_classes_results_fieldstring

            Specifies the field to which the top classes are written. Defaults to top_classes.

        • text_classificationobject
          Hide text_classification attributes Show text_classification attributes object
          • num_top_classesnumber

            Specifies the number of top class predictions to return. Defaults to 0.

          • tokenizationobject

            Tokenization options stored in inference configuration

            Hide tokenization attributes Show tokenization attributes object
          • results_fieldstring

            The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.

          • classification_labelsarray[string]

            Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels

          • vocabularyobject
            Hide vocabulary attribute Show vocabulary attribute object
        • zero_shot_classificationobject
          Hide zero_shot_classification attributes Show zero_shot_classification attributes object
          • tokenizationobject

            Tokenization options stored in inference configuration

            Hide tokenization attributes Show tokenization attributes object
          • hypothesis_templatestring

            Hypothesis template used when tokenizing labels for prediction

          • classification_labelsarray[string] Required

            The zero shot classification labels indicating entailment, neutral, and contradiction Must contain exactly and only entailment, neutral, and contradiction

          • results_fieldstring

            The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.

          • multi_labelboolean

            Indicates if more than one true label exists.

          • labelsarray[string]

            The labels to predict.

        • fill_maskobject
          Hide fill_mask attributes Show fill_mask attributes object
          • mask_tokenstring

            The string/token which will be removed from incoming documents and replaced with the inference prediction(s). In a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer has a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests. However, if this field is present in a request, its value must match the predefined value for that model/tokenizer, otherwise the request will fail.

          • num_top_classesnumber

            Specifies the number of top class predictions to return. Defaults to 0.

          • tokenizationobject

            Tokenization options stored in inference configuration

            Hide tokenization attributes Show tokenization attributes object
          • results_fieldstring

            The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.

          • vocabularyobject Required
            Hide vocabulary attribute Show vocabulary attribute object
        • learning_to_rankobject
          Hide learning_to_rank attributes Show learning_to_rank attributes object
        • nerobject
          Hide ner attributes Show ner attributes object
          • tokenizationobject

            Tokenization options stored in inference configuration

            Hide tokenization attributes Show tokenization attributes object
          • results_fieldstring

            The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.

          • classification_labelsarray[string]

            The token classification labels. Must be IOB formatted tags

          • vocabularyobject
            Hide vocabulary attribute Show vocabulary attribute object
        • pass_throughobject
          Hide pass_through attributes Show pass_through attributes object
          • tokenizationobject

            Tokenization options stored in inference configuration

            Hide tokenization attributes Show tokenization attributes object
          • results_fieldstring

            The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.

          • vocabularyobject
            Hide vocabulary attribute Show vocabulary attribute object
        • text_embeddingobject
          Hide text_embedding attributes Show text_embedding attributes object
          • embedding_sizenumber

            The number of dimensions in the embedding output

          • tokenizationobject

            Tokenization options stored in inference configuration

            Hide tokenization attributes Show tokenization attributes object
          • results_fieldstring

            The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.

          • vocabularyobject Required
            Hide vocabulary attribute Show vocabulary attribute object
        • text_expansionobject
          Hide text_expansion attributes Show text_expansion attributes object
          • tokenizationobject

            Tokenization options stored in inference configuration

            Hide tokenization attributes Show tokenization attributes object
          • results_fieldstring

            The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.

          • vocabularyobject Required
            Hide vocabulary attribute Show vocabulary attribute object
        • question_answeringobject
          Hide question_answering attributes Show question_answering attributes object
      • inputobject Required
        Hide input attribute Show input attribute object
        • field_namesarray[string] Required

          An array of input field names for the model.

      • license_levelstring

        The license level of the trained model.

      • metadataobject
        Hide metadata attributes Show metadata attributes object

      • model_size_bytesnumber | string

        One of:
        ByteSizenumberByteSizestring
      • model_packageobject
        Hide model_package attributes Show model_package attributes object
      • locationobject
        Hide location attribute Show location attribute object
        • indexobject Required
          Hide index attribute Show index attribute object
      • platform_architecturestring
      • prefix_stringsobject
        Hide prefix_strings attributes Show prefix_strings attributes object
        • ingeststring

          String prepended to input at ingest

        • searchstring

          String prepended to input at search

GET /_ml/trained_models/{model_id}
curl \
 --request GET 'http://api.example.com/_ml/trained_models/{model_id}' \
 --header "Authorization: $API_KEY"