@elastic/schemas 0.5.1 → 0.6.0

package/src/es/json/ml._types.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"ml._types__RegressionInferenceOptions":{"type":"object","properties":{"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"num_top_feature_importance_values":{"type":"number","description":"Specifies the maximum number of feature importance values per document."}}},"ml._types__ClassificationInferenceOptions":{"type":"object","properties":{"num_top_classes":{"type":"number","description":"Specifies the number of top class predictions to return. Defaults to 0."},"num_top_feature_importance_values":{"type":"number","description":"Specifies the maximum number of feature importance values per document."},"prediction_field_type":{"type":"string","description":"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_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"top_classes_results_field":{"type":"string","description":"Specifies the field to which the top classes are written. Defaults to top_classes."}}},"ml._types__DatafeedState":{"enum":["started","stopped","starting","stopping"]},"ml._types__JobState":{"enum":["closing","closed","opened","failed","opening"]},"ml._types__MemoryStatus":{"enum":["ok","soft_limit","hard_limit"]},"ml._types__CategorizationStatus":{"enum":["ok","warn"]},"ml._types__AnalysisConfig":{"type":"object","properties":{"bucket_span":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The size of the interval that the analysis is aggregated into, typically between `5m` and `1h`. This value should be either a whole number of days or equate to a\nwhole number of buckets in one day. If the anomaly detection job uses a datafeed with aggregations, this value must also be divisible by the interval of the date histogram aggregation."},"categorization_analyzer":{"$ref":"./ml._types.json#/$defs/ml._types__CategorizationAnalyzer","description":"If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as `categorization_filters`. The categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process. The `categorization_analyzer` field can be specified either as a string or as an object. If it is a string, it must refer to a built-in analyzer or one added by another plugin."},"categorization_field_name":{"type":"string","description":"If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`."},"categorization_filters":{"type":"array","items":{"type":"string"},"description":"If `categorization_field_name` is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as `categorization_analyzer`. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the `categorization_analyzer` property instead and include the filters as pattern_replace character filters. The effect is exactly the same."},"detectors":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__Detector"},"description":"Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned."},"influencers":{"type":"array","items":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."},"description":"A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity."},"latency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is applicable only when you send data by using the post data API."},"model_prune_window":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the `bucket_span`. If set too low, important information may be removed from the model. For jobs created in 8.1 and later, the default value is the greater of `30d` or 20 times `bucket_span`."},"multivariate_by_fields":{"type":"boolean","description":"This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to `true`, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the `multivariate_by_fields` property, you must also specify `by_field_name` in your detector."},"per_partition_categorization":{"$ref":"./ml._types.json#/$defs/ml._types__PerPartitionCategorization","description":"Settings related to how categorization interacts with partition fields."},"summary_count_field_name":{"type":"string","description":"If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function."}},"required":["detectors"]},"ml._types__CategorizationAnalyzer":{"anyOf":[{"type":"string"},{"$ref":"./ml._types.json#/$defs/ml._types__CategorizationAnalyzerDefinition"}]},"ml._types__CategorizationAnalyzerDefinition":{"type":"object","properties":{"char_filter":{"type":"array","items":{"$ref":"./_types.analysis.json#/$defs/_types.analysis__CharFilter"},"description":"One or more character filters. In addition to the built-in character filters, other plugins can provide more character filters. If this property is not specified, no character filters are applied prior to categorization. If you are customizing some other aspect of the analyzer and you need to achieve the equivalent of `categorization_filters` (which are not permitted when some other aspect of the analyzer is customized), add them here as pattern replace character filters."},"filter":{"type":"array","items":{"$ref":"./_types.analysis.json#/$defs/_types.analysis__TokenFilter"},"description":"One or more token filters. In addition to the built-in token filters, other plugins can provide more token filters. If this property is not specified, no token filters are applied prior to categorization."},"tokenizer":{"$ref":"./_types.analysis.json#/$defs/_types.analysis__Tokenizer","description":"The name or definition of the tokenizer to use after character filters are applied. This property is compulsory if `categorization_analyzer` is specified as an object. Machine learning provides a tokenizer called `ml_standard` that tokenizes in a way that has been determined to produce good categorization results on a variety of log file formats for logs in English. If you want to use that tokenizer but change the character or token filters, specify \"tokenizer\": \"ml_standard\" in your `categorization_analyzer`. Additionally, the `ml_classic` tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2). `ml_classic` was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify \"tokenizer\": \"ml_classic\" in your `categorization_analyzer`."}}},"ml._types__Detector":{"type":"object","properties":{"by_field_name":{"type":"string","description":"The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split."},"custom_rules":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__DetectionRule"},"description":"Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules."},"detector_description":{"type":"string","description":"A description of the detector."},"detector_index":{"type":"number","description":"A unique identifier for the detector. This identifier is based on the order of the detectors in the `analysis_config`, starting at zero. If you specify a value for this property, it is ignored."},"exclude_frequent":{"$ref":"./ml._types.json#/$defs/ml._types__ExcludeFrequent","description":"If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set `exclude_frequent` to `all` for both fields, or to `by` or `over` for those specific fields."},"field_name":{"type":"string","description":"The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes."},"function":{"type":"string","description":"The analysis function that is used. For example, `count`, `rare`, `mean`, `min`, `max`, or `sum`."},"over_field_name":{"type":"string","description":"The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits."},"partition_field_name":{"type":"string","description":"The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field."},"use_null":{"type":"boolean","description":"Defines whether a new series is used as the null series when there is no value for the by or partition fields."}}},"ml._types__DetectionRule":{"type":"object","properties":{"actions":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__RuleAction"},"description":"The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined."},"conditions":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__RuleCondition"},"description":"An array of numeric conditions when the rule applies. A rule must either have a non-empty scope or at least one condition. Multiple conditions are combined together with a logical AND."},"scope":{"type":"object","additionalProperties":{"$ref":"./ml._types.json#/$defs/ml._types__FilterRef"},"description":"A scope of series where the rule applies. A rule must either have a non-empty scope or at least one condition. By default, the scope includes all series. Scoping is allowed for any of the fields that are also specified in `by_field_name`, `over_field_name`, or `partition_field_name`."}}},"ml._types__RuleAction":{"enum":["skip_result","skip_model_update"]},"ml._types__RuleCondition":{"type":"object","properties":{"applies_to":{"$ref":"./ml._types.json#/$defs/ml._types__AppliesTo","description":"Specifies the result property to which the condition applies. If your detector uses `lat_long`, `metric`, `rare`, or `freq_rare` functions, you can only specify conditions that apply to time."},"operator":{"$ref":"./ml._types.json#/$defs/ml._types__ConditionOperator","description":"Specifies the condition operator. The available options are greater than, greater than or equals, less than, and less than or equals."},"value":{"type":"number","description":"The value that is compared against the `applies_to` field using the operator."}},"required":["applies_to","operator","value"]},"ml._types__AppliesTo":{"enum":["actual","typical","diff_from_typical","time"]},"ml._types__ConditionOperator":{"enum":["gt","gte","lt","lte"]},"ml._types__FilterRef":{"type":"object","properties":{"filter_id":{"type":"string","description":"The identifier for the filter."},"filter_type":{"$ref":"./ml._types.json#/$defs/ml._types__FilterType","description":"If set to `include`, the rule applies for values in the filter. If set to `exclude`, the rule applies for values not in the filter."}},"required":["filter_id"]},"ml._types__FilterType":{"enum":["include","exclude"]},"ml._types__ExcludeFrequent":{"enum":["all","none","by","over"]},"ml._types__PerPartitionCategorization":{"type":"object","properties":{"enabled":{"type":"boolean","description":"To enable this setting, you must also set the `partition_field_name` property to the same value in every detector that uses the keyword `mlcategory`. Otherwise, job creation fails."},"stop_on_warn":{"type":"boolean","description":"This setting can be set to true only if per-partition categorization is enabled. If true, both categorization and subsequent anomaly detection stops for partitions where the categorization status changes to warn. This setting makes it viable to have a job where it is expected that categorization works well for some partitions but not others; you do not pay the cost of bad categorization forever in the partitions where it works badly."}}},"ml._types__DataframeEvaluationContainer":{"type":"object","properties":{"classification":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeEvaluationClassification","description":"Classification evaluation evaluates the results of a classification analysis which outputs a prediction that identifies to which of the classes each document belongs."},"outlier_detection":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeEvaluationOutlierDetection","description":"Outlier detection evaluates the results of an outlier detection analysis which outputs the probability that each document is an outlier."},"regression":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeEvaluationRegression","description":"Regression evaluation evaluates the results of a regression analysis which outputs a prediction of values."}}},"ml._types__DataframeEvaluationClassification":{"type":"object","properties":{"actual_field":{"type":"string","description":"The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true)."},"predicted_field":{"type":"string","description":"The field in the index which contains the predicted value, in other words the results of the classification analysis."},"top_classes_field":{"type":"string","description":"The field of the index which is an array of documents of the form { \"class_name\": XXX, \"class_probability\": YYY }. This field must be defined as nested in the mappings."},"metrics":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeEvaluationClassificationMetrics","description":"Specifies the metrics that are used for the evaluation."}},"required":["actual_field"]},"ml._types__DataframeEvaluationClassificationMetrics":{"type":"object","properties":{"auc_roc":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeEvaluationClassificationMetricsAucRoc","description":"The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as \"class_name\") treated as positive."},"precision":{"type":"object","additionalProperties":{},"description":"Precision of predictions (per-class and average)."},"recall":{"type":"object","additionalProperties":{},"description":"Recall of predictions (per-class and average)."},"accuracy":{"type":"object","additionalProperties":{},"description":"Accuracy of predictions (per-class and overall)."},"multiclass_confusion_matrix":{"type":"object","additionalProperties":{},"description":"Multiclass confusion matrix."}}},"ml._types__DataframeEvaluationClassificationMetricsAucRoc":{"type":"object","properties":{"class_name":{"type":"string","description":"Name of the only class that is treated as positive during AUC ROC calculation. Other classes are treated as negative (\"one-vs-all\" strategy). All the evaluated documents must have class_name in the list of their top classes."},"include_curve":{"type":"boolean","description":"Whether or not the curve should be returned in addition to the score. Default value is false."}}},"ml._types__DataframeEvaluationOutlierDetection":{"type":"object","properties":{"actual_field":{"type":"string","description":"The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true)."},"predicted_probability_field":{"type":"string","description":"The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis."},"metrics":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeEvaluationOutlierDetectionMetrics","description":"Specifies the metrics that are used for the evaluation."}},"required":["actual_field","predicted_probability_field"]},"ml._types__DataframeEvaluationOutlierDetectionMetrics":{"type":"object","properties":{"auc_roc":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeEvaluationClassificationMetricsAucRoc","description":"The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as \"class_name\") treated as positive."},"precision":{"type":"object","additionalProperties":{},"description":"Precision of predictions (per-class and average)."},"recall":{"type":"object","additionalProperties":{},"description":"Recall of predictions (per-class and average)."},"confusion_matrix":{"type":"object","additionalProperties":{},"description":"Accuracy of predictions (per-class and overall)."}}},"ml._types__DataframeEvaluationRegression":{"type":"object","properties":{"actual_field":{"type":"string","description":"The field of the index which contains the ground truth. The data type of this field must be numerical."},"predicted_field":{"type":"string","description":"The field in the index that contains the predicted value, in other words the results of the regression analysis."},"metrics":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeEvaluationRegressionMetrics","description":"Specifies the metrics that are used for the evaluation. For more information on mse, msle, and huber, consult the Jupyter notebook on regression loss functions."}},"required":["actual_field","predicted_field"]},"ml._types__DataframeEvaluationRegressionMetrics":{"type":"object","properties":{"mse":{"type":"object","additionalProperties":{},"description":"Average squared difference between the predicted values and the actual (ground truth) value. For more information, read this wiki article."},"msle":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeEvaluationRegressionMetricsMsle","description":"Average squared difference between the logarithm of the predicted values and the logarithm of the actual (ground truth) value."},"huber":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeEvaluationRegressionMetricsHuber","description":"Pseudo Huber loss function."},"r_squared":{"type":"object","additionalProperties":{},"description":"Proportion of the variance in the dependent variable that is predictable from the independent variables."}}},"ml._types__DataframeEvaluationRegressionMetricsMsle":{"type":"object","properties":{"offset":{"type":"number","description":"Defines the transition point at which you switch from minimizing quadratic error to minimizing quadratic log error. Defaults to 1."}}},"ml._types__DataframeEvaluationRegressionMetricsHuber":{"type":"object","properties":{"delta":{"type":"number","description":"Approximates 1/2 (prediction - actual)2 for values much less than delta and approximates a straight line with slope delta for values much larger than delta. Defaults to 1. Delta needs to be greater than 0."}}},"ml._types__DataframeAnalyticsSource":{"type":"object","properties":{"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index."},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {\"match_all\": {}}."},"runtime_mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RuntimeFields","description":"Definitions of runtime fields that will become part of the mapping of the destination index."},"_source":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisAnalyzedFields","description":"Specify `includes` and/or `excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis."}},"required":["index"]},"ml._types__DataframeAnalysisAnalyzedFields":{"type":"object","properties":{"includes":{"type":"array","items":{"type":"string"},"description":"An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically."},"excludes":{"type":"array","items":{"type":"string"},"description":"An array of strings that defines the fields that will be included in the analysis."}}},"ml._types__DataframeAnalyticsDestination":{"type":"object","properties":{"index":{"type":"string","description":"Defines the destination index to store the results of the data frame analytics job."},"results_field":{"type":"string","description":"Defines the name of the field in which to store the results of the analysis. Defaults to `ml`."}},"required":["index"]},"ml._types__DataframeAnalysisContainer":{"type":"object","properties":{"classification":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisClassification","description":"The configuration information necessary to perform classification."},"outlier_detection":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisOutlierDetection","description":"The configuration information necessary to perform outlier detection. NOTE: Advanced parameters are for fine-tuning classification analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters."},"regression":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisRegression","description":"The configuration information necessary to perform regression. NOTE: Advanced parameters are for fine-tuning regression analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters."}}},"ml._types__DataframeAnalysisClassification":{"type":"object","properties":{"alpha":{"type":"number","description":"Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero."},"dependent_variable":{"type":"string","description":"Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable.\nFor classification analysis, the data type of the field must be numeric (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or `boolean`. There must be no more than 30 different values in this field.\nFor regression analysis, the data type of the field must be numeric."},"downsample_factor":{"type":"number","description":"Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1."},"early_stopping_enabled":{"type":"boolean","description":"Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable."},"eta":{"type":"number","description":"Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1."},"eta_growth_rate_per_tree":{"type":"number","description":"Advanced configuration option. Specifies the rate at which `eta` increases for each new tree that is added to the forest. For example, a rate of 1.05 increases `eta` by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2."},"feature_bag_fraction":{"type":"number","description":"Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization."},"feature_processors":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisFeatureProcessor"},"description":"Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple `feature_processors` entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields."},"gamma":{"type":"number","description":"Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value."},"lambda":{"type":"number","description":"Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value."},"max_optimization_rounds_per_hyperparameter":{"type":"number","description":"Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization."},"max_trees":{"type":"number","description":"Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization."},"num_top_feature_importance_values":{"type":"number","description":"Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs."},"prediction_field_name":{"type":"string","description":"Defines the name of the prediction field in the results. Defaults to `<dependent_variable>_prediction`."},"randomize_seed":{"type":"number","description":"Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as `source` and `analyzed_fields` are the same)."},"soft_tree_depth_limit":{"type":"number","description":"Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0."},"soft_tree_depth_tolerance":{"type":"number","description":"Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01."},"training_percent":{"$ref":"./_types.json#/$defs/_types__Percentage","description":"Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage."},"class_assignment_objective":{"type":"string"},"num_top_classes":{"type":"number","description":"Defines the number of categories for which the predicted probabilities are reported. It must be non-negative or -1. If it is -1 or greater than the total number of categories, probabilities are reported for all categories; if you have a large number of categories, there could be a significant effect on the size of your destination index. NOTE: To use the AUC ROC evaluation method, `num_top_classes` must be set to -1 or a value greater than or equal to the total number of categories."}},"required":["dependent_variable"]},"ml._types__DataframeAnalysisFeatureProcessor":{"type":"object","properties":{"frequency_encoding":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisFeatureProcessorFrequencyEncoding","description":"The configuration information necessary to perform frequency encoding."},"multi_encoding":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisFeatureProcessorMultiEncoding","description":"The configuration information necessary to perform multi encoding. It allows multiple processors to be changed together. This way the output of a processor can then be passed to another as an input."},"n_gram_encoding":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisFeatureProcessorNGramEncoding","description":"The configuration information necessary to perform n-gram encoding. Features created by this encoder have the following name format: <feature_prefix>.<ngram><string position>. For example, if the feature_prefix is f, the feature name for the second unigram in a string is f.11."},"one_hot_encoding":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisFeatureProcessorOneHotEncoding","description":"The configuration information necessary to perform one hot encoding."},"target_mean_encoding":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisFeatureProcessorTargetMeanEncoding","description":"The configuration information necessary to perform target mean encoding."}}},"ml._types__DataframeAnalysisFeatureProcessorFrequencyEncoding":{"type":"object","properties":{"feature_name":{"type":"string","description":"The resulting feature name."},"field":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."},"frequency_map":{"type":"object","additionalProperties":{"type":"number"},"description":"The resulting frequency map for the field value. If the field value is missing from the frequency_map, the resulting value is 0."}},"required":["feature_name","field","frequency_map"]},"ml._types__DataframeAnalysisFeatureProcessorMultiEncoding":{"type":"object","properties":{"processors":{"type":"array","items":{"type":"number"},"description":"The ordered array of custom processors to execute. Must be more than 1."}},"required":["processors"]},"ml._types__DataframeAnalysisFeatureProcessorNGramEncoding":{"type":"object","properties":{"feature_prefix":{"type":"string","description":"The feature name prefix. Defaults to ngram_<start>_<length>."},"field":{"type":"string","description":"The name of the text field to encode."},"length":{"type":"number","description":"Specifies the length of the n-gram substring. Defaults to 50. Must be greater than 0."},"n_grams":{"type":"array","items":{"type":"number"},"description":"Specifies which n-grams to gather. It’s an array of integer values where the minimum value is 1, and a maximum value is 5."},"start":{"type":"number","description":"Specifies the zero-indexed start of the n-gram substring. Negative values are allowed for encoding n-grams of string suffixes. Defaults to 0."},"custom":{"type":"boolean"}},"required":["field","n_grams"]},"ml._types__DataframeAnalysisFeatureProcessorOneHotEncoding":{"type":"object","properties":{"field":{"type":"string","description":"The name of the field to encode."},"hot_map":{"type":"string","description":"The one hot map mapping the field value with the column name."}},"required":["field","hot_map"]},"ml._types__DataframeAnalysisFeatureProcessorTargetMeanEncoding":{"type":"object","properties":{"default_value":{"type":"number","description":"The default value if field value is not found in the target_map."},"feature_name":{"type":"string","description":"The resulting feature name."},"field":{"type":"string","description":"The name of the field to encode."},"target_map":{"type":"object","additionalProperties":{},"description":"The field value to target mean transition map."}},"required":["default_value","feature_name","field","target_map"]},"ml._types__DataframeAnalysisOutlierDetection":{"type":"object","properties":{"compute_feature_influence":{"type":"boolean","description":"Specifies whether the feature influence calculation is enabled."},"feature_influence_threshold":{"type":"number","description":"The minimum outlier score that a document needs to have in order to calculate its feature influence score. Value range: 0-1."},"method":{"type":"string","description":"The method that outlier detection uses. Available methods are `lof`, `ldof`, `distance_kth_nn`, `distance_knn`, and `ensemble`. The default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score."},"n_neighbors":{"type":"number","description":"Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score. When the value is not set, different values are used for different ensemble members. This default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set."},"outlier_fraction":{"type":"number","description":"The proportion of the data set that is assumed to be outlying prior to outlier detection. For example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers."},"standardization_enabled":{"type":"boolean","description":"If true, the following operation is performed on the columns before computing outlier scores: `(x_i - mean(x_i)) / sd(x_i)`."}}},"ml._types__DataframeAnalysisRegression":{"type":"object","properties":{"alpha":{"type":"number","description":"Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero."},"dependent_variable":{"type":"string","description":"Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable.\nFor classification analysis, the data type of the field must be numeric (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or `boolean`. There must be no more than 30 different values in this field.\nFor regression analysis, the data type of the field must be numeric."},"downsample_factor":{"type":"number","description":"Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1."},"early_stopping_enabled":{"type":"boolean","description":"Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable."},"eta":{"type":"number","description":"Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1."},"eta_growth_rate_per_tree":{"type":"number","description":"Advanced configuration option. Specifies the rate at which `eta` increases for each new tree that is added to the forest. For example, a rate of 1.05 increases `eta` by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2."},"feature_bag_fraction":{"type":"number","description":"Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization."},"feature_processors":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisFeatureProcessor"},"description":"Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple `feature_processors` entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields."},"gamma":{"type":"number","description":"Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value."},"lambda":{"type":"number","description":"Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value."},"max_optimization_rounds_per_hyperparameter":{"type":"number","description":"Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization."},"max_trees":{"type":"number","description":"Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization."},"num_top_feature_importance_values":{"type":"number","description":"Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs."},"prediction_field_name":{"type":"string","description":"Defines the name of the prediction field in the results. Defaults to `<dependent_variable>_prediction`."},"randomize_seed":{"type":"number","description":"Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as `source` and `analyzed_fields` are the same)."},"soft_tree_depth_limit":{"type":"number","description":"Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0."},"soft_tree_depth_tolerance":{"type":"number","description":"Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01."},"training_percent":{"$ref":"./_types.json#/$defs/_types__Percentage","description":"Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage."},"loss_function":{"type":"string","description":"The loss function used during regression. Available options are `mse` (mean squared error), `msle` (mean squared logarithmic error), `huber` (Pseudo-Huber loss)."},"loss_function_parameter":{"type":"number","description":"A positive number that is used as a parameter to the `loss_function`."}},"required":["dependent_variable"]},"ml._types__DataframeAnalyticsFieldSelection":{"type":"object","properties":{"is_included":{"type":"boolean","description":"Whether the field is selected to be included in the analysis."},"is_required":{"type":"boolean","description":"Whether the field is required."},"feature_type":{"type":"string","description":"The feature type of this field for the analysis. May be categorical or numerical."},"mapping_types":{"type":"array","items":{"type":"string"},"description":"The mapping types of the field."},"name":{"type":"string","description":"The field name."},"reason":{"type":"string","description":"The reason a field is not selected to be included in the analysis."}},"required":["is_included","is_required","mapping_types","name"]},"ml._types__DataframeAnalyticsMemoryEstimation":{"type":"object","properties":{"expected_memory_with_disk":{"type":"string","description":"Estimated memory usage under the assumption that overflowing to disk is allowed during data frame analytics. expected_memory_with_disk is usually smaller than expected_memory_without_disk as using disk allows to limit the main memory needed to perform data frame analytics."},"expected_memory_without_disk":{"type":"string","description":"Estimated memory usage under the assumption that the whole data frame analytics should happen in memory (i.e. without overflowing to disk)."}},"required":["expected_memory_with_disk","expected_memory_without_disk"]},"ml._types__Page":{"type":"object","properties":{"from":{"type":"number","description":"Skips the specified number of items."},"size":{"type":"number","description":"Specifies the maximum number of items to obtain."}}},"ml._types__BucketSummary":{"type":"object","properties":{"anomaly_score":{"type":"number","description":"The maximum anomaly score, between 0-100, for any of the bucket influencers. This is an overall, rate-limited\nscore for the job. All the anomaly records in the bucket contribute to this score. This value might be updated as\nnew data is analyzed."},"bucket_influencers":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__BucketInfluencer"}},"bucket_span":{"description":"The length of the bucket in seconds. This value matches the bucket span that is specified in the job."},"event_count":{"type":"number","description":"The number of input data records processed in this bucket."},"initial_anomaly_score":{"type":"number","description":"The maximum anomaly score for any of the bucket influencers. This is the initial value that was calculated at the\ntime the bucket was processed."},"is_interim":{"type":"boolean","description":"If true, this is an interim result. In other words, the results are calculated based on partial input data."},"job_id":{"type":"string","description":"Identifier for the anomaly detection job."},"processing_time_ms":{"description":"The amount of time, in milliseconds, that it took to analyze the bucket contents and calculate results."},"result_type":{"type":"string","description":"Internal. This value is always set to bucket."},"timestamp":{"description":"The start time of the bucket. This timestamp uniquely identifies the bucket. Events that occur exactly at the\ntimestamp of the bucket are included in the results for the bucket."},"timestamp_string":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The start time of the bucket. This timestamp uniquely identifies the bucket. Events that occur exactly at the\ntimestamp of the bucket are included in the results for the bucket."}},"required":["anomaly_score","bucket_influencers","bucket_span","event_count","initial_anomaly_score","is_interim","job_id","processing_time_ms","result_type","timestamp"]},"ml._types__BucketInfluencer":{"type":"object","properties":{"anomaly_score":{"type":"number","description":"A normalized score between 0-100, which is calculated for each bucket influencer. This score might be updated as\nnewer data is analyzed."},"bucket_span":{"description":"The length of the bucket in seconds. This value matches the bucket span that is specified in the job."},"influencer_field_name":{"type":"string","description":"The field name of the influencer."},"initial_anomaly_score":{"type":"number","description":"The score between 0-100 for each bucket influencer. This score is the initial value that was calculated at the\ntime the bucket was processed."},"is_interim":{"type":"boolean","description":"If true, this is an interim result. In other words, the results are calculated based on partial input data."},"job_id":{"type":"string","description":"Identifier for the anomaly detection job."},"probability":{"type":"number","description":"The probability that the bucket has this behavior, in the range 0 to 1. This value can be held to a high precision\nof over 300 decimal places, so the `anomaly_score` is provided as a human-readable and friendly interpretation of\nthis."},"raw_anomaly_score":{"type":"number","description":"Internal."},"result_type":{"type":"string","description":"Internal. This value is always set to `bucket_influencer`."},"timestamp":{"description":"The start time of the bucket for which these results were calculated."},"timestamp_string":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The start time of the bucket for which these results were calculated."}},"required":["anomaly_score","bucket_span","influencer_field_name","initial_anomaly_score","is_interim","job_id","probability","raw_anomaly_score","result_type","timestamp"]},"ml._types__CalendarEvent":{"type":"object","properties":{"calendar_id":{"type":"string","description":"A string that uniquely identifies a calendar."},"event_id":{"type":"string"},"description":{"type":"string","description":"A description of the scheduled event."},"end_time":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The timestamp for the end of the scheduled event in milliseconds since the epoch or ISO 8601 format."},"start_time":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format."},"skip_result":{"type":"boolean","description":"When true the model will not create results for this calendar period."},"skip_model_update":{"type":"boolean","description":"When true the model will not be updated for this calendar period."},"force_time_shift":{"type":"number","description":"Shift time by this many seconds. For example adjust time for daylight savings changes"}},"required":["description","end_time","start_time"]},"ml._types__Category":{"type":"object","properties":{"category_id":{"type":"number","description":"A unique identifier for the category. category_id is unique at the job level, even when per-partition categorization is enabled."},"examples":{"type":"array","items":{"type":"string"},"description":"A list of examples of actual values that matched the category."},"grok_pattern":{"type":"string","description":"[experimental] A Grok pattern that could be used in Logstash or an ingest pipeline to extract fields from messages that match the category. This field is experimental and may be changed or removed in a future release. The Grok patterns that are found are not optimal, but are often a good starting point for manual tweaking."},"job_id":{"type":"string","description":"Identifier for the anomaly detection job."},"max_matching_length":{"type":"number","description":"The maximum length of the fields that matched the category. The value is increased by 10% to enable matching for similar fields that have not been analyzed."},"partition_field_name":{"type":"string","description":"If per-partition categorization is enabled, this property identifies the field used to segment the categorization. It is not present when per-partition categorization is disabled."},"partition_field_value":{"type":"string","description":"If per-partition categorization is enabled, this property identifies the value of the partition_field_name for the category. It is not present when per-partition categorization is disabled."},"regex":{"type":"string","description":"A regular expression that is used to search for values that match the category."},"terms":{"type":"string","description":"A space separated list of the common tokens that are matched in values of the category."},"num_matches":{"type":"number","description":"The number of messages that have been matched by this category. This is only guaranteed to have the latest accurate count after a job _flush or _close"},"preferred_to_categories":{"type":"array","items":{"type":"string"},"description":"A list of category_id entries that this current category encompasses. Any new message that is processed by the categorizer will match against this category and not any of the categories in this list. This is only guaranteed to have the latest accurate list of categories after a job _flush or _close"},"p":{"type":"string"},"result_type":{"type":"string"},"mlcategory":{"type":"string"}},"required":["category_id","examples","job_id","max_matching_length","regex","terms","result_type","mlcategory"]},"ml._types__DataframeAnalyticsSummary":{"type":"object","properties":{"allow_lazy_start":{"type":"boolean"},"analysis":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisContainer"},"analyzed_fields":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisAnalyzedFields"},"authorization":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalyticsAuthorization","description":"The security privileges that the job uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the job, this property is omitted."},"create_time":{},"description":{"type":"string"},"dest":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalyticsDestination"},"id":{"type":"string"},"max_num_threads":{"type":"number"},"model_memory_limit":{"type":"string"},"source":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalyticsSource"},"version":{"type":"string"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata"}},"required":["analysis","dest","id","source"]},"ml._types__DataframeAnalyticsAuthorization":{"type":"object","properties":{"api_key":{"$ref":"./ml._types.json#/$defs/ml._types__ApiKeyAuthorization","description":"If an API key was used for the most recent update to the job, its name and identifier are listed in the response."},"roles":{"type":"array","items":{"type":"string"},"description":"If a user ID was used for the most recent update to the job, its roles at the time of the update are listed in the response."},"service_account":{"type":"string","description":"If a service account was used for the most recent update to the job, the account name is listed in the response."}}},"ml._types__ApiKeyAuthorization":{"type":"object","properties":{"id":{"type":"string","description":"The identifier for the API key."},"name":{"type":"string","description":"The name of the API key."}},"required":["id","name"]},"ml._types__DataframeAnalytics":{"type":"object","properties":{"analysis_stats":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalyticsStatsContainer","description":"An object containing information about the analysis job."},"assignment_explanation":{"type":"string","description":"For running jobs only, contains messages relating to the selection of a node to run the job."},"data_counts":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalyticsStatsDataCounts","description":"An object that provides counts for the quantity of documents skipped, used in training, or available for testing."},"id":{"type":"string","description":"The unique identifier of the data frame analytics job."},"memory_usage":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalyticsStatsMemoryUsage","description":"An object describing memory usage of the analytics. It is present only after the job is started and memory usage is reported."},"node":{"$ref":"./_types.json#/$defs/_types__NodeAttributes","description":"Contains properties for the node that runs the job. This information is available only for running jobs.","x-availability":{"stack":{}}},"progress":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalyticsStatsProgress"},"description":"The progress report of the data frame analytics job by phase."},"state":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeState","description":"The status of the data frame analytics job, which can be one of the following values: failed, started, starting, stopping, stopped."}},"required":["data_counts","id","memory_usage","progress","state"]},"ml._types__DataframeAnalyticsStatsContainer":{"type":"object","properties":{"classification_stats":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalyticsStatsHyperparameters","description":"An object containing information about the classification analysis job."},"outlier_detection_stats":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalyticsStatsOutlierDetection","description":"An object containing information about the outlier detection job."},"regression_stats":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalyticsStatsHyperparameters","description":"An object containing information about the regression analysis."}}},"ml._types__DataframeAnalyticsStatsHyperparameters":{"type":"object","properties":{"hyperparameters":{"$ref":"./ml._types.json#/$defs/ml._types__Hyperparameters","description":"An object containing the parameters of the classification analysis job."},"iteration":{"type":"number","description":"The number of iterations on the analysis."},"timestamp":{"description":"The timestamp when the statistics were reported in milliseconds since the epoch."},"timing_stats":{"$ref":"./ml._types.json#/$defs/ml._types__TimingStats","description":"An object containing time statistics about the data frame analytics job."},"validation_loss":{"$ref":"./ml._types.json#/$defs/ml._types__ValidationLoss","description":"An object containing information about validation loss."}},"required":["hyperparameters","iteration","timestamp","timing_stats","validation_loss"]},"ml._types__Hyperparameters":{"type":"object","properties":{"alpha":{"type":"number","description":"Advanced configuration option.\nMachine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly.\nThis parameter affects loss calculations by acting as a multiplier of the tree depth.\nHigher alpha values result in shallower trees and faster training times.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be greater than or equal to zero."},"lambda":{"type":"number","description":"Advanced configuration option.\nRegularization parameter to prevent overfitting on the training data set.\nMultiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest.\nA high lambda value causes training to favor small leaf weights.\nThis behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable.\nA small lambda value results in large individual trees and slower training.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be a nonnegative value."},"gamma":{"type":"number","description":"Advanced configuration option.\nRegularization parameter to prevent overfitting on the training data set.\nMultiplies a linear penalty associated with the size of individual trees in the forest.\nA high gamma value causes training to prefer small trees.\nA small gamma value results in larger individual trees and slower training.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be a nonnegative value."},"eta":{"type":"number","description":"Advanced configuration option.\nThe shrinkage applied to the weights.\nSmaller values result in larger forests which have a better generalization error.\nHowever, larger forests cause slower training.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be a value between `0.001` and `1`."},"eta_growth_rate_per_tree":{"type":"number","description":"Advanced configuration option.\nSpecifies the rate at which `eta` increases for each new tree that is added to the forest.\nFor example, a rate of 1.05 increases `eta` by 5% for each extra tree.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be between `0.5` and `2`."},"feature_bag_fraction":{"type":"number","description":"Advanced configuration option.\nDefines the fraction of features that will be used when selecting a random bag for each candidate split.\nBy default, this value is calculated during hyperparameter optimization."},"downsample_factor":{"type":"number","description":"Advanced configuration option.\nControls the fraction of data that is used to compute the derivatives of the loss function for tree training.\nA small value results in the use of a small fraction of the data.\nIf this value is set to be less than 1, accuracy typically improves.\nHowever, too small a value may result in poor convergence for the ensemble and so require more trees.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be greater than zero and less than or equal to 1."},"max_attempts_to_add_tree":{"type":"number","description":"If the algorithm fails to determine a non-trivial tree (more than a single leaf), this parameter determines how many of such consecutive failures are tolerated.\nOnce the number of attempts exceeds the threshold, the forest training stops."},"max_optimization_rounds_per_hyperparameter":{"type":"number","description":"Advanced configuration option.\nA multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure.\nThe maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter.\nBy default, this value is calculated during hyperparameter optimization."},"max_trees":{"type":"number","description":"Advanced configuration option.\nDefines the maximum number of decision trees in the forest.\nThe maximum value is 2000.\nBy default, this value is calculated during hyperparameter optimization."},"num_folds":{"type":"number","description":"The maximum number of folds for the cross-validation procedure."},"num_splits_per_feature":{"type":"number","description":"Determines the maximum number of splits for every feature that can occur in a decision tree when the tree is trained."},"soft_tree_depth_limit":{"type":"number","description":"Advanced configuration option.\nMachine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly.\nThis soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be greater than or equal to 0."},"soft_tree_depth_tolerance":{"type":"number","description":"Advanced configuration option.\nThis option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be greater than or equal to 0.01."}}},"ml._types__TimingStats":{"type":"object","properties":{"elapsed_time":{"description":"Runtime of the analysis in milliseconds."},"iteration_time":{"description":"Runtime of the latest iteration of the analysis in milliseconds."}},"required":["elapsed_time"]},"ml._types__ValidationLoss":{"type":"object","properties":{"fold_values":{"type":"array","items":{"type":"string"},"description":"Validation loss values for every added decision tree during the forest growing procedure."},"loss_type":{"type":"string","description":"The type of the loss metric. For example, binomial_logistic."}},"required":["fold_values","loss_type"]},"ml._types__DataframeAnalyticsStatsOutlierDetection":{"type":"object","properties":{"parameters":{"$ref":"./ml._types.json#/$defs/ml._types__OutlierDetectionParameters","description":"The list of job parameters specified by the user or determined by algorithmic heuristics."},"timestamp":{"description":"The timestamp when the statistics were reported in milliseconds since the epoch."},"timing_stats":{"$ref":"./ml._types.json#/$defs/ml._types__TimingStats","description":"An object containing time statistics about the data frame analytics job."}},"required":["parameters","timestamp","timing_stats"]},"ml._types__OutlierDetectionParameters":{"type":"object","properties":{"compute_feature_influence":{"type":"boolean","description":"Specifies whether the feature influence calculation is enabled."},"feature_influence_threshold":{"type":"number","description":"The minimum outlier score that a document needs to have in order to calculate its feature influence score.\nValue range: 0-1"},"method":{"type":"string","description":"The method that outlier detection uses.\nAvailable methods are `lof`, `ldof`, `distance_kth_nn`, `distance_knn`, and `ensemble`.\nThe default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score."},"n_neighbors":{"type":"number","description":"Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score.\nWhen the value is not set, different values are used for different ensemble members.\nThis default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set."},"outlier_fraction":{"type":"number","description":"The proportion of the data set that is assumed to be outlying prior to outlier detection.\nFor example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers."},"standardization_enabled":{"type":"boolean","description":"If `true`, the following operation is performed on the columns before computing outlier scores: (x_i - mean(x_i)) / sd(x_i)."}}},"ml._types__DataframeAnalyticsStatsDataCounts":{"type":"object","properties":{"skipped_docs_count":{"type":"number","description":"The number of documents that are skipped during the analysis because they contained values that are not supported by the analysis. For example, outlier detection does not support missing fields so it skips documents with missing fields. Likewise, all types of analysis skip documents that contain arrays with more than one element."},"test_docs_count":{"type":"number","description":"The number of documents that are not used for training the model and can be used for testing."},"training_docs_count":{"type":"number","description":"The number of documents that are used for training the model."}},"required":["skipped_docs_count","test_docs_count","training_docs_count"]},"ml._types__DataframeAnalyticsStatsMemoryUsage":{"type":"object","properties":{"memory_reestimate_bytes":{"type":"number","description":"This value is present when the status is hard_limit and it is a new estimate of how much memory the job needs."},"peak_usage_bytes":{"type":"number","description":"The number of bytes used at the highest peak of memory usage."},"status":{"type":"string","description":"The memory usage status."},"timestamp":{"description":"The timestamp when memory usage was calculated."}},"required":["peak_usage_bytes","status"]},"ml._types__DataframeAnalyticsStatsProgress":{"type":"object","properties":{"phase":{"type":"string","description":"Defines the phase of the data frame analytics job."},"progress_percent":{"type":"number","description":"The progress that the data frame analytics job has made expressed in percentage."}},"required":["phase","progress_percent"]},"ml._types__DataframeState":{"enum":["started","stopped","starting","stopping","failed"]},"ml._types__DatafeedStats":{"type":"object","properties":{"assignment_explanation":{"type":"string","description":"For started datafeeds only, contains messages relating to the selection of a node."},"datafeed_id":{"type":"string","description":"A numerical character string that uniquely identifies the datafeed.\nThis identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.\nIt must start and end with alphanumeric characters."},"node":{"$ref":"./ml._types.json#/$defs/ml._types__DiscoveryNodeCompact","description":"For started datafeeds only, this information pertains to the node upon which the datafeed is started.","x-availability":{"stack":{}}},"state":{"$ref":"./ml._types.json#/$defs/ml._types__DatafeedState","description":"The status of the datafeed, which can be one of the following values: `starting`, `started`, `stopping`, `stopped`."},"timing_stats":{"$ref":"./ml._types.json#/$defs/ml._types__DatafeedTimingStats","description":"An object that provides statistical information about timing aspect of this datafeed."},"running_state":{"$ref":"./ml._types.json#/$defs/ml._types__DatafeedRunningState","description":"An object containing the running state for this datafeed.\nIt is only provided if the datafeed is started."}},"required":["datafeed_id","state"]},"ml._types__DiscoveryNodeCompact":{"type":"object","properties":{"name":{"type":"string"},"ephemeral_id":{"type":"string"},"id":{"type":"string"},"transport_address":{"type":"string"},"attributes":{"type":"object","additionalProperties":{"type":"string"}}},"required":["name","ephemeral_id","id","transport_address","attributes"],"description":"Alternative representation of DiscoveryNode used in ml.get_job_stats and ml.get_datafeed_stats"},"ml._types__DatafeedTimingStats":{"type":"object","properties":{"bucket_count":{"type":"number","description":"The number of buckets processed."},"exponential_average_search_time_per_hour_ms":{"description":"The exponential average search time per hour, in milliseconds."},"exponential_average_calculation_context":{"$ref":"./ml._types.json#/$defs/ml._types__ExponentialAverageCalculationContext"},"job_id":{"type":"string","description":"Identifier for the anomaly detection job."},"search_count":{"type":"number","description":"The number of searches run by the datafeed."},"total_search_time_ms":{"description":"The total time the datafeed spent searching, in milliseconds."},"average_search_time_per_bucket_ms":{"description":"The average search time per bucket, in milliseconds."}},"required":["bucket_count","exponential_average_search_time_per_hour_ms","job_id","search_count","total_search_time_ms"]},"ml._types__ExponentialAverageCalculationContext":{"type":"object","properties":{"incremental_metric_value_ms":{},"latest_timestamp":{},"previous_exponential_average_ms":{}},"required":["incremental_metric_value_ms"]},"ml._types__DatafeedRunningState":{"type":"object","properties":{"real_time_configured":{"type":"boolean","description":"Indicates if the datafeed is \"real-time\"; meaning that the datafeed has no configured `end` time."},"real_time_running":{"type":"boolean","description":"Indicates whether the datafeed has finished running on the available past data.\nFor datafeeds without a configured `end` time, this means that the datafeed is now running on \"real-time\" data."},"search_interval":{"$ref":"./ml._types.json#/$defs/ml._types__RunningStateSearchInterval","description":"Provides the latest time interval the datafeed has searched."}},"required":["real_time_configured","real_time_running"]},"ml._types__RunningStateSearchInterval":{"type":"object","properties":{"end":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The end time."},"end_ms":{"description":"The end time as an epoch in milliseconds."},"start":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The start time."},"start_ms":{"description":"The start time as an epoch in milliseconds."}},"required":["end_ms","start_ms"]},"ml._types__Datafeed":{"type":"object","properties":{"aggregations":{"type":"object","additionalProperties":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer"}},"authorization":{"$ref":"./ml._types.json#/$defs/ml._types__DatafeedAuthorization","description":"The security privileges that the datafeed uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the datafeed, this property is omitted."},"chunking_config":{"$ref":"./ml._types.json#/$defs/ml._types__ChunkingConfig"},"datafeed_id":{"type":"string"},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: `150s`. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation."},"indices":{"type":"array","items":{"type":"string"}},"indexes":{"type":"array","items":{"type":"string"}},"job_id":{"type":"string"},"max_empty_searches":{"type":"number"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer"},"query_delay":{"$ref":"./_types.json#/$defs/_types__Duration"},"script_fields":{"type":"object","additionalProperties":{"$ref":"./_types.json#/$defs/_types__ScriptField"}},"scroll_size":{"type":"number"},"delayed_data_check_config":{"$ref":"./ml._types.json#/$defs/ml._types__DelayedDataCheckConfig"},"runtime_mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RuntimeFields"},"indices_options":{"$ref":"./_types.json#/$defs/_types__IndicesOptions"}},"required":["datafeed_id","indices","job_id","query","delayed_data_check_config"]},"ml._types__DatafeedAuthorization":{"type":"object","properties":{"api_key":{"$ref":"./ml._types.json#/$defs/ml._types__ApiKeyAuthorization","description":"If an API key was used for the most recent update to the datafeed, its name and identifier are listed in the response."},"roles":{"type":"array","items":{"type":"string"},"description":"If a user ID was used for the most recent update to the datafeed, its roles at the time of the update are listed in the response."},"service_account":{"type":"string","description":"If a service account was used for the most recent update to the datafeed, the account name is listed in the response."}}},"ml._types__ChunkingConfig":{"type":"object","properties":{"mode":{"$ref":"./ml._types.json#/$defs/ml._types__ChunkingMode","description":"If the mode is `auto`, the chunk size is dynamically calculated;\nthis is the recommended value when the datafeed does not use aggregations.\nIf the mode is `manual`, chunking is applied according to the specified `time_span`;\nuse this mode when the datafeed uses aggregations. If the mode is `off`, no chunking is applied."},"time_span":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The time span that each search will be querying. This setting is applicable only when the `mode` is set to `manual`."}},"required":["mode"]},"ml._types__ChunkingMode":{"enum":["auto","manual","off"]},"ml._types__DelayedDataCheckConfig":{"type":"object","properties":{"check_window":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The window of time that is searched for late data. This window of time ends with the latest finalized bucket.\nIt defaults to null, which causes an appropriate `check_window` to be calculated when the real-time datafeed runs.\nIn particular, the default `check_window` span calculation is based on the maximum of `2h` or `8 * bucket_span`."},"enabled":{"type":"boolean","description":"Specifies whether the datafeed periodically checks for delayed data."}},"required":["enabled"]},"ml._types__Filter":{"type":"object","properties":{"description":{"type":"string","description":"A description of the filter."},"filter_id":{"type":"string","description":"A string that uniquely identifies a filter."},"items":{"type":"array","items":{"type":"string"},"description":"An array of strings which is the filter item list."}},"required":["filter_id","items"]},"ml._types__Influencer":{"type":"object","properties":{"bucket_span":{"description":"The length of the bucket in seconds. This value matches the bucket span that is specified in the job."},"influencer_score":{"type":"number","description":"A normalized score between 0-100, which is based on the probability of the influencer in this bucket aggregated\nacross detectors. Unlike `initial_influencer_score`, this value is updated by a re-normalization process as new\ndata is analyzed."},"influencer_field_name":{"type":"string","description":"The field name of the influencer."},"influencer_field_value":{"type":"string","description":"The entity that influenced, contributed to, or was to blame for the anomaly."},"initial_influencer_score":{"type":"number","description":"A normalized score between 0-100, which is based on the probability of the influencer aggregated across detectors.\nThis is the initial value that was calculated at the time the bucket was processed."},"is_interim":{"type":"boolean","description":"If true, this is an interim result. In other words, the results are calculated based on partial input data."},"job_id":{"type":"string","description":"Identifier for the anomaly detection job."},"probability":{"type":"number","description":"The probability that the influencer has this behavior, in the range 0 to 1. This value can be held to a high\nprecision of over 300 decimal places, so the `influencer_score` is provided as a human-readable and friendly\ninterpretation of this value."},"result_type":{"type":"string","description":"Internal. This value is always set to `influencer`."},"timestamp":{"description":"The start time of the bucket for which these results were calculated."},"foo":{"type":"string","description":"Additional influencer properties are added, depending on the fields being analyzed. For example, if it’s\nanalyzing `user_name` as an influencer, a field `user_name` is added to the result document. This\ninformation enables you to filter the anomaly results more easily."}},"required":["bucket_span","influencer_score","influencer_field_name","influencer_field_value","initial_influencer_score","is_interim","job_id","probability","result_type","timestamp"]},"ml._types__JobStats":{"type":"object","properties":{"assignment_explanation":{"type":"string","description":"For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job."},"data_counts":{"$ref":"./ml._types.json#/$defs/ml._types__DataCounts","description":"An object that describes the quantity of input to the job and any related error counts.\nThe `data_count` values are cumulative for the lifetime of a job.\nIf a model snapshot is reverted or old results are deleted, the job counts are not reset."},"forecasts_stats":{"$ref":"./ml._types.json#/$defs/ml._types__JobForecastStatistics","description":"An object that provides statistical information about forecasts belonging to this job.\nSome statistics are omitted if no forecasts have been made."},"job_id":{"type":"string","description":"Identifier for the anomaly detection job."},"model_size_stats":{"$ref":"./ml._types.json#/$defs/ml._types__ModelSizeStats","description":"An object that provides information about the size and contents of the model."},"node":{"$ref":"./ml._types.json#/$defs/ml._types__DiscoveryNodeCompact","description":"Contains properties for the node that runs the job.\nThis information is available only for open jobs.","x-availability":{"stack":{}}},"open_time":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"For open jobs only, the elapsed time for which the job has been open."},"state":{"$ref":"./ml._types.json#/$defs/ml._types__JobState","description":"The status of the anomaly detection job, which can be one of the following values: `closed`, `closing`, `failed`, `opened`, `opening`."},"timing_stats":{"$ref":"./ml._types.json#/$defs/ml._types__JobTimingStats","description":"An object that provides statistical information about timing aspect of this job."},"deleting":{"type":"boolean","description":"Indicates that the process of deleting the job is in progress but not yet completed. It is only reported when `true`."}},"required":["data_counts","forecasts_stats","job_id","model_size_stats","state","timing_stats"]},"ml._types__DataCounts":{"type":"object","properties":{"bucket_count":{"type":"number"},"earliest_record_timestamp":{"type":"number"},"empty_bucket_count":{"type":"number"},"input_bytes":{"type":"number"},"input_field_count":{"type":"number"},"input_record_count":{"type":"number"},"invalid_date_count":{"type":"number"},"job_id":{"type":"string"},"last_data_time":{"type":"number"},"latest_empty_bucket_timestamp":{"type":"number"},"latest_record_timestamp":{"type":"number"},"latest_sparse_bucket_timestamp":{"type":"number"},"latest_bucket_timestamp":{"type":"number"},"log_time":{"type":"number"},"missing_field_count":{"type":"number"},"out_of_order_timestamp_count":{"type":"number"},"processed_field_count":{"type":"number"},"processed_record_count":{"type":"number"},"sparse_bucket_count":{"type":"number"}},"required":["bucket_count","empty_bucket_count","input_bytes","input_field_count","input_record_count","invalid_date_count","job_id","missing_field_count","out_of_order_timestamp_count","processed_field_count","processed_record_count","sparse_bucket_count"]},"ml._types__JobForecastStatistics":{"type":"object","properties":{"memory_bytes":{"$ref":"./ml._types.json#/$defs/ml._types__JobStatistics"},"processing_time_ms":{"$ref":"./ml._types.json#/$defs/ml._types__JobStatistics"},"records":{"$ref":"./ml._types.json#/$defs/ml._types__JobStatistics"},"status":{"type":"object","additionalProperties":{"type":"number"}},"total":{"type":"number"},"forecasted_jobs":{"type":"number"}},"required":["total","forecasted_jobs"]},"ml._types__JobStatistics":{"type":"object","properties":{"avg":{"type":"number"},"max":{"type":"number"},"min":{"type":"number"},"total":{"type":"number"}},"required":["avg","max","min","total"]},"ml._types__ModelSizeStats":{"type":"object","properties":{"bucket_allocation_failures_count":{"type":"number"},"job_id":{"type":"string"},"log_time":{"$ref":"./_types.json#/$defs/_types__DateTime"},"memory_status":{"$ref":"./ml._types.json#/$defs/ml._types__MemoryStatus"},"model_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"model_bytes_exceeded":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"model_bytes_memory_limit":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"output_memory_allocator_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"peak_model_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"assignment_memory_basis":{"type":"string"},"result_type":{"type":"string"},"total_by_field_count":{"type":"number"},"total_over_field_count":{"type":"number"},"total_partition_field_count":{"type":"number"},"categorization_status":{"$ref":"./ml._types.json#/$defs/ml._types__CategorizationStatus"},"categorized_doc_count":{"type":"number"},"dead_category_count":{"type":"number"},"failed_category_count":{"type":"number"},"frequent_category_count":{"type":"number"},"rare_category_count":{"type":"number"},"total_category_count":{"type":"number"},"timestamp":{"type":"number"}},"required":["bucket_allocation_failures_count","job_id","log_time","memory_status","model_bytes","result_type","total_by_field_count","total_over_field_count","total_partition_field_count","categorization_status","categorized_doc_count","dead_category_count","failed_category_count","frequent_category_count","rare_category_count","total_category_count"]},"ml._types__JobTimingStats":{"type":"object","properties":{"average_bucket_processing_time_ms":{},"bucket_count":{"type":"number"},"exponential_average_bucket_processing_time_ms":{},"exponential_average_bucket_processing_time_per_hour_ms":{},"job_id":{"type":"string"},"total_bucket_processing_time_ms":{},"maximum_bucket_processing_time_ms":{},"minimum_bucket_processing_time_ms":{}},"required":["bucket_count","exponential_average_bucket_processing_time_per_hour_ms","job_id","total_bucket_processing_time_ms"]},"ml._types__Job":{"type":"object","properties":{"allow_lazy_open":{"type":"boolean","description":"Advanced configuration option.\nSpecifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node."},"analysis_config":{"$ref":"./ml._types.json#/$defs/ml._types__AnalysisConfig","description":"The analysis configuration, which specifies how to analyze the data.\nAfter you create a job, you cannot change the analysis configuration; all the properties are informational."},"analysis_limits":{"$ref":"./ml._types.json#/$defs/ml._types__AnalysisLimits","description":"Limits can be applied for the resources required to hold the mathematical models in memory.\nThese limits are approximate and can be set per job.\nThey do not control the memory used by other processes, for example the Elasticsearch Java processes."},"background_persist_interval":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Advanced configuration option.\nThe time between each periodic persistence of the model.\nThe default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time.\nThe smallest allowed value is 1 hour."},"blocked":{"$ref":"./ml._types.json#/$defs/ml._types__JobBlocked"},"create_time":{"$ref":"./_types.json#/$defs/_types__DateTime"},"custom_settings":{"$ref":"./ml._types.json#/$defs/ml._types__CustomSettings","description":"Advanced configuration option.\nContains custom metadata about the job."},"daily_model_snapshot_retention_after_days":{"type":"number","description":"Advanced configuration option, which affects the automatic removal of old model snapshots for this job.\nIt specifies a period of time (in days) after which only the first snapshot per day is retained.\nThis period is relative to the timestamp of the most recent snapshot for this job.\nValid values range from 0 to `model_snapshot_retention_days`."},"data_description":{"$ref":"./ml._types.json#/$defs/ml._types__DataDescription","description":"The data description defines the format of the input data when you send data to the job by using the post data API.\nNote that when configuring a datafeed, these properties are automatically set.\nWhen data is received via the post data API, it is not stored in Elasticsearch.\nOnly the results for anomaly detection are retained."},"datafeed_config":{"$ref":"./ml._types.json#/$defs/ml._types__Datafeed","description":"The datafeed, which retrieves data from Elasticsearch for analysis by the job.\nYou can associate only one datafeed with each anomaly detection job."},"deleting":{"type":"boolean","description":"Indicates that the process of deleting the job is in progress but not yet completed.\nIt is only reported when `true`."},"description":{"type":"string","description":"A description of the job."},"finished_time":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"If the job closed or failed, this is the time the job finished, otherwise it is `null`.\nThis property is informational; you cannot change its value."},"groups":{"type":"array","items":{"type":"string"},"description":"A list of job groups.\nA job can belong to no groups or many."},"job_id":{"type":"string","description":"Identifier for the anomaly detection job.\nThis identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.\nIt must start and end with alphanumeric characters."},"job_type":{"type":"string","description":"Reserved for future use, currently set to `anomaly_detector`."},"job_version":{"type":"string","description":"The machine learning configuration version number at which the the job was created."},"model_plot_config":{"$ref":"./ml._types.json#/$defs/ml._types__ModelPlotConfig","description":"This advanced configuration option stores model information along with the results.\nIt provides a more detailed view into anomaly detection.\nModel plot provides a simplified and indicative view of the model and its bounds."},"model_snapshot_id":{"type":"string"},"model_snapshot_retention_days":{"type":"number","description":"Advanced configuration option, which affects the automatic removal of old model snapshots for this job.\nIt specifies the maximum period of time (in days) that snapshots are retained.\nThis period is relative to the timestamp of the most recent snapshot for this job.\nBy default, snapshots ten days older than the newest snapshot are deleted."},"renormalization_window_days":{"type":"number","description":"Advanced configuration option.\nThe period over which adjustments to the score are applied, as new data is seen.\nThe default value is the longer of 30 days or 100 `bucket_spans`."},"results_index_name":{"type":"string","description":"A text string that affects the name of the machine learning results index.\nThe default value is `shared`, which generates an index named `.ml-anomalies-shared`."},"results_retention_days":{"type":"number","description":"Advanced configuration option.\nThe period of time (in days) that results are retained.\nAge is calculated relative to the timestamp of the latest bucket result.\nIf this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch.\nThe default value is null, which means all results are retained.\nAnnotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results.\nAnnotations added by users are retained forever."}},"required":["allow_lazy_open","analysis_config","data_description","job_id","model_snapshot_retention_days","results_index_name"]},"ml._types__AnalysisLimits":{"type":"object","properties":{"categorization_examples_limit":{"type":"number","description":"The maximum number of examples stored per category in memory and in the results data store. If you increase this value, more examples are available, however it requires that you have more storage available. If you set this value to 0, no examples are stored. NOTE: The `categorization_examples_limit` applies only to analysis that uses categorization."},"model_memory_limit":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The approximate maximum amount of memory resources that are required for analytical processing. Once this limit is approached, data pruning becomes more aggressive. Upon exceeding this limit, new entities are not modeled. If the `xpack.ml.max_model_memory_limit` setting has a value greater than 0 and less than 1024mb, that value is used instead of the default. The default value is relatively small to ensure that high resource usage is a conscious decision. If you have jobs that are expected to analyze high cardinality fields, you will likely need to use a higher value. If you specify a number instead of a string, the units are assumed to be MiB. Specifying a string is recommended for clarity. If you specify a byte size unit of `b` or `kb` and the number does not equate to a discrete number of megabytes, it is rounded down to the closest MiB. The minimum valid value is 1 MiB. If you specify a value less than 1 MiB, an error occurs. If you specify a value for the `xpack.ml.max_model_memory_limit` setting, an error occurs when you try to create jobs that have `model_memory_limit` values greater than that setting value."}}},"ml._types__JobBlocked":{"type":"object","properties":{"reason":{"$ref":"./ml._types.json#/$defs/ml._types__JobBlockedReason"},"task_id":{"type":"string"}},"required":["reason"]},"ml._types__JobBlockedReason":{"enum":["delete","reset","revert"]},"ml._types__CustomSettings":{"description":"Custom metadata about the job"},"ml._types__DataDescription":{"type":"object","properties":{"format":{"type":"string","description":"Only JSON format is supported at this time."},"time_field":{"type":"string","description":"The name of the field that contains the timestamp."},"time_format":{"type":"string","description":"The time format, which can be `epoch`, `epoch_ms`, or a custom pattern. The value `epoch` refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The value `epoch_ms` indicates that time is measured in milliseconds since the epoch. The `epoch` and `epoch_ms` time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: `yyyy-MM-dd'T'HH:mm:ssX`. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails."},"field_delimiter":{"type":"string"}}},"ml._types__ModelPlotConfig":{"type":"object","properties":{"annotations_enabled":{"type":"boolean","description":"If true, enables calculation and storage of the model change annotations for each entity that is being analyzed.","x-availability":{"stack":{"since":"7.9.0"},"serverless":{}}},"enabled":{"type":"boolean","description":"If true, enables calculation and storage of the model bounds for each entity that is being analyzed."},"terms":{"type":"string","description":"Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer.","x-availability":{"stack":{"since":"7.9.0"},"serverless":{}}}}},"ml._types__ModelSnapshotUpgrade":{"type":"object","properties":{"job_id":{"type":"string"},"snapshot_id":{"type":"string"},"state":{"$ref":"./ml._types.json#/$defs/ml._types__SnapshotUpgradeState"},"node":{"$ref":"./ml._types.json#/$defs/ml._types__DiscoveryNode","x-availability":{"stack":{}}},"assignment_explanation":{"type":"string"}},"required":["job_id","snapshot_id","state","node","assignment_explanation"]},"ml._types__SnapshotUpgradeState":{"enum":["loading_old_state","saving_new_state","stopped","failed"]},"ml._types__DiscoveryNode":{"type":"object","additionalProperties":{"$ref":"./ml._types.json#/$defs/ml._types__DiscoveryNodeContent"}},"ml._types__DiscoveryNodeContent":{"type":"object","properties":{"name":{"type":"string"},"ephemeral_id":{"type":"string"},"transport_address":{"type":"string"},"external_id":{"type":"string"},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"roles":{"type":"array","items":{"type":"string"}},"version":{"type":"string"},"min_index_version":{"type":"number"},"max_index_version":{"type":"number"}},"required":["ephemeral_id","transport_address","external_id","attributes","roles","version","min_index_version","max_index_version"]},"ml._types__ModelSnapshot":{"type":"object","properties":{"description":{"type":"string","description":"An optional description of the job."},"job_id":{"type":"string","description":"A numerical character string that uniquely identifies the job that the snapshot was created for."},"latest_record_time_stamp":{"type":"number","description":"The timestamp of the latest processed record."},"latest_result_time_stamp":{"type":"number","description":"The timestamp of the latest bucket result."},"min_version":{"type":"string","description":"The minimum version required to be able to restore the model snapshot."},"model_size_stats":{"$ref":"./ml._types.json#/$defs/ml._types__ModelSizeStats","description":"Summary information describing the model."},"retain":{"type":"boolean","description":"If true, this snapshot will not be deleted during automatic cleanup of snapshots older than model_snapshot_retention_days. However, this snapshot will be deleted when the job is deleted. The default value is false."},"snapshot_doc_count":{"type":"number","description":"For internal use only."},"snapshot_id":{"type":"string","description":"A numerical character string that uniquely identifies the model snapshot."},"timestamp":{"type":"number","description":"The creation timestamp for the snapshot."}},"required":["job_id","min_version","retain","snapshot_doc_count","snapshot_id","timestamp"]},"ml._types__OverallBucket":{"type":"object","properties":{"bucket_span":{"description":"The length of the bucket in seconds. Matches the job with the longest bucket_span value."},"is_interim":{"type":"boolean","description":"If true, this is an interim result. In other words, the results are calculated based on partial input data."},"jobs":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__OverallBucketJob"},"description":"An array of objects that contain the max_anomaly_score per job_id."},"overall_score":{"type":"number","description":"The top_n average of the maximum bucket anomaly_score per job."},"result_type":{"type":"string","description":"Internal. This is always set to overall_bucket."},"timestamp":{"description":"The start time of the bucket for which these results were calculated."},"timestamp_string":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The start time of the bucket for which these results were calculated."}},"required":["bucket_span","is_interim","jobs","overall_score","result_type","timestamp"]},"ml._types__OverallBucketJob":{"type":"object","properties":{"job_id":{"type":"string"},"max_anomaly_score":{"type":"number"}},"required":["job_id","max_anomaly_score"]},"ml._types__Anomaly":{"type":"object","properties":{"actual":{"type":"array","items":{"type":"number"},"description":"The actual value for the bucket."},"anomaly_score_explanation":{"$ref":"./ml._types.json#/$defs/ml._types__AnomalyExplanation","description":"Information about the factors impacting the initial anomaly score."},"bucket_span":{"description":"The length of the bucket in seconds. This value matches the `bucket_span` that is specified in the job."},"by_field_name":{"type":"string","description":"The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split."},"by_field_value":{"type":"string","description":"The value of `by_field_name`."},"causes":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__AnomalyCause"},"description":"For population analysis, an over field must be specified in the detector. This property contains an array of anomaly records that are the causes for the anomaly that has been identified for the over field. This sub-resource contains the most anomalous records for the `over_field_name`. For scalability reasons, a maximum of the 10 most significant causes of the anomaly are returned. As part of the core analytical modeling, these low-level anomaly records are aggregated for their parent over field record. The `causes` resource contains similar elements to the record resource, namely `actual`, `typical`, `geo_results.actual_point`, `geo_results.typical_point`, `*_field_name` and `*_field_value`. Probability and scores are not applicable to causes."},"detector_index":{"type":"number","description":"A unique identifier for the detector."},"field_name":{"type":"string","description":"Certain functions require a field to operate on, for example, `sum()`. For those functions, this value is the name of the field to be analyzed."},"function":{"type":"string","description":"The function in which the anomaly occurs, as specified in the detector configuration. For example, `max`."},"function_description":{"type":"string","description":"The description of the function in which the anomaly occurs, as specified in the detector configuration."},"geo_results":{"$ref":"./ml._types.json#/$defs/ml._types__GeoResults","description":"If the detector function is `lat_long`, this object contains comma delimited strings for the latitude and longitude of the actual and typical values."},"influencers":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__Influence"},"description":"If influencers were specified in the detector configuration, this array contains influencers that contributed to or were to blame for an anomaly."},"initial_record_score":{"type":"number","description":"A normalized score between 0-100, which is based on the probability of the anomalousness of this record. This is the initial value that was calculated at the time the bucket was processed."},"is_interim":{"type":"boolean","description":"If true, this is an interim result. In other words, the results are calculated based on partial input data."},"job_id":{"type":"string","description":"Identifier for the anomaly detection job."},"over_field_name":{"type":"string","description":"The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits."},"over_field_value":{"type":"string","description":"The value of `over_field_name`."},"partition_field_name":{"type":"string","description":"The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field."},"partition_field_value":{"type":"string","description":"The value of `partition_field_name`."},"probability":{"type":"number","description":"The probability of the individual anomaly occurring, in the range 0 to 1. For example, `0.0000772031`. This value can be held to a high precision of over 300 decimal places, so the `record_score` is provided as a human-readable and friendly interpretation of this."},"record_score":{"type":"number","description":"A normalized score between 0-100, which is based on the probability of the anomalousness of this record. Unlike `initial_record_score`, this value will be updated by a re-normalization process as new data is analyzed."},"result_type":{"type":"string","description":"Internal. This is always set to `record`."},"timestamp":{"description":"The start time of the bucket for which these results were calculated."},"typical":{"type":"array","items":{"type":"number"},"description":"The typical value for the bucket, according to analytical modeling."}},"required":["bucket_span","detector_index","initial_record_score","is_interim","job_id","probability","record_score","result_type","timestamp"]},"ml._types__AnomalyExplanation":{"type":"object","properties":{"anomaly_characteristics_impact":{"type":"number","description":"Impact from the duration and magnitude of the detected anomaly relative to the historical average."},"anomaly_length":{"type":"number","description":"Length of the detected anomaly in the number of buckets."},"anomaly_type":{"type":"string","description":"Type of the detected anomaly: `spike` or `dip`."},"high_variance_penalty":{"type":"boolean","description":"Indicates reduction of anomaly score for the bucket with large confidence intervals. If a bucket has large confidence intervals, the score is reduced."},"incomplete_bucket_penalty":{"type":"boolean","description":"If the bucket contains fewer samples than expected, the score is reduced."},"lower_confidence_bound":{"type":"number","description":"Lower bound of the 95% confidence interval."},"multi_bucket_impact":{"type":"number","description":"Impact of the deviation between actual and typical values in the past 12 buckets."},"single_bucket_impact":{"type":"number","description":"Impact of the deviation between actual and typical values in the current bucket."},"typical_value":{"type":"number","description":"Typical (expected) value for this bucket."},"upper_confidence_bound":{"type":"number","description":"Upper bound of the 95% confidence interval."}}},"ml._types__AnomalyCause":{"type":"object","properties":{"actual":{"type":"array","items":{"type":"number"}},"by_field_name":{"type":"string"},"by_field_value":{"type":"string"},"correlated_by_field_value":{"type":"string"},"field_name":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."},"function":{"type":"string"},"function_description":{"type":"string"},"geo_results":{"$ref":"./ml._types.json#/$defs/ml._types__GeoResults"},"influencers":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__Influence"}},"over_field_name":{"type":"string"},"over_field_value":{"type":"string"},"partition_field_name":{"type":"string"},"partition_field_value":{"type":"string"},"probability":{"type":"number"},"typical":{"type":"array","items":{"type":"number"}}},"required":["probability"]},"ml._types__GeoResults":{"type":"object","properties":{"actual_point":{"type":"string","description":"The actual value for the bucket formatted as a `geo_point`."},"typical_point":{"type":"string","description":"The typical value for the bucket formatted as a `geo_point`."}}},"ml._types__Influence":{"type":"object","properties":{"influencer_field_name":{"type":"string"},"influencer_field_values":{"type":"array","items":{"type":"string"}}},"required":["influencer_field_name","influencer_field_values"]},"ml._types__Include":{"enum":["definition","feature_importance_baseline","hyperparameters","total_feature_importance","definition_status"]},"ml._types__TrainedModelConfig":{"type":"object","properties":{"model_id":{"type":"string","description":"Identifier for the trained model."},"model_type":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelType","description":"The model type"},"tags":{"type":"array","items":{"type":"string"},"description":"A comma delimited string of tags. A trained model can have many tags, or none."},"version":{"type":"string","description":"The Elasticsearch version number in which the trained model was created."},"compressed_definition":{"type":"string"},"created_by":{"type":"string","description":"Information on the creator of the trained model."},"create_time":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The time when the trained model was created."},"default_field_map":{"type":"object","additionalProperties":{"type":"string"},"description":"Any field map described in the inference configuration takes precedence."},"description":{"type":"string","description":"The free-text description of the trained model."},"estimated_heap_memory_usage_bytes":{"type":"number","description":"The estimated heap usage in bytes to keep the trained model in memory."},"estimated_operations":{"type":"number","description":"The estimated number of operations to use the trained model."},"fully_defined":{"type":"boolean","description":"True if the full model definition is present."},"inference_config":{"$ref":"./ml._types.json#/$defs/ml._types__InferenceConfigCreateContainer","description":"The default configuration for inference. This can be either a regression, classification, or one of the many NLP focused configurations. It must match the underlying definition.trained_model's target_type. For pre-packaged models such as ELSER the config is not required."},"input":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelConfigInput","description":"The input field names for the model definition."},"license_level":{"type":"string","description":"The license level of the trained model."},"metadata":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelConfigMetadata","description":"An object containing metadata about the trained model. For example, models created by data frame analytics contain analysis_config and input objects."},"model_size_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"model_package":{"$ref":"./ml._types.json#/$defs/ml._types__ModelPackageConfig"},"location":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelLocation"},"platform_architecture":{"type":"string"},"prefix_strings":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelPrefixStrings"}},"required":["model_id","tags","input"]},"ml._types__TrainedModelType":{"enum":["tree_ensemble","lang_ident","pytorch"]},"ml._types__InferenceConfigCreateContainer":{"type":"object","properties":{"regression":{"$ref":"./ml._types.json#/$defs/ml._types__RegressionInferenceOptions","description":"Regression configuration for inference."},"classification":{"$ref":"./ml._types.json#/$defs/ml._types__ClassificationInferenceOptions","description":"Classification configuration for inference."},"text_classification":{"$ref":"./ml._types.json#/$defs/ml._types__TextClassificationInferenceOptions","description":"Text classification configuration for inference.","x-availability":{"stack":{"since":"8.0.0"},"serverless":{}}},"zero_shot_classification":{"$ref":"./ml._types.json#/$defs/ml._types__ZeroShotClassificationInferenceOptions","description":"Zeroshot classification configuration for inference.","x-availability":{"stack":{"since":"8.0.0"},"serverless":{}}},"fill_mask":{"$ref":"./ml._types.json#/$defs/ml._types__FillMaskInferenceOptions","description":"Fill mask configuration for inference.","x-availability":{"stack":{"since":"8.0.0"},"serverless":{}}},"learning_to_rank":{"$ref":"./ml._types.json#/$defs/ml._types__LearningToRankConfig"},"ner":{"$ref":"./ml._types.json#/$defs/ml._types__NerInferenceOptions","description":"Named entity recognition configuration for inference.","x-availability":{"stack":{"since":"8.0.0"},"serverless":{}}},"pass_through":{"$ref":"./ml._types.json#/$defs/ml._types__PassThroughInferenceOptions","description":"Pass through configuration for inference.","x-availability":{"stack":{"since":"8.0.0"},"serverless":{}}},"text_embedding":{"$ref":"./ml._types.json#/$defs/ml._types__TextEmbeddingInferenceOptions","description":"Text embedding configuration for inference.","x-availability":{"stack":{"since":"8.0.0"},"serverless":{}}},"text_expansion":{"$ref":"./ml._types.json#/$defs/ml._types__TextExpansionInferenceOptions","description":"Text expansion configuration for inference.","x-availability":{"stack":{"since":"8.8.0"},"serverless":{}}},"question_answering":{"$ref":"./ml._types.json#/$defs/ml._types__QuestionAnsweringInferenceOptions","description":"Question answering configuration for inference.","x-availability":{"stack":{"since":"8.3.0"},"serverless":{}}}},"description":"Inference configuration provided when storing the model config"},"ml._types__TextClassificationInferenceOptions":{"type":"object","properties":{"num_top_classes":{"type":"number","description":"Specifies the number of top class predictions to return. Defaults to 0."},"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__TokenizationConfigContainer","description":"The tokenization options"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"classification_labels":{"type":"array","items":{"type":"string"},"description":"Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels"},"vocabulary":{"$ref":"./ml._types.json#/$defs/ml._types__Vocabulary"}},"description":"Text classification configuration options"},"ml._types__TokenizationConfigContainer":{"type":"object","properties":{"bert":{"$ref":"./ml._types.json#/$defs/ml._types__NlpBertTokenizationConfig","description":"Indicates BERT tokenization and its options"},"bert_ja":{"$ref":"./ml._types.json#/$defs/ml._types__NlpBertTokenizationConfig","description":"Indicates BERT Japanese tokenization and its options"},"mpnet":{"$ref":"./ml._types.json#/$defs/ml._types__NlpBertTokenizationConfig","description":"Indicates MPNET tokenization and its options","x-availability":{"stack":{"since":"8.1.0"},"serverless":{}}},"roberta":{"$ref":"./ml._types.json#/$defs/ml._types__NlpRobertaTokenizationConfig","description":"Indicates RoBERTa tokenization and its options","x-availability":{"stack":{"since":"8.2.0"},"serverless":{}}},"xlm_roberta":{"$ref":"./ml._types.json#/$defs/ml._types__XlmRobertaTokenizationConfig"}},"description":"Tokenization options stored in inference configuration"},"ml._types__NlpBertTokenizationConfig":{"type":"object","properties":{"do_lower_case":{"type":"boolean","description":"Should the tokenizer lower case the text"},"max_sequence_length":{"type":"number","description":"Maximum input sequence length for the model"},"span":{"type":"number","description":"Tokenization spanning options. Special value of -1 indicates no spanning takes place"},"truncate":{"$ref":"./ml._types.json#/$defs/ml._types__TokenizationTruncate","description":"Should tokenization input be automatically truncated before sending to the model for inference"},"with_special_tokens":{"type":"boolean","description":"Is tokenization completed with special tokens"}},"description":"BERT and MPNet tokenization configuration options"},"ml._types__TokenizationTruncate":{"enum":["first","second","none"]},"ml._types__NlpRobertaTokenizationConfig":{"type":"object","properties":{"do_lower_case":{"type":"boolean","description":"Should the tokenizer lower case the text"},"max_sequence_length":{"type":"number","description":"Maximum input sequence length for the model"},"span":{"type":"number","description":"Tokenization spanning options. Special value of -1 indicates no spanning takes place"},"truncate":{"$ref":"./ml._types.json#/$defs/ml._types__TokenizationTruncate","description":"Should tokenization input be automatically truncated before sending to the model for inference"},"with_special_tokens":{"type":"boolean","description":"Is tokenization completed with special tokens"},"add_prefix_space":{"type":"boolean","description":"Should the tokenizer prefix input with a space character"}},"description":"RoBERTa tokenization configuration options"},"ml._types__XlmRobertaTokenizationConfig":{"type":"object","properties":{"do_lower_case":{"type":"boolean","description":"Should the tokenizer lower case the text"},"max_sequence_length":{"type":"number","description":"Maximum input sequence length for the model"},"span":{"type":"number","description":"Tokenization spanning options. Special value of -1 indicates no spanning takes place"},"truncate":{"$ref":"./ml._types.json#/$defs/ml._types__TokenizationTruncate","description":"Should tokenization input be automatically truncated before sending to the model for inference"},"with_special_tokens":{"type":"boolean","description":"Is tokenization completed with special tokens"}}},"ml._types__Vocabulary":{"type":"object","properties":{"index":{"type":"string"}},"required":["index"]},"ml._types__ZeroShotClassificationInferenceOptions":{"type":"object","properties":{"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__TokenizationConfigContainer","description":"The tokenization options to update when inferring"},"hypothesis_template":{"type":"string","description":"Hypothesis template used when tokenizing labels for prediction"},"classification_labels":{"type":"array","items":{"type":"string"},"description":"The zero shot classification labels indicating entailment, neutral, and contradiction\nMust contain exactly and only entailment, neutral, and contradiction"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"multi_label":{"type":"boolean","description":"Indicates if more than one true label exists."},"labels":{"type":"array","items":{"type":"string"},"description":"The labels to predict."}},"required":["classification_labels"],"description":"Zero shot classification configuration options"},"ml._types__FillMaskInferenceOptions":{"type":"object","properties":{"mask_token":{"type":"string","description":"The string/token which will be removed from incoming documents and replaced with the inference prediction(s).\nIn a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer\nhas a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests.\nHowever, if this field is present in a request, its value must match the predefined value for that model/tokenizer,\notherwise the request will fail."},"num_top_classes":{"type":"number","description":"Specifies the number of top class predictions to return. Defaults to 0."},"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__TokenizationConfigContainer","description":"The tokenization options to update when inferring"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"vocabulary":{"$ref":"./ml._types.json#/$defs/ml._types__Vocabulary"}},"description":"Fill mask inference options"},"ml._types__LearningToRankConfig":{"type":"object","properties":{"default_params":{"type":"object","additionalProperties":{}},"feature_extractors":{"type":"array","items":{"type":"object","additionalProperties":{"$ref":"./ml._types.json#/$defs/ml._types__QueryFeatureExtractor"}}},"num_top_feature_importance_values":{"type":"number"}},"required":["num_top_feature_importance_values"]},"ml._types__QueryFeatureExtractor":{"type":"object","properties":{"default_score":{"type":"number"},"feature_name":{"type":"string"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer"}},"required":["feature_name","query"]},"ml._types__NerInferenceOptions":{"type":"object","properties":{"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__TokenizationConfigContainer","description":"The tokenization options"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"classification_labels":{"type":"array","items":{"type":"string"},"description":"The token classification labels. Must be IOB formatted tags"},"vocabulary":{"$ref":"./ml._types.json#/$defs/ml._types__Vocabulary"}},"description":"Named entity recognition options"},"ml._types__PassThroughInferenceOptions":{"type":"object","properties":{"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__TokenizationConfigContainer","description":"The tokenization options"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"vocabulary":{"$ref":"./ml._types.json#/$defs/ml._types__Vocabulary"}},"description":"Pass through configuration options"},"ml._types__TextEmbeddingInferenceOptions":{"type":"object","properties":{"embedding_size":{"type":"number","description":"The number of dimensions in the embedding output"},"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__TokenizationConfigContainer","description":"The tokenization options"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"vocabulary":{"$ref":"./ml._types.json#/$defs/ml._types__Vocabulary"}},"description":"Text embedding inference options"},"ml._types__TextExpansionInferenceOptions":{"type":"object","properties":{"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__TokenizationConfigContainer","description":"The tokenization options"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"vocabulary":{"$ref":"./ml._types.json#/$defs/ml._types__Vocabulary"}},"description":"Text expansion inference options"},"ml._types__QuestionAnsweringInferenceOptions":{"type":"object","properties":{"num_top_classes":{"type":"number","description":"Specifies the number of top class predictions to return. Defaults to 0."},"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__TokenizationConfigContainer","description":"The tokenization options to update when inferring"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"max_answer_length":{"type":"number","description":"The maximum answer length to consider"}},"description":"Question answering inference options"},"ml._types__TrainedModelConfigInput":{"type":"object","properties":{"field_names":{"type":"array","items":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."},"description":"An array of input field names for the model."}},"required":["field_names"]},"ml._types__TrainedModelConfigMetadata":{"type":"object","properties":{"model_aliases":{"type":"array","items":{"type":"string"}},"feature_importance_baseline":{"type":"object","additionalProperties":{"type":"string"},"description":"An object that contains the baseline for feature importance values. For regression analysis, it is a single value. For classification analysis, there is a value for each class."},"hyperparameters":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__Hyperparameter"},"description":"List of the available hyperparameters optimized during the fine_parameter_tuning phase as well as specified by the user."},"total_feature_importance":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__TotalFeatureImportance"},"description":"An array of the total feature importance for each feature used from the training data set. This array of objects is returned if data frame analytics trained the model and the request includes total_feature_importance in the include request parameter."}}},"ml._types__Hyperparameter":{"type":"object","properties":{"absolute_importance":{"type":"number","description":"A positive number showing how much the parameter influences the variation of the loss function. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization."},"name":{"type":"string","description":"Name of the hyperparameter."},"relative_importance":{"type":"number","description":"A number between 0 and 1 showing the proportion of influence on the variation of the loss function among all tuned hyperparameters. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization."},"supplied":{"type":"boolean","description":"Indicates if the hyperparameter is specified by the user (true) or optimized (false)."},"value":{"type":"number","description":"The value of the hyperparameter, either optimized or specified by the user."}},"required":["name","supplied","value"]},"ml._types__TotalFeatureImportance":{"type":"object","properties":{"feature_name":{"type":"string","description":"The feature for which this importance was calculated."},"importance":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__TotalFeatureImportanceStatistics"},"description":"A collection of feature importance statistics related to the training data set for this particular feature."},"classes":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__TotalFeatureImportanceClass"},"description":"If the trained model is a classification model, feature importance statistics are gathered per target class value."}},"required":["feature_name","importance","classes"]},"ml._types__TotalFeatureImportanceStatistics":{"type":"object","properties":{"mean_magnitude":{"type":"number","description":"The average magnitude of this feature across all the training data. This value is the average of the absolute values of the importance for this feature."},"max":{"type":"number","description":"The maximum importance value across all the training data for this feature."},"min":{"type":"number","description":"The minimum importance value across all the training data for this feature."}},"required":["mean_magnitude","max","min"]},"ml._types__TotalFeatureImportanceClass":{"type":"object","properties":{"class_name":{"type":"string","description":"The target class value. Could be a string, boolean, or number."},"importance":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__TotalFeatureImportanceStatistics"},"description":"A collection of feature importance statistics related to the training data set for this particular feature."}},"required":["class_name","importance"]},"ml._types__ModelPackageConfig":{"type":"object","properties":{"create_time":{},"description":{"type":"string"},"inference_config":{"type":"object","additionalProperties":{}},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata"},"minimum_version":{"type":"string"},"model_repository":{"type":"string"},"model_type":{"type":"string"},"packaged_model_id":{"type":"string"},"platform_architecture":{"type":"string"},"prefix_strings":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelPrefixStrings"},"size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"sha256":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"vocabulary_file":{"type":"string"}},"required":["packaged_model_id"]},"ml._types__TrainedModelPrefixStrings":{"type":"object","properties":{"ingest":{"type":"string","description":"String prepended to input at ingest"},"search":{"type":"string","description":"String prepended to input at search"}}},"ml._types__TrainedModelLocation":{"type":"object","properties":{"index":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelLocationIndex"}},"required":["index"]},"ml._types__TrainedModelLocationIndex":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"ml._types__TrainedModelStats":{"type":"object","properties":{"deployment_stats":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelDeploymentStats","description":"A collection of deployment stats, which is present when the models are deployed."},"inference_stats":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelInferenceStats","description":"A collection of inference stats fields."},"ingest":{"type":"object","additionalProperties":{},"description":"A collection of ingest stats for the model across all nodes.\nThe values are summations of the individual node statistics.\nThe format matches the ingest section in the nodes stats API."},"model_id":{"type":"string","description":"The unique identifier of the trained model."},"model_size_stats":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelSizeStats","description":"A collection of model size stats."},"pipeline_count":{"type":"number","description":"The number of ingest pipelines that currently refer to the model."}},"required":["model_id","model_size_stats","pipeline_count"]},"ml._types__TrainedModelDeploymentStats":{"type":"object","properties":{"adaptive_allocations":{"$ref":"./ml._types.json#/$defs/ml._types__AdaptiveAllocationsSettings"},"allocation_status":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelDeploymentAllocationStatus","description":"The detailed allocation status for the deployment."},"cache_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"deployment_id":{"type":"string","description":"The unique identifier for the trained model deployment."},"error_count":{"type":"number","description":"The sum of `error_count` for all nodes in the deployment."},"inference_count":{"type":"number","description":"The sum of `inference_count` for all nodes in the deployment."},"model_id":{"type":"string","description":"The unique identifier for the trained model."},"nodes":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelDeploymentNodesStats"},"description":"The deployment stats for each node that currently has the model allocated.\nIn serverless, stats are reported for a single unnamed virtual node."},"number_of_allocations":{"type":"number","description":"The number of allocations requested."},"peak_throughput_per_minute":{"type":"number"},"priority":{"$ref":"./ml._types.json#/$defs/ml._types__TrainingPriority"},"queue_capacity":{"type":"number","description":"The number of inference requests that can be queued before new requests are rejected."},"rejected_execution_count":{"type":"number","description":"The sum of `rejected_execution_count` for all nodes in the deployment.\nIndividual nodes reject an inference request if the inference queue is full.\nThe queue size is controlled by the `queue_capacity` setting in the start\ntrained model deployment API."},"reason":{"type":"string","description":"The reason for the current deployment state. Usually only populated when\nthe model is not deployed to a node."},"start_time":{"description":"The epoch timestamp when the deployment started."},"state":{"$ref":"./ml._types.json#/$defs/ml._types__DeploymentAssignmentState","description":"The overall state of the deployment."},"threads_per_allocation":{"type":"number","description":"The number of threads used be each allocation during inference."},"timeout_count":{"type":"number","description":"The sum of `timeout_count` for all nodes in the deployment."}},"required":["deployment_id","model_id","nodes","peak_throughput_per_minute","priority","start_time"]},"ml._types__AdaptiveAllocationsSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If true, adaptive_allocations is enabled"},"min_number_of_allocations":{"type":"number","description":"Specifies the minimum number of allocations to scale to.\nIf set, it must be greater than or equal to 0.\nIf not defined, the deployment scales to 0."},"max_number_of_allocations":{"type":"number","description":"Specifies the maximum number of allocations to scale to.\nIf set, it must be greater than or equal to min_number_of_allocations."}},"required":["enabled"]},"ml._types__TrainedModelDeploymentAllocationStatus":{"type":"object","properties":{"allocation_count":{"type":"number","description":"The current number of nodes where the model is allocated."},"state":{"$ref":"./ml._types.json#/$defs/ml._types__DeploymentAllocationState","description":"The detailed allocation state related to the nodes."},"target_allocation_count":{"type":"number","description":"The desired number of nodes for model allocation."}},"required":["allocation_count","state","target_allocation_count"]},"ml._types__DeploymentAllocationState":{"enum":["started","starting","fully_allocated"]},"ml._types__TrainedModelDeploymentNodesStats":{"type":"object","properties":{"average_inference_time_ms":{"description":"The average time for each inference call to complete on this node."},"average_inference_time_ms_last_minute":{},"average_inference_time_ms_excluding_cache_hits":{"description":"The average time for each inference call to complete on this node, excluding cache"},"average_inference_process_memory_rss_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"error_count":{"type":"number","description":"The number of errors when evaluating the trained model."},"inference_count":{"type":"number","description":"The total number of inference calls made against this node for this model."},"inference_cache_hit_count":{"type":"number"},"inference_cache_hit_count_last_minute":{"type":"number"},"last_access":{"description":"The epoch time stamp of the last inference call for the model on this node."},"node":{"$ref":"./ml._types.json#/$defs/ml._types__DiscoveryNode","description":"Information pertaining to the node.","x-availability":{"stack":{}}},"number_of_allocations":{"type":"number","description":"The number of allocations assigned to this node."},"number_of_pending_requests":{"type":"number","description":"The number of inference requests queued to be processed."},"peak_throughput_per_minute":{"type":"number"},"rejected_execution_count":{"type":"number","description":"The number of inference requests that were not processed because the queue was full."},"routing_state":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelAssignmentRoutingStateAndReason","description":"The current routing state and reason for the current routing state for this allocation."},"start_time":{"description":"The epoch timestamp when the allocation started."},"threads_per_allocation":{"type":"number","description":"The number of threads used by each allocation during inference."},"throughput_last_minute":{"type":"number"},"timeout_count":{"type":"number","description":"The number of inference requests that timed out before being processed."}},"required":["peak_throughput_per_minute","routing_state","throughput_last_minute"]},"ml._types__TrainedModelAssignmentRoutingStateAndReason":{"type":"object","properties":{"reason":{"type":"string","description":"The reason for the current state. It is usually populated only when the\n`routing_state` is `failed`."},"routing_state":{"$ref":"./ml._types.json#/$defs/ml._types__RoutingState","description":"The current routing state."}},"required":["routing_state"]},"ml._types__RoutingState":{"enum":["failed","started","starting","stopped","stopping"]},"ml._types__TrainingPriority":{"enum":["normal","low"]},"ml._types__DeploymentAssignmentState":{"enum":["started","starting","stopping","failed"]},"ml._types__TrainedModelInferenceStats":{"type":"object","properties":{"cache_miss_count":{"type":"number","description":"The number of times the model was loaded for inference and was not retrieved from the cache.\nIf this number is close to the `inference_count`, the cache is not being appropriately used.\nThis can be solved by increasing the cache size or its time-to-live (TTL).\nRefer to general machine learning settings for the appropriate settings."},"failure_count":{"type":"number","description":"The number of failures when using the model for inference."},"inference_count":{"type":"number","description":"The total number of times the model has been called for inference.\nThis is across all inference contexts, including all pipelines."},"missing_all_fields_count":{"type":"number","description":"The number of inference calls where all the training features for the model were missing."},"timestamp":{"description":"The time when the statistics were last updated."}},"required":["cache_miss_count","failure_count","inference_count","missing_all_fields_count","timestamp"]},"ml._types__TrainedModelSizeStats":{"type":"object","properties":{"model_size_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The size of the model in bytes."},"required_native_memory_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The amount of memory required to load the model in bytes."}},"required":["model_size_bytes","required_native_memory_bytes"]},"ml._types__InferenceConfigUpdateContainer":{"type":"object","properties":{"regression":{"$ref":"./ml._types.json#/$defs/ml._types__RegressionInferenceOptions","description":"Regression configuration for inference."},"classification":{"$ref":"./ml._types.json#/$defs/ml._types__ClassificationInferenceOptions","description":"Classification configuration for inference."},"text_classification":{"$ref":"./ml._types.json#/$defs/ml._types__TextClassificationInferenceUpdateOptions","description":"Text classification configuration for inference."},"zero_shot_classification":{"$ref":"./ml._types.json#/$defs/ml._types__ZeroShotClassificationInferenceUpdateOptions","description":"Zeroshot classification configuration for inference."},"fill_mask":{"$ref":"./ml._types.json#/$defs/ml._types__FillMaskInferenceUpdateOptions","description":"Fill mask configuration for inference."},"ner":{"$ref":"./ml._types.json#/$defs/ml._types__NerInferenceUpdateOptions","description":"Named entity recognition configuration for inference."},"pass_through":{"$ref":"./ml._types.json#/$defs/ml._types__PassThroughInferenceUpdateOptions","description":"Pass through configuration for inference."},"text_embedding":{"$ref":"./ml._types.json#/$defs/ml._types__TextEmbeddingInferenceUpdateOptions","description":"Text embedding configuration for inference."},"text_expansion":{"$ref":"./ml._types.json#/$defs/ml._types__TextExpansionInferenceUpdateOptions","description":"Text expansion configuration for inference."},"question_answering":{"$ref":"./ml._types.json#/$defs/ml._types__QuestionAnsweringInferenceUpdateOptions","description":"Question answering configuration for inference"}}},"ml._types__TextClassificationInferenceUpdateOptions":{"type":"object","properties":{"num_top_classes":{"type":"number","description":"Specifies the number of top class predictions to return. Defaults to 0."},"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__NlpTokenizationUpdateOptions","description":"The tokenization options to update when inferring"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"classification_labels":{"type":"array","items":{"type":"string"},"description":"Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels"}}},"ml._types__NlpTokenizationUpdateOptions":{"type":"object","properties":{"truncate":{"$ref":"./ml._types.json#/$defs/ml._types__TokenizationTruncate","description":"Truncate options to apply"},"span":{"type":"number","description":"Span options to apply"}}},"ml._types__ZeroShotClassificationInferenceUpdateOptions":{"type":"object","properties":{"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__NlpTokenizationUpdateOptions","description":"The tokenization options to update when inferring"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"multi_label":{"type":"boolean","description":"Update the configured multi label option. Indicates if more than one true label exists. Defaults to the configured value."},"labels":{"type":"array","items":{"type":"string"},"description":"The labels to predict."}},"required":["labels"]},"ml._types__FillMaskInferenceUpdateOptions":{"type":"object","properties":{"num_top_classes":{"type":"number","description":"Specifies the number of top class predictions to return. Defaults to 0."},"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__NlpTokenizationUpdateOptions","description":"The tokenization options to update when inferring"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."}}},"ml._types__NerInferenceUpdateOptions":{"type":"object","properties":{"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__NlpTokenizationUpdateOptions","description":"The tokenization options to update when inferring"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."}}},"ml._types__PassThroughInferenceUpdateOptions":{"type":"object","properties":{"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__NlpTokenizationUpdateOptions","description":"The tokenization options to update when inferring"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."}}},"ml._types__TextEmbeddingInferenceUpdateOptions":{"type":"object","properties":{"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__NlpTokenizationUpdateOptions"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."}}},"ml._types__TextExpansionInferenceUpdateOptions":{"type":"object","properties":{"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__NlpTokenizationUpdateOptions"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."}}},"ml._types__QuestionAnsweringInferenceUpdateOptions":{"type":"object","properties":{"question":{"type":"string","description":"The question to answer given the inference context"},"num_top_classes":{"type":"number","description":"Specifies the number of top class predictions to return. Defaults to 0."},"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__NlpTokenizationUpdateOptions","description":"The tokenization options to update when inferring"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"max_answer_length":{"type":"number","description":"The maximum answer length to consider for extraction"}},"required":["question"]},"ml._types__InferenceResponseResult":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelEntities"},"description":"If the model is trained for named entity recognition (NER) tasks, the response contains the recognized entities."},"is_truncated":{"type":"boolean","description":"Indicates whether the input text was truncated to meet the model's maximum sequence length limit. This property\nis present only when it is true."},"predicted_value":{"anyOf":[{"$ref":"./ml._types.json#/$defs/ml._types__PredictedValue"},{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__PredictedValue"}}],"description":"If the model is trained for a text classification or zero shot classification task, the response is the\npredicted class.\nFor named entity recognition (NER) tasks, it contains the annotated text output.\nFor fill mask tasks, it contains the top prediction for replacing the mask token.\nFor text embedding tasks, it contains the raw numerical text embedding values.\nFor regression models, its a numerical value\nFor classification models, it may be an integer, double, boolean or string depending on prediction type"},"predicted_value_sequence":{"type":"string","description":"For fill mask tasks, the response contains the input text sequence with the mask token replaced by the predicted\nvalue.\nAdditionally"},"prediction_probability":{"type":"number","description":"Specifies a probability for the predicted value."},"prediction_score":{"type":"number","description":"Specifies a confidence score for the predicted value."},"top_classes":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__TopClassEntry"},"description":"For fill mask, text classification, and zero shot classification tasks, the response contains a list of top\nclass entries."},"warning":{"type":"string","description":"If the request failed, the response contains the reason for the failure."},"feature_importance":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelInferenceFeatureImportance"},"description":"The feature importance for the inference results. Relevant only for classification or regression models"}}},"ml._types__TrainedModelEntities":{"type":"object","properties":{"class_name":{"type":"string"},"class_probability":{"type":"number"},"entity":{"type":"string"},"start_pos":{"type":"number"},"end_pos":{"type":"number"}},"required":["class_name","class_probability","entity","start_pos","end_pos"]},"ml._types__PredictedValue":{"anyOf":[{"$ref":"./_types.json#/$defs/_types__ScalarValue"},{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__ScalarValue"}}]},"ml._types__TopClassEntry":{"type":"object","properties":{"class_name":{"type":"string"},"class_probability":{"type":"number"},"class_score":{"type":"number"}},"required":["class_name","class_probability","class_score"]},"ml._types__TrainedModelInferenceFeatureImportance":{"type":"object","properties":{"feature_name":{"type":"string"},"importance":{"type":"number"},"classes":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelInferenceClassImportance"}}},"required":["feature_name"]},"ml._types__TrainedModelInferenceClassImportance":{"type":"object","properties":{"class_name":{"type":"string"},"importance":{"type":"number"}},"required":["class_name","importance"]},"ml._types__DatafeedConfig":{"type":"object","properties":{"aggregations":{"type":"object","additionalProperties":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer"},"description":"If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data."},"chunking_config":{"$ref":"./ml._types.json#/$defs/ml._types__ChunkingConfig","description":"Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated and is an advanced configuration option."},"datafeed_id":{"type":"string","description":"A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. The default value is the job identifier."},"delayed_data_check_config":{"$ref":"./ml._types.json#/$defs/ml._types__DelayedDataCheckConfig","description":"Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the `query_delay` option is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds."},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: `150s`. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation."},"indices":{"$ref":"./_types.json#/$defs/_types__Indices","description":"An array of index names. Wildcards are supported. If any indices are in remote clusters, the machine learning nodes must have the `remote_cluster_client` role."},"indices_options":{"$ref":"./_types.json#/$defs/_types__IndicesOptions","description":"Specifies index expansion options that are used during search."},"job_id":{"type":"string"},"max_empty_searches":{"type":"number","description":"If a real-time datafeed has never seen any data (including during any initial training period) then it will automatically stop itself and close its associated job after this many real-time searches that return no documents. In other words, it will stop after `frequency` times `max_empty_searches` of real-time operation. If not set then a datafeed with no end time that sees no data will remain started until it is explicitly stopped."},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch."},"query_delay":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between `60s` and `120s`. This randomness improves the query performance when there are multiple jobs running on the same node."},"runtime_mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RuntimeFields","description":"Specifies runtime fields for the datafeed search."},"script_fields":{"type":"object","additionalProperties":{"$ref":"./_types.json#/$defs/_types__ScriptField"},"description":"Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields."},"scroll_size":{"type":"number","description":"The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of `index.max_result_window`, which is 10,000 by default."}}},"ml._types__JobConfig":{"type":"object","properties":{"allow_lazy_open":{"type":"boolean","description":"Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node."},"analysis_config":{"$ref":"./ml._types.json#/$defs/ml._types__AnalysisConfig","description":"The analysis configuration, which specifies how to analyze the data.\nAfter you create a job, you cannot change the analysis configuration; all the properties are informational."},"analysis_limits":{"$ref":"./ml._types.json#/$defs/ml._types__AnalysisLimits","description":"Limits can be applied for the resources required to hold the mathematical models in memory.\nThese limits are approximate and can be set per job.\nThey do not control the memory used by other processes, for example the Elasticsearch Java processes."},"background_persist_interval":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Advanced configuration option.\nThe time between each periodic persistence of the model.\nThe default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time.\nThe smallest allowed value is 1 hour."},"custom_settings":{"$ref":"./ml._types.json#/$defs/ml._types__CustomSettings","description":"Advanced configuration option.\nContains custom metadata about the job."},"daily_model_snapshot_retention_after_days":{"type":"number","description":"Advanced configuration option, which affects the automatic removal of old model snapshots for this job.\nIt specifies a period of time (in days) after which only the first snapshot per day is retained.\nThis period is relative to the timestamp of the most recent snapshot for this job."},"data_description":{"$ref":"./ml._types.json#/$defs/ml._types__DataDescription","description":"The data description defines the format of the input data when you send data to the job by using the post data API.\nNote that when configure a datafeed, these properties are automatically set."},"datafeed_config":{"$ref":"./ml._types.json#/$defs/ml._types__DatafeedConfig","description":"The datafeed, which retrieves data from Elasticsearch for analysis by the job.\nYou can associate only one datafeed with each anomaly detection job."},"description":{"type":"string","description":"A description of the job."},"groups":{"type":"array","items":{"type":"string"},"description":"A list of job groups. A job can belong to no groups or many."},"job_id":{"type":"string","description":"Identifier for the anomaly detection job.\nThis identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.\nIt must start and end with alphanumeric characters."},"model_plot_config":{"$ref":"./ml._types.json#/$defs/ml._types__ModelPlotConfig","description":"This advanced configuration option stores model information along with the results.\nIt provides a more detailed view into anomaly detection.\nModel plot provides a simplified and indicative view of the model and its bounds."},"model_snapshot_retention_days":{"type":"number","description":"Advanced configuration option, which affects the automatic removal of old model snapshots for this job.\nIt specifies the maximum period of time (in days) that snapshots are retained.\nThis period is relative to the timestamp of the most recent snapshot for this job.\nThe default value is `10`, which means snapshots ten days older than the newest snapshot are deleted."},"renormalization_window_days":{"type":"number","description":"Advanced configuration option.\nThe period over which adjustments to the score are applied, as new data is seen.\nThe default value is the longer of 30 days or 100 `bucket_spans`."},"results_index_name":{"type":"string","description":"A text string that affects the name of the machine learning results index.\nThe default value is `shared`, which generates an index named `.ml-anomalies-shared`."},"results_retention_days":{"type":"number","description":"Advanced configuration option.\nThe period of time (in days) that results are retained.\nAge is calculated relative to the timestamp of the latest bucket result.\nIf this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch.\nThe default value is null, which means all results are retained.\nAnnotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results.\nAnnotations added by users are retained forever."}},"required":["analysis_config","data_description"]},"ml._types__AnalysisConfigRead":{"type":"object","properties":{"bucket_span":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The size of the interval that the analysis is aggregated into, typically between `5m` and `1h`. This value should be either a whole number of days or equate to a\nwhole number of buckets in one day. If the anomaly detection job uses a datafeed with aggregations, this value must also be divisible by the interval of the date histogram aggregation."},"detectors":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__DetectorRead"},"description":"Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned."},"influencers":{"type":"array","items":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."},"description":"A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity."},"categorization_analyzer":{"$ref":"./ml._types.json#/$defs/ml._types__CategorizationAnalyzer","description":"If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as `categorization_filters`. The categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process. The `categorization_analyzer` field can be specified either as a string or as an object. If it is a string, it must refer to a built-in analyzer or one added by another plugin."},"categorization_field_name":{"type":"string","description":"If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`."},"categorization_filters":{"type":"array","items":{"type":"string"},"description":"If `categorization_field_name` is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as `categorization_analyzer`. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the `categorization_analyzer` property instead and include the filters as pattern_replace character filters. The effect is exactly the same."},"latency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is applicable only when you send data by using the post data API."},"model_prune_window":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the `bucket_span`. If set too low, important information may be removed from the model. For jobs created in 8.1 and later, the default value is the greater of `30d` or 20 times `bucket_span`."},"multivariate_by_fields":{"type":"boolean","description":"This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to `true`, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the `multivariate_by_fields` property, you must also specify `by_field_name` in your detector."},"per_partition_categorization":{"$ref":"./ml._types.json#/$defs/ml._types__PerPartitionCategorization","description":"Settings related to how categorization interacts with partition fields."},"summary_count_field_name":{"type":"string","description":"If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function."}},"required":["bucket_span","detectors","influencers"]},"ml._types__DetectorRead":{"type":"object","properties":{"function":{"type":"string","description":"The analysis function that is used. For example, `count`, `rare`, `mean`, `min`, `max`, or `sum`."},"by_field_name":{"type":"string","description":"The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split."},"custom_rules":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__DetectionRule"},"description":"Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules."},"detector_description":{"type":"string","description":"A description of the detector."},"detector_index":{"type":"number","description":"A unique identifier for the detector. This identifier is based on the order of the detectors in the `analysis_config`, starting at zero. If you specify a value for this property, it is ignored."},"exclude_frequent":{"$ref":"./ml._types.json#/$defs/ml._types__ExcludeFrequent","description":"If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set `exclude_frequent` to `all` for both fields, or to `by` or `over` for those specific fields."},"field_name":{"type":"string","description":"The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes."},"over_field_name":{"type":"string","description":"The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits."},"partition_field_name":{"type":"string","description":"The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field."},"use_null":{"type":"boolean","description":"Defines whether a new series is used as the null series when there is no value for the by or partition fields."}},"required":["function"]},"ml._types__TrainedModelAssignment":{"type":"object","properties":{"adaptive_allocations":{"anyOf":[{"$ref":"./ml._types.json#/$defs/ml._types__AdaptiveAllocationsSettings"},{"type":"null"}]},"assignment_state":{"$ref":"./ml._types.json#/$defs/ml._types__DeploymentAssignmentState","description":"The overall assignment state."},"max_assigned_allocations":{"type":"number"},"reason":{"type":"string"},"routing_table":{"type":"object","additionalProperties":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelAssignmentRoutingTable"},"description":"The allocation state for each node."},"start_time":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The timestamp when the deployment started."},"task_parameters":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelAssignmentTaskParameters"}},"required":["assignment_state","routing_table","start_time","task_parameters"]},"ml._types__TrainedModelAssignmentRoutingTable":{"type":"object","properties":{"reason":{"type":"string","description":"The reason for the current state. It is usually populated only when the\n`routing_state` is `failed`."},"routing_state":{"$ref":"./ml._types.json#/$defs/ml._types__RoutingState","description":"The current routing state."},"current_allocations":{"type":"number","description":"Current number of allocations."},"target_allocations":{"type":"number","description":"Target number of allocations."}},"required":["routing_state","current_allocations","target_allocations"]},"ml._types__TrainedModelAssignmentTaskParameters":{"type":"object","properties":{"model_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The size of the trained model in bytes."},"model_id":{"type":"string","description":"The unique identifier for the trained model."},"deployment_id":{"type":"string","description":"The unique identifier for the trained model deployment."},"cache_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The size of the trained model cache.","x-availability":{"stack":{"since":"8.4.0"},"serverless":{}}},"number_of_allocations":{"type":"number","description":"The total number of allocations this model is assigned across ML nodes."},"priority":{"$ref":"./ml._types.json#/$defs/ml._types__TrainingPriority"},"per_deployment_memory_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"per_allocation_memory_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"queue_capacity":{"type":"number","description":"Number of inference requests are allowed in the queue at a time."},"threads_per_allocation":{"type":"number","description":"Number of threads per allocation."}},"required":["model_bytes","model_id","deployment_id","number_of_allocations","priority","per_deployment_memory_bytes","per_allocation_memory_bytes","queue_capacity","threads_per_allocation"]},"ml._types__AnalysisMemoryLimit":{"type":"object","properties":{"model_memory_limit":{"type":"string","description":"Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes."}},"required":["model_memory_limit"]},"ml._types__DetectorUpdate":{"type":"object","properties":{"detector_index":{"type":"number","description":"A unique identifier for the detector.\nThis identifier is based on the order of the detectors in the `analysis_config`, starting at zero."},"description":{"type":"string","description":"A description of the detector."},"custom_rules":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__DetectionRule"},"description":"An array of custom rule objects, which enable you to customize the way detectors operate.\nFor example, a rule may dictate to the detector conditions under which results should be skipped.\nKibana refers to custom rules as job rules."}},"required":["detector_index"]},"ml._types__TransformAuthorization":{"type":"object","properties":{"api_key":{"$ref":"./ml._types.json#/$defs/ml._types__ApiKeyAuthorization","description":"If an API key was used for the most recent update to the transform, its name and identifier are listed in the response."},"roles":{"type":"array","items":{"type":"string"},"description":"If a user ID was used for the most recent update to the transform, its roles at the time of the update are listed in the response."},"service_account":{"type":"string","description":"If a service account was used for the most recent update to the transform, the account name is listed in the response."}}}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"ml._types__RegressionInferenceOptions":{"type":"object","properties":{"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"num_top_feature_importance_values":{"type":"number","description":"Specifies the maximum number of feature importance values per document."}}},"ml._types__ClassificationInferenceOptions":{"type":"object","properties":{"num_top_classes":{"type":"number","description":"Specifies the number of top class predictions to return. Defaults to 0."},"num_top_feature_importance_values":{"type":"number","description":"Specifies the maximum number of feature importance values per document."},"prediction_field_type":{"type":"string","description":"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_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"top_classes_results_field":{"type":"string","description":"Specifies the field to which the top classes are written. Defaults to top_classes."}}},"ml._types__DatafeedState":{"enum":["started","stopped","starting","stopping"]},"ml._types__JobState":{"enum":["closing","closed","opened","failed","opening"]},"ml._types__MemoryStatus":{"enum":["ok","soft_limit","hard_limit"]},"ml._types__CategorizationStatus":{"enum":["ok","warn"]},"ml._types__AnalysisConfig":{"type":"object","properties":{"bucket_span":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The size of the interval that the analysis is aggregated into, typically between `5m` and `1h`. This value should be either a whole number of days or equate to a\nwhole number of buckets in one day. If the anomaly detection job uses a datafeed with aggregations, this value must also be divisible by the interval of the date histogram aggregation."},"categorization_analyzer":{"$ref":"./ml._types.json#/$defs/ml._types__CategorizationAnalyzer","description":"If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as `categorization_filters`. The categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process. The `categorization_analyzer` field can be specified either as a string or as an object. If it is a string, it must refer to a built-in analyzer or one added by another plugin."},"categorization_field_name":{"type":"string","description":"If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`."},"categorization_filters":{"type":"array","items":{"type":"string"},"description":"If `categorization_field_name` is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as `categorization_analyzer`. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the `categorization_analyzer` property instead and include the filters as pattern_replace character filters. The effect is exactly the same."},"detectors":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__Detector"},"description":"Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned."},"influencers":{"type":"array","items":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."},"description":"A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity."},"latency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is applicable only when you send data by using the post data API."},"model_prune_window":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the `bucket_span`. If set too low, important information may be removed from the model. For jobs created in 8.1 and later, the default value is the greater of `30d` or 20 times `bucket_span`."},"multivariate_by_fields":{"type":"boolean","description":"This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to `true`, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the `multivariate_by_fields` property, you must also specify `by_field_name` in your detector."},"per_partition_categorization":{"$ref":"./ml._types.json#/$defs/ml._types__PerPartitionCategorization","description":"Settings related to how categorization interacts with partition fields."},"summary_count_field_name":{"type":"string","description":"If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function."}},"required":["detectors"]},"ml._types__CategorizationAnalyzer":{"anyOf":[{"type":"string"},{"$ref":"./ml._types.json#/$defs/ml._types__CategorizationAnalyzerDefinition"}]},"ml._types__CategorizationAnalyzerDefinition":{"type":"object","properties":{"char_filter":{"type":"array","items":{"$ref":"./_types.analysis.json#/$defs/_types.analysis__CharFilter"},"description":"One or more character filters. In addition to the built-in character filters, other plugins can provide more character filters. If this property is not specified, no character filters are applied prior to categorization. If you are customizing some other aspect of the analyzer and you need to achieve the equivalent of `categorization_filters` (which are not permitted when some other aspect of the analyzer is customized), add them here as pattern replace character filters."},"filter":{"type":"array","items":{"$ref":"./_types.analysis.json#/$defs/_types.analysis__TokenFilter"},"description":"One or more token filters. In addition to the built-in token filters, other plugins can provide more token filters. If this property is not specified, no token filters are applied prior to categorization."},"tokenizer":{"$ref":"./_types.analysis.json#/$defs/_types.analysis__Tokenizer","description":"The name or definition of the tokenizer to use after character filters are applied. This property is compulsory if `categorization_analyzer` is specified as an object. Machine learning provides a tokenizer called `ml_standard` that tokenizes in a way that has been determined to produce good categorization results on a variety of log file formats for logs in English. If you want to use that tokenizer but change the character or token filters, specify \"tokenizer\": \"ml_standard\" in your `categorization_analyzer`. Additionally, the `ml_classic` tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2). `ml_classic` was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify \"tokenizer\": \"ml_classic\" in your `categorization_analyzer`."}}},"ml._types__Detector":{"type":"object","properties":{"by_field_name":{"type":"string","description":"The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split."},"custom_rules":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__DetectionRule"},"description":"Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules."},"detector_description":{"type":"string","description":"A description of the detector."},"detector_index":{"type":"number","description":"A unique identifier for the detector. This identifier is based on the order of the detectors in the `analysis_config`, starting at zero. If you specify a value for this property, it is ignored."},"exclude_frequent":{"$ref":"./ml._types.json#/$defs/ml._types__ExcludeFrequent","description":"If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set `exclude_frequent` to `all` for both fields, or to `by` or `over` for those specific fields."},"field_name":{"type":"string","description":"The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes."},"function":{"type":"string","description":"The analysis function that is used. For example, `count`, `rare`, `mean`, `min`, `max`, or `sum`."},"over_field_name":{"type":"string","description":"The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits."},"partition_field_name":{"type":"string","description":"The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field."},"use_null":{"type":"boolean","description":"Defines whether a new series is used as the null series when there is no value for the by or partition fields."}}},"ml._types__DetectionRule":{"type":"object","properties":{"actions":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__RuleAction"},"description":"The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined."},"conditions":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__RuleCondition"},"description":"An array of numeric conditions when the rule applies. A rule must either have a non-empty scope or at least one condition. Multiple conditions are combined together with a logical AND."},"scope":{"type":"object","additionalProperties":{"$ref":"./ml._types.json#/$defs/ml._types__FilterRef"},"description":"A scope of series where the rule applies. A rule must either have a non-empty scope or at least one condition. By default, the scope includes all series. Scoping is allowed for any of the fields that are also specified in `by_field_name`, `over_field_name`, or `partition_field_name`."}}},"ml._types__RuleAction":{"enum":["skip_result","skip_model_update"]},"ml._types__RuleCondition":{"type":"object","properties":{"applies_to":{"$ref":"./ml._types.json#/$defs/ml._types__AppliesTo","description":"Specifies the result property to which the condition applies. If your detector uses `lat_long`, `metric`, `rare`, or `freq_rare` functions, you can only specify conditions that apply to time."},"operator":{"$ref":"./ml._types.json#/$defs/ml._types__ConditionOperator","description":"Specifies the condition operator. The available options are greater than, greater than or equals, less than, and less than or equals."},"value":{"type":"number","description":"The value that is compared against the `applies_to` field using the operator."}},"required":["applies_to","operator","value"]},"ml._types__AppliesTo":{"enum":["actual","typical","diff_from_typical","time"]},"ml._types__ConditionOperator":{"enum":["gt","gte","lt","lte"]},"ml._types__FilterRef":{"type":"object","properties":{"filter_id":{"type":"string","description":"The identifier for the filter."},"filter_type":{"$ref":"./ml._types.json#/$defs/ml._types__FilterType","description":"If set to `include`, the rule applies for values in the filter. If set to `exclude`, the rule applies for values not in the filter."}},"required":["filter_id"]},"ml._types__FilterType":{"enum":["include","exclude"]},"ml._types__ExcludeFrequent":{"enum":["all","none","by","over"]},"ml._types__PerPartitionCategorization":{"type":"object","properties":{"enabled":{"type":"boolean","description":"To enable this setting, you must also set the `partition_field_name` property to the same value in every detector that uses the keyword `mlcategory`. Otherwise, job creation fails."},"stop_on_warn":{"type":"boolean","description":"This setting can be set to true only if per-partition categorization is enabled. If true, both categorization and subsequent anomaly detection stops for partitions where the categorization status changes to warn. This setting makes it viable to have a job where it is expected that categorization works well for some partitions but not others; you do not pay the cost of bad categorization forever in the partitions where it works badly."}}},"ml._types__DataframeEvaluationContainer":{"type":"object","properties":{"classification":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeEvaluationClassification","description":"Classification evaluation evaluates the results of a classification analysis which outputs a prediction that identifies to which of the classes each document belongs."},"outlier_detection":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeEvaluationOutlierDetection","description":"Outlier detection evaluates the results of an outlier detection analysis which outputs the probability that each document is an outlier."},"regression":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeEvaluationRegression","description":"Regression evaluation evaluates the results of a regression analysis which outputs a prediction of values."}}},"ml._types__DataframeEvaluationClassification":{"type":"object","properties":{"actual_field":{"type":"string","description":"The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true)."},"predicted_field":{"type":"string","description":"The field in the index which contains the predicted value, in other words the results of the classification analysis."},"top_classes_field":{"type":"string","description":"The field of the index which is an array of documents of the form { \"class_name\": XXX, \"class_probability\": YYY }. This field must be defined as nested in the mappings."},"metrics":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeEvaluationClassificationMetrics","description":"Specifies the metrics that are used for the evaluation."}},"required":["actual_field"]},"ml._types__DataframeEvaluationClassificationMetrics":{"type":"object","properties":{"auc_roc":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeEvaluationClassificationMetricsAucRoc","description":"The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as \"class_name\") treated as positive."},"precision":{"type":"object","additionalProperties":{},"description":"Precision of predictions (per-class and average)."},"recall":{"type":"object","additionalProperties":{},"description":"Recall of predictions (per-class and average)."},"accuracy":{"type":"object","additionalProperties":{},"description":"Accuracy of predictions (per-class and overall)."},"multiclass_confusion_matrix":{"type":"object","additionalProperties":{},"description":"Multiclass confusion matrix."}}},"ml._types__DataframeEvaluationClassificationMetricsAucRoc":{"type":"object","properties":{"class_name":{"type":"string","description":"Name of the only class that is treated as positive during AUC ROC calculation. Other classes are treated as negative (\"one-vs-all\" strategy). All the evaluated documents must have class_name in the list of their top classes."},"include_curve":{"type":"boolean","description":"Whether or not the curve should be returned in addition to the score. Default value is false."}}},"ml._types__DataframeEvaluationOutlierDetection":{"type":"object","properties":{"actual_field":{"type":"string","description":"The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true)."},"predicted_probability_field":{"type":"string","description":"The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis."},"metrics":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeEvaluationOutlierDetectionMetrics","description":"Specifies the metrics that are used for the evaluation."}},"required":["actual_field","predicted_probability_field"]},"ml._types__DataframeEvaluationOutlierDetectionMetrics":{"type":"object","properties":{"auc_roc":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeEvaluationClassificationMetricsAucRoc","description":"The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as \"class_name\") treated as positive."},"precision":{"type":"object","additionalProperties":{},"description":"Precision of predictions (per-class and average)."},"recall":{"type":"object","additionalProperties":{},"description":"Recall of predictions (per-class and average)."},"confusion_matrix":{"type":"object","additionalProperties":{},"description":"Accuracy of predictions (per-class and overall)."}}},"ml._types__DataframeEvaluationRegression":{"type":"object","properties":{"actual_field":{"type":"string","description":"The field of the index which contains the ground truth. The data type of this field must be numerical."},"predicted_field":{"type":"string","description":"The field in the index that contains the predicted value, in other words the results of the regression analysis."},"metrics":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeEvaluationRegressionMetrics","description":"Specifies the metrics that are used for the evaluation. For more information on mse, msle, and huber, consult the Jupyter notebook on regression loss functions."}},"required":["actual_field","predicted_field"]},"ml._types__DataframeEvaluationRegressionMetrics":{"type":"object","properties":{"mse":{"type":"object","additionalProperties":{},"description":"Average squared difference between the predicted values and the actual (ground truth) value. For more information, read this wiki article."},"msle":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeEvaluationRegressionMetricsMsle","description":"Average squared difference between the logarithm of the predicted values and the logarithm of the actual (ground truth) value."},"huber":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeEvaluationRegressionMetricsHuber","description":"Pseudo Huber loss function."},"r_squared":{"type":"object","additionalProperties":{},"description":"Proportion of the variance in the dependent variable that is predictable from the independent variables."}}},"ml._types__DataframeEvaluationRegressionMetricsMsle":{"type":"object","properties":{"offset":{"type":"number","description":"Defines the transition point at which you switch from minimizing quadratic error to minimizing quadratic log error. Defaults to 1."}}},"ml._types__DataframeEvaluationRegressionMetricsHuber":{"type":"object","properties":{"delta":{"type":"number","description":"Approximates 1/2 (prediction - actual)2 for values much less than delta and approximates a straight line with slope delta for values much larger than delta. Defaults to 1. Delta needs to be greater than 0."}}},"ml._types__DataframeAnalyticsSource":{"type":"object","properties":{"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index."},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {\"match_all\": {}}."},"runtime_mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RuntimeFields","description":"Definitions of runtime fields that will become part of the mapping of the destination index."},"_source":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisAnalyzedFields","description":"Specify `includes` and/or `excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis."}},"required":["index"]},"ml._types__DataframeAnalysisAnalyzedFields":{"type":"object","properties":{"includes":{"type":"array","items":{"type":"string"},"description":"An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically."},"excludes":{"type":"array","items":{"type":"string"},"description":"An array of strings that defines the fields that will be included in the analysis."}}},"ml._types__DataframeAnalyticsDestination":{"type":"object","properties":{"index":{"type":"string","description":"Defines the destination index to store the results of the data frame analytics job."},"results_field":{"type":"string","description":"Defines the name of the field in which to store the results of the analysis. Defaults to `ml`."}},"required":["index"]},"ml._types__DataframeAnalysisContainer":{"type":"object","properties":{"classification":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisClassification","description":"The configuration information necessary to perform classification."},"outlier_detection":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisOutlierDetection","description":"The configuration information necessary to perform outlier detection. NOTE: Advanced parameters are for fine-tuning classification analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters."},"regression":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisRegression","description":"The configuration information necessary to perform regression. NOTE: Advanced parameters are for fine-tuning regression analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters."}}},"ml._types__DataframeAnalysisClassification":{"type":"object","properties":{"alpha":{"type":"number","description":"Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero."},"dependent_variable":{"type":"string","description":"Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable.\nFor classification analysis, the data type of the field must be numeric (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or `boolean`. There must be no more than 30 different values in this field.\nFor regression analysis, the data type of the field must be numeric."},"downsample_factor":{"type":"number","description":"Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1."},"early_stopping_enabled":{"type":"boolean","description":"Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable."},"eta":{"type":"number","description":"Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1."},"eta_growth_rate_per_tree":{"type":"number","description":"Advanced configuration option. Specifies the rate at which `eta` increases for each new tree that is added to the forest. For example, a rate of 1.05 increases `eta` by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2."},"feature_bag_fraction":{"type":"number","description":"Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization."},"feature_processors":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisFeatureProcessor"},"description":"Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple `feature_processors` entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields."},"gamma":{"type":"number","description":"Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value."},"lambda":{"type":"number","description":"Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value."},"max_optimization_rounds_per_hyperparameter":{"type":"number","description":"Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization."},"max_trees":{"type":"number","description":"Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization."},"num_top_feature_importance_values":{"type":"number","description":"Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs."},"prediction_field_name":{"type":"string","description":"Defines the name of the prediction field in the results. Defaults to `<dependent_variable>_prediction`."},"randomize_seed":{"type":"number","description":"Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as `source` and `analyzed_fields` are the same)."},"soft_tree_depth_limit":{"type":"number","description":"Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0."},"soft_tree_depth_tolerance":{"type":"number","description":"Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01."},"training_percent":{"$ref":"./_types.json#/$defs/_types__Percentage","description":"Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage."},"class_assignment_objective":{"type":"string"},"num_top_classes":{"type":"number","description":"Defines the number of categories for which the predicted probabilities are reported. It must be non-negative or -1. If it is -1 or greater than the total number of categories, probabilities are reported for all categories; if you have a large number of categories, there could be a significant effect on the size of your destination index. NOTE: To use the AUC ROC evaluation method, `num_top_classes` must be set to -1 or a value greater than or equal to the total number of categories."}},"required":["dependent_variable"]},"ml._types__DataframeAnalysisFeatureProcessor":{"type":"object","properties":{"frequency_encoding":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisFeatureProcessorFrequencyEncoding","description":"The configuration information necessary to perform frequency encoding."},"multi_encoding":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisFeatureProcessorMultiEncoding","description":"The configuration information necessary to perform multi encoding. It allows multiple processors to be changed together. This way the output of a processor can then be passed to another as an input."},"n_gram_encoding":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisFeatureProcessorNGramEncoding","description":"The configuration information necessary to perform n-gram encoding. Features created by this encoder have the following name format: <feature_prefix>.<ngram><string position>. For example, if the feature_prefix is f, the feature name for the second unigram in a string is f.11."},"one_hot_encoding":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisFeatureProcessorOneHotEncoding","description":"The configuration information necessary to perform one hot encoding."},"target_mean_encoding":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisFeatureProcessorTargetMeanEncoding","description":"The configuration information necessary to perform target mean encoding."}}},"ml._types__DataframeAnalysisFeatureProcessorFrequencyEncoding":{"type":"object","properties":{"feature_name":{"type":"string","description":"The resulting feature name."},"field":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."},"frequency_map":{"type":"object","additionalProperties":{"type":"number"},"description":"The resulting frequency map for the field value. If the field value is missing from the frequency_map, the resulting value is 0."}},"required":["feature_name","field","frequency_map"]},"ml._types__DataframeAnalysisFeatureProcessorMultiEncoding":{"type":"object","properties":{"processors":{"type":"array","items":{"type":"number"},"description":"The ordered array of custom processors to execute. Must be more than 1."}},"required":["processors"]},"ml._types__DataframeAnalysisFeatureProcessorNGramEncoding":{"type":"object","properties":{"feature_prefix":{"type":"string","description":"The feature name prefix. Defaults to ngram_<start>_<length>."},"field":{"type":"string","description":"The name of the text field to encode."},"length":{"type":"number","description":"Specifies the length of the n-gram substring. Defaults to 50. Must be greater than 0."},"n_grams":{"type":"array","items":{"type":"number"},"description":"Specifies which n-grams to gather. It’s an array of integer values where the minimum value is 1, and a maximum value is 5."},"start":{"type":"number","description":"Specifies the zero-indexed start of the n-gram substring. Negative values are allowed for encoding n-grams of string suffixes. Defaults to 0."},"custom":{"type":"boolean"}},"required":["field","n_grams"]},"ml._types__DataframeAnalysisFeatureProcessorOneHotEncoding":{"type":"object","properties":{"field":{"type":"string","description":"The name of the field to encode."},"hot_map":{"type":"string","description":"The one hot map mapping the field value with the column name."}},"required":["field","hot_map"]},"ml._types__DataframeAnalysisFeatureProcessorTargetMeanEncoding":{"type":"object","properties":{"default_value":{"type":"number","description":"The default value if field value is not found in the target_map."},"feature_name":{"type":"string","description":"The resulting feature name."},"field":{"type":"string","description":"The name of the field to encode."},"target_map":{"type":"object","additionalProperties":{},"description":"The field value to target mean transition map."}},"required":["default_value","feature_name","field","target_map"]},"ml._types__DataframeAnalysisOutlierDetection":{"type":"object","properties":{"compute_feature_influence":{"type":"boolean","description":"Specifies whether the feature influence calculation is enabled."},"feature_influence_threshold":{"type":"number","description":"The minimum outlier score that a document needs to have in order to calculate its feature influence score. Value range: 0-1."},"method":{"type":"string","description":"The method that outlier detection uses. Available methods are `lof`, `ldof`, `distance_kth_nn`, `distance_knn`, and `ensemble`. The default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score."},"n_neighbors":{"type":"number","description":"Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score. When the value is not set, different values are used for different ensemble members. This default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set."},"outlier_fraction":{"type":"number","description":"The proportion of the data set that is assumed to be outlying prior to outlier detection. For example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers."},"standardization_enabled":{"type":"boolean","description":"If true, the following operation is performed on the columns before computing outlier scores: `(x_i - mean(x_i)) / sd(x_i)`."}}},"ml._types__DataframeAnalysisRegression":{"type":"object","properties":{"alpha":{"type":"number","description":"Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero."},"dependent_variable":{"type":"string","description":"Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable.\nFor classification analysis, the data type of the field must be numeric (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or `boolean`. There must be no more than 30 different values in this field.\nFor regression analysis, the data type of the field must be numeric."},"downsample_factor":{"type":"number","description":"Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1."},"early_stopping_enabled":{"type":"boolean","description":"Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable."},"eta":{"type":"number","description":"Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1."},"eta_growth_rate_per_tree":{"type":"number","description":"Advanced configuration option. Specifies the rate at which `eta` increases for each new tree that is added to the forest. For example, a rate of 1.05 increases `eta` by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2."},"feature_bag_fraction":{"type":"number","description":"Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization."},"feature_processors":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisFeatureProcessor"},"description":"Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple `feature_processors` entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields."},"gamma":{"type":"number","description":"Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value."},"lambda":{"type":"number","description":"Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value."},"max_optimization_rounds_per_hyperparameter":{"type":"number","description":"Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization."},"max_trees":{"type":"number","description":"Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization."},"num_top_feature_importance_values":{"type":"number","description":"Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs."},"prediction_field_name":{"type":"string","description":"Defines the name of the prediction field in the results. Defaults to `<dependent_variable>_prediction`."},"randomize_seed":{"type":"number","description":"Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as `source` and `analyzed_fields` are the same)."},"soft_tree_depth_limit":{"type":"number","description":"Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0."},"soft_tree_depth_tolerance":{"type":"number","description":"Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01."},"training_percent":{"$ref":"./_types.json#/$defs/_types__Percentage","description":"Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage."},"loss_function":{"type":"string","description":"The loss function used during regression. Available options are `mse` (mean squared error), `msle` (mean squared logarithmic error), `huber` (Pseudo-Huber loss)."},"loss_function_parameter":{"type":"number","description":"A positive number that is used as a parameter to the `loss_function`."}},"required":["dependent_variable"]},"ml._types__DataframeAnalyticsFieldSelection":{"type":"object","properties":{"is_included":{"type":"boolean","description":"Whether the field is selected to be included in the analysis."},"is_required":{"type":"boolean","description":"Whether the field is required."},"feature_type":{"type":"string","description":"The feature type of this field for the analysis. May be categorical or numerical."},"mapping_types":{"type":"array","items":{"type":"string"},"description":"The mapping types of the field."},"name":{"type":"string","description":"The field name."},"reason":{"type":"string","description":"The reason a field is not selected to be included in the analysis."}},"required":["is_included","is_required","mapping_types","name"]},"ml._types__DataframeAnalyticsMemoryEstimation":{"type":"object","properties":{"expected_memory_with_disk":{"type":"string","description":"Estimated memory usage under the assumption that overflowing to disk is allowed during data frame analytics. expected_memory_with_disk is usually smaller than expected_memory_without_disk as using disk allows to limit the main memory needed to perform data frame analytics."},"expected_memory_without_disk":{"type":"string","description":"Estimated memory usage under the assumption that the whole data frame analytics should happen in memory (i.e. without overflowing to disk)."}},"required":["expected_memory_with_disk","expected_memory_without_disk"]},"ml._types__Page":{"type":"object","properties":{"from":{"type":"number","description":"Skips the specified number of items."},"size":{"type":"number","description":"Specifies the maximum number of items to obtain."}}},"ml._types__BucketSummary":{"type":"object","properties":{"anomaly_score":{"type":"number","description":"The maximum anomaly score, between 0-100, for any of the bucket influencers. This is an overall, rate-limited\nscore for the job. All the anomaly records in the bucket contribute to this score. This value might be updated as\nnew data is analyzed."},"bucket_influencers":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__BucketInfluencer"}},"bucket_span":{"description":"The length of the bucket in seconds. This value matches the bucket span that is specified in the job."},"event_count":{"type":"number","description":"The number of input data records processed in this bucket."},"initial_anomaly_score":{"type":"number","description":"The maximum anomaly score for any of the bucket influencers. This is the initial value that was calculated at the\ntime the bucket was processed."},"is_interim":{"type":"boolean","description":"If true, this is an interim result. In other words, the results are calculated based on partial input data."},"job_id":{"type":"string","description":"Identifier for the anomaly detection job."},"processing_time_ms":{"description":"The amount of time, in milliseconds, that it took to analyze the bucket contents and calculate results."},"result_type":{"type":"string","description":"Internal. This value is always set to bucket."},"timestamp":{"description":"The start time of the bucket. This timestamp uniquely identifies the bucket. Events that occur exactly at the\ntimestamp of the bucket are included in the results for the bucket."},"timestamp_string":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The start time of the bucket. This timestamp uniquely identifies the bucket. Events that occur exactly at the\ntimestamp of the bucket are included in the results for the bucket."}},"required":["anomaly_score","bucket_influencers","bucket_span","event_count","initial_anomaly_score","is_interim","job_id","processing_time_ms","result_type","timestamp"]},"ml._types__BucketInfluencer":{"type":"object","properties":{"anomaly_score":{"type":"number","description":"A normalized score between 0-100, which is calculated for each bucket influencer. This score might be updated as\nnewer data is analyzed."},"bucket_span":{"description":"The length of the bucket in seconds. This value matches the bucket span that is specified in the job."},"influencer_field_name":{"type":"string","description":"The field name of the influencer."},"initial_anomaly_score":{"type":"number","description":"The score between 0-100 for each bucket influencer. This score is the initial value that was calculated at the\ntime the bucket was processed."},"is_interim":{"type":"boolean","description":"If true, this is an interim result. In other words, the results are calculated based on partial input data."},"job_id":{"type":"string","description":"Identifier for the anomaly detection job."},"probability":{"type":"number","description":"The probability that the bucket has this behavior, in the range 0 to 1. This value can be held to a high precision\nof over 300 decimal places, so the `anomaly_score` is provided as a human-readable and friendly interpretation of\nthis."},"raw_anomaly_score":{"type":"number","description":"Internal."},"result_type":{"type":"string","description":"Internal. This value is always set to `bucket_influencer`."},"timestamp":{"description":"The start time of the bucket for which these results were calculated."},"timestamp_string":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The start time of the bucket for which these results were calculated."}},"required":["anomaly_score","bucket_span","influencer_field_name","initial_anomaly_score","is_interim","job_id","probability","raw_anomaly_score","result_type","timestamp"]},"ml._types__CalendarEvent":{"type":"object","properties":{"calendar_id":{"type":"string","description":"A string that uniquely identifies a calendar."},"event_id":{"type":"string"},"description":{"type":"string","description":"A description of the scheduled event."},"end_time":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The timestamp for the end of the scheduled event in milliseconds since the epoch or ISO 8601 format."},"start_time":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format."},"skip_result":{"type":"boolean","description":"When true the model will not create results for this calendar period."},"skip_model_update":{"type":"boolean","description":"When true the model will not be updated for this calendar period."},"force_time_shift":{"type":"number","description":"Shift time by this many seconds. For example adjust time for daylight savings changes"}},"required":["description","end_time","start_time"]},"ml._types__Category":{"type":"object","properties":{"category_id":{"type":"number","description":"A unique identifier for the category. category_id is unique at the job level, even when per-partition categorization is enabled."},"examples":{"type":"array","items":{"type":"string"},"description":"A list of examples of actual values that matched the category."},"grok_pattern":{"type":"string","description":"[experimental] A Grok pattern that could be used in Logstash or an ingest pipeline to extract fields from messages that match the category. This field is experimental and may be changed or removed in a future release. The Grok patterns that are found are not optimal, but are often a good starting point for manual tweaking."},"job_id":{"type":"string","description":"Identifier for the anomaly detection job."},"max_matching_length":{"type":"number","description":"The maximum length of the fields that matched the category. The value is increased by 10% to enable matching for similar fields that have not been analyzed."},"partition_field_name":{"type":"string","description":"If per-partition categorization is enabled, this property identifies the field used to segment the categorization. It is not present when per-partition categorization is disabled."},"partition_field_value":{"type":"string","description":"If per-partition categorization is enabled, this property identifies the value of the partition_field_name for the category. It is not present when per-partition categorization is disabled."},"regex":{"type":"string","description":"A regular expression that is used to search for values that match the category."},"terms":{"type":"string","description":"A space separated list of the common tokens that are matched in values of the category."},"num_matches":{"type":"number","description":"The number of messages that have been matched by this category. This is only guaranteed to have the latest accurate count after a job _flush or _close"},"preferred_to_categories":{"type":"array","items":{"type":"string"},"description":"A list of category_id entries that this current category encompasses. Any new message that is processed by the categorizer will match against this category and not any of the categories in this list. This is only guaranteed to have the latest accurate list of categories after a job _flush or _close"},"p":{"type":"string"},"result_type":{"type":"string"},"mlcategory":{"type":"string"}},"required":["category_id","examples","job_id","max_matching_length","regex","terms","result_type","mlcategory"]},"ml._types__DataframeAnalyticsSummary":{"type":"object","properties":{"allow_lazy_start":{"type":"boolean"},"analysis":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisContainer"},"analyzed_fields":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisAnalyzedFields"},"authorization":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalyticsAuthorization","description":"The security privileges that the job uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the job, this property is omitted."},"create_time":{},"description":{"type":"string"},"dest":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalyticsDestination"},"id":{"type":"string"},"max_num_threads":{"type":"number"},"model_memory_limit":{"type":"string"},"source":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalyticsSource"},"version":{"type":"string"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata"}},"required":["analysis","dest","id","source"]},"ml._types__DataframeAnalyticsAuthorization":{"type":"object","properties":{"api_key":{"$ref":"./ml._types.json#/$defs/ml._types__ApiKeyAuthorization","description":"If an API key was used for the most recent update to the job, its name and identifier are listed in the response."},"roles":{"type":"array","items":{"type":"string"},"description":"If a user ID was used for the most recent update to the job, its roles at the time of the update are listed in the response."},"service_account":{"type":"string","description":"If a service account was used for the most recent update to the job, the account name is listed in the response."}}},"ml._types__ApiKeyAuthorization":{"type":"object","properties":{"id":{"type":"string","description":"The identifier for the API key."},"name":{"type":"string","description":"The name of the API key."}},"required":["id","name"]},"ml._types__DataframeAnalytics":{"type":"object","properties":{"analysis_stats":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalyticsStatsContainer","description":"An object containing information about the analysis job."},"assignment_explanation":{"type":"string","description":"For running jobs only, contains messages relating to the selection of a node to run the job."},"data_counts":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalyticsStatsDataCounts","description":"An object that provides counts for the quantity of documents skipped, used in training, or available for testing."},"id":{"type":"string","description":"The unique identifier of the data frame analytics job."},"memory_usage":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalyticsStatsMemoryUsage","description":"An object describing memory usage of the analytics. It is present only after the job is started and memory usage is reported."},"node":{"$ref":"./_types.json#/$defs/_types__NodeAttributes","description":"Contains properties for the node that runs the job. This information is available only for running jobs.","x-availability":{"stack":{}}},"progress":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalyticsStatsProgress"},"description":"The progress report of the data frame analytics job by phase."},"state":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeState","description":"The status of the data frame analytics job, which can be one of the following values: failed, started, starting, stopping, stopped."}},"required":["data_counts","id","memory_usage","progress","state"]},"ml._types__DataframeAnalyticsStatsContainer":{"type":"object","properties":{"classification_stats":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalyticsStatsHyperparameters","description":"An object containing information about the classification analysis job."},"outlier_detection_stats":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalyticsStatsOutlierDetection","description":"An object containing information about the outlier detection job."},"regression_stats":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalyticsStatsHyperparameters","description":"An object containing information about the regression analysis."}}},"ml._types__DataframeAnalyticsStatsHyperparameters":{"type":"object","properties":{"hyperparameters":{"$ref":"./ml._types.json#/$defs/ml._types__Hyperparameters","description":"An object containing the parameters of the classification analysis job."},"iteration":{"type":"number","description":"The number of iterations on the analysis."},"timestamp":{"description":"The timestamp when the statistics were reported in milliseconds since the epoch."},"timing_stats":{"$ref":"./ml._types.json#/$defs/ml._types__TimingStats","description":"An object containing time statistics about the data frame analytics job."},"validation_loss":{"$ref":"./ml._types.json#/$defs/ml._types__ValidationLoss","description":"An object containing information about validation loss."}},"required":["hyperparameters","iteration","timestamp","timing_stats","validation_loss"]},"ml._types__Hyperparameters":{"type":"object","properties":{"alpha":{"type":"number","description":"Advanced configuration option.\nMachine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly.\nThis parameter affects loss calculations by acting as a multiplier of the tree depth.\nHigher alpha values result in shallower trees and faster training times.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be greater than or equal to zero."},"lambda":{"type":"number","description":"Advanced configuration option.\nRegularization parameter to prevent overfitting on the training data set.\nMultiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest.\nA high lambda value causes training to favor small leaf weights.\nThis behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable.\nA small lambda value results in large individual trees and slower training.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be a nonnegative value."},"gamma":{"type":"number","description":"Advanced configuration option.\nRegularization parameter to prevent overfitting on the training data set.\nMultiplies a linear penalty associated with the size of individual trees in the forest.\nA high gamma value causes training to prefer small trees.\nA small gamma value results in larger individual trees and slower training.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be a nonnegative value."},"eta":{"type":"number","description":"Advanced configuration option.\nThe shrinkage applied to the weights.\nSmaller values result in larger forests which have a better generalization error.\nHowever, larger forests cause slower training.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be a value between `0.001` and `1`."},"eta_growth_rate_per_tree":{"type":"number","description":"Advanced configuration option.\nSpecifies the rate at which `eta` increases for each new tree that is added to the forest.\nFor example, a rate of 1.05 increases `eta` by 5% for each extra tree.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be between `0.5` and `2`."},"feature_bag_fraction":{"type":"number","description":"Advanced configuration option.\nDefines the fraction of features that will be used when selecting a random bag for each candidate split.\nBy default, this value is calculated during hyperparameter optimization."},"downsample_factor":{"type":"number","description":"Advanced configuration option.\nControls the fraction of data that is used to compute the derivatives of the loss function for tree training.\nA small value results in the use of a small fraction of the data.\nIf this value is set to be less than 1, accuracy typically improves.\nHowever, too small a value may result in poor convergence for the ensemble and so require more trees.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be greater than zero and less than or equal to 1."},"max_attempts_to_add_tree":{"type":"number","description":"If the algorithm fails to determine a non-trivial tree (more than a single leaf), this parameter determines how many of such consecutive failures are tolerated.\nOnce the number of attempts exceeds the threshold, the forest training stops."},"max_optimization_rounds_per_hyperparameter":{"type":"number","description":"Advanced configuration option.\nA multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure.\nThe maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter.\nBy default, this value is calculated during hyperparameter optimization."},"max_trees":{"type":"number","description":"Advanced configuration option.\nDefines the maximum number of decision trees in the forest.\nThe maximum value is 2000.\nBy default, this value is calculated during hyperparameter optimization."},"num_folds":{"type":"number","description":"The maximum number of folds for the cross-validation procedure."},"num_splits_per_feature":{"type":"number","description":"Determines the maximum number of splits for every feature that can occur in a decision tree when the tree is trained."},"soft_tree_depth_limit":{"type":"number","description":"Advanced configuration option.\nMachine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly.\nThis soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be greater than or equal to 0."},"soft_tree_depth_tolerance":{"type":"number","description":"Advanced configuration option.\nThis option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be greater than or equal to 0.01."}}},"ml._types__TimingStats":{"type":"object","properties":{"elapsed_time":{"description":"Runtime of the analysis in milliseconds."},"iteration_time":{"description":"Runtime of the latest iteration of the analysis in milliseconds."}},"required":["elapsed_time"]},"ml._types__ValidationLoss":{"type":"object","properties":{"fold_values":{"type":"array","items":{"type":"string"},"description":"Validation loss values for every added decision tree during the forest growing procedure."},"loss_type":{"type":"string","description":"The type of the loss metric. For example, binomial_logistic."}},"required":["fold_values","loss_type"]},"ml._types__DataframeAnalyticsStatsOutlierDetection":{"type":"object","properties":{"parameters":{"$ref":"./ml._types.json#/$defs/ml._types__OutlierDetectionParameters","description":"The list of job parameters specified by the user or determined by algorithmic heuristics."},"timestamp":{"description":"The timestamp when the statistics were reported in milliseconds since the epoch."},"timing_stats":{"$ref":"./ml._types.json#/$defs/ml._types__TimingStats","description":"An object containing time statistics about the data frame analytics job."}},"required":["parameters","timestamp","timing_stats"]},"ml._types__OutlierDetectionParameters":{"type":"object","properties":{"compute_feature_influence":{"type":"boolean","description":"Specifies whether the feature influence calculation is enabled."},"feature_influence_threshold":{"type":"number","description":"The minimum outlier score that a document needs to have in order to calculate its feature influence score.\nValue range: 0-1"},"method":{"type":"string","description":"The method that outlier detection uses.\nAvailable methods are `lof`, `ldof`, `distance_kth_nn`, `distance_knn`, and `ensemble`.\nThe default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score."},"n_neighbors":{"type":"number","description":"Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score.\nWhen the value is not set, different values are used for different ensemble members.\nThis default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set."},"outlier_fraction":{"type":"number","description":"The proportion of the data set that is assumed to be outlying prior to outlier detection.\nFor example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers."},"standardization_enabled":{"type":"boolean","description":"If `true`, the following operation is performed on the columns before computing outlier scores: (x_i - mean(x_i)) / sd(x_i)."}}},"ml._types__DataframeAnalyticsStatsDataCounts":{"type":"object","properties":{"skipped_docs_count":{"type":"number","description":"The number of documents that are skipped during the analysis because they contained values that are not supported by the analysis. For example, outlier detection does not support missing fields so it skips documents with missing fields. Likewise, all types of analysis skip documents that contain arrays with more than one element."},"test_docs_count":{"type":"number","description":"The number of documents that are not used for training the model and can be used for testing."},"training_docs_count":{"type":"number","description":"The number of documents that are used for training the model."}},"required":["skipped_docs_count","test_docs_count","training_docs_count"]},"ml._types__DataframeAnalyticsStatsMemoryUsage":{"type":"object","properties":{"memory_reestimate_bytes":{"type":"number","description":"This value is present when the status is hard_limit and it is a new estimate of how much memory the job needs."},"peak_usage_bytes":{"type":"number","description":"The number of bytes used at the highest peak of memory usage."},"status":{"type":"string","description":"The memory usage status."},"timestamp":{"description":"The timestamp when memory usage was calculated."}},"required":["peak_usage_bytes","status"]},"ml._types__DataframeAnalyticsStatsProgress":{"type":"object","properties":{"phase":{"type":"string","description":"Defines the phase of the data frame analytics job."},"progress_percent":{"type":"number","description":"The progress that the data frame analytics job has made expressed in percentage."}},"required":["phase","progress_percent"]},"ml._types__DataframeState":{"enum":["started","stopped","starting","stopping","failed"]},"ml._types__DatafeedStats":{"type":"object","properties":{"assignment_explanation":{"type":"string","description":"For started datafeeds only, contains messages relating to the selection of a node."},"datafeed_id":{"type":"string","description":"A numerical character string that uniquely identifies the datafeed.\nThis identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.\nIt must start and end with alphanumeric characters."},"node":{"$ref":"./ml._types.json#/$defs/ml._types__DiscoveryNodeCompact","description":"For started datafeeds only, this information pertains to the node upon which the datafeed is started.","x-availability":{"stack":{}}},"state":{"$ref":"./ml._types.json#/$defs/ml._types__DatafeedState","description":"The status of the datafeed, which can be one of the following values: `starting`, `started`, `stopping`, `stopped`."},"timing_stats":{"$ref":"./ml._types.json#/$defs/ml._types__DatafeedTimingStats","description":"An object that provides statistical information about timing aspect of this datafeed."},"running_state":{"$ref":"./ml._types.json#/$defs/ml._types__DatafeedRunningState","description":"An object containing the running state for this datafeed.\nIt is only provided if the datafeed is started."}},"required":["datafeed_id","state"]},"ml._types__DiscoveryNodeCompact":{"type":"object","properties":{"name":{"type":"string"},"ephemeral_id":{"type":"string"},"id":{"type":"string"},"transport_address":{"type":"string"},"attributes":{"type":"object","additionalProperties":{"type":"string"}}},"required":["name","ephemeral_id","id","transport_address","attributes"],"description":"Alternative representation of DiscoveryNode used in ml.get_job_stats and ml.get_datafeed_stats"},"ml._types__DatafeedTimingStats":{"type":"object","properties":{"bucket_count":{"type":"number","description":"The number of buckets processed."},"exponential_average_search_time_per_hour_ms":{"description":"The exponential average search time per hour, in milliseconds."},"exponential_average_calculation_context":{"$ref":"./ml._types.json#/$defs/ml._types__ExponentialAverageCalculationContext"},"job_id":{"type":"string","description":"Identifier for the anomaly detection job."},"search_count":{"type":"number","description":"The number of searches run by the datafeed."},"total_search_time_ms":{"description":"The total time the datafeed spent searching, in milliseconds."},"average_search_time_per_bucket_ms":{"description":"The average search time per bucket, in milliseconds."}},"required":["bucket_count","exponential_average_search_time_per_hour_ms","job_id","search_count","total_search_time_ms"]},"ml._types__ExponentialAverageCalculationContext":{"type":"object","properties":{"incremental_metric_value_ms":{},"latest_timestamp":{},"previous_exponential_average_ms":{}},"required":["incremental_metric_value_ms"]},"ml._types__DatafeedRunningState":{"type":"object","properties":{"real_time_configured":{"type":"boolean","description":"Indicates if the datafeed is \"real-time\"; meaning that the datafeed has no configured `end` time."},"real_time_running":{"type":"boolean","description":"Indicates whether the datafeed has finished running on the available past data.\nFor datafeeds without a configured `end` time, this means that the datafeed is now running on \"real-time\" data."},"search_interval":{"$ref":"./ml._types.json#/$defs/ml._types__RunningStateSearchInterval","description":"Provides the latest time interval the datafeed has searched."}},"required":["real_time_configured","real_time_running"]},"ml._types__RunningStateSearchInterval":{"type":"object","properties":{"end":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The end time."},"end_ms":{"description":"The end time as an epoch in milliseconds."},"start":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The start time."},"start_ms":{"description":"The start time as an epoch in milliseconds."}},"required":["end_ms","start_ms"]},"ml._types__Datafeed":{"type":"object","properties":{"aggregations":{"type":"object","additionalProperties":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer"}},"authorization":{"$ref":"./ml._types.json#/$defs/ml._types__DatafeedAuthorization","description":"The security privileges that the datafeed uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the datafeed, this property is omitted."},"chunking_config":{"$ref":"./ml._types.json#/$defs/ml._types__ChunkingConfig"},"datafeed_id":{"type":"string"},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: `150s`. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation."},"indices":{"type":"array","items":{"type":"string"}},"indexes":{"type":"array","items":{"type":"string"}},"job_id":{"type":"string"},"max_empty_searches":{"type":"number"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer"},"query_delay":{"$ref":"./_types.json#/$defs/_types__Duration"},"script_fields":{"type":"object","additionalProperties":{"$ref":"./_types.json#/$defs/_types__ScriptField"}},"scroll_size":{"type":"number"},"delayed_data_check_config":{"$ref":"./ml._types.json#/$defs/ml._types__DelayedDataCheckConfig"},"runtime_mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RuntimeFields"},"indices_options":{"$ref":"./_types.json#/$defs/_types__IndicesOptions"}},"required":["datafeed_id","indices","job_id","query","delayed_data_check_config"]},"ml._types__DatafeedAuthorization":{"type":"object","properties":{"api_key":{"$ref":"./ml._types.json#/$defs/ml._types__ApiKeyAuthorization","description":"If an API key was used for the most recent update to the datafeed, its name and identifier are listed in the response."},"roles":{"type":"array","items":{"type":"string"},"description":"If a user ID was used for the most recent update to the datafeed, its roles at the time of the update are listed in the response."},"service_account":{"type":"string","description":"If a service account was used for the most recent update to the datafeed, the account name is listed in the response."}}},"ml._types__ChunkingConfig":{"type":"object","properties":{"mode":{"$ref":"./ml._types.json#/$defs/ml._types__ChunkingMode","description":"If the mode is `auto`, the chunk size is dynamically calculated;\nthis is the recommended value when the datafeed does not use aggregations.\nIf the mode is `manual`, chunking is applied according to the specified `time_span`;\nuse this mode when the datafeed uses aggregations. If the mode is `off`, no chunking is applied."},"time_span":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The time span that each search will be querying. This setting is applicable only when the `mode` is set to `manual`."}},"required":["mode"]},"ml._types__ChunkingMode":{"enum":["auto","manual","off"]},"ml._types__DelayedDataCheckConfig":{"type":"object","properties":{"check_window":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The window of time that is searched for late data. This window of time ends with the latest finalized bucket.\nIt defaults to null, which causes an appropriate `check_window` to be calculated when the real-time datafeed runs.\nIn particular, the default `check_window` span calculation is based on the maximum of `2h` or `8 * bucket_span`."},"enabled":{"type":"boolean","description":"Specifies whether the datafeed periodically checks for delayed data."}},"required":["enabled"]},"ml._types__Filter":{"type":"object","properties":{"description":{"type":"string","description":"A description of the filter."},"filter_id":{"type":"string","description":"A string that uniquely identifies a filter."},"items":{"type":"array","items":{"type":"string"},"description":"An array of strings which is the filter item list."}},"required":["filter_id","items"]},"ml._types__Influencer":{"type":"object","properties":{"bucket_span":{"description":"The length of the bucket in seconds. This value matches the bucket span that is specified in the job."},"influencer_score":{"type":"number","description":"A normalized score between 0-100, which is based on the probability of the influencer in this bucket aggregated\nacross detectors. Unlike `initial_influencer_score`, this value is updated by a re-normalization process as new\ndata is analyzed."},"influencer_field_name":{"type":"string","description":"The field name of the influencer."},"influencer_field_value":{"type":"string","description":"The entity that influenced, contributed to, or was to blame for the anomaly."},"initial_influencer_score":{"type":"number","description":"A normalized score between 0-100, which is based on the probability of the influencer aggregated across detectors.\nThis is the initial value that was calculated at the time the bucket was processed."},"is_interim":{"type":"boolean","description":"If true, this is an interim result. In other words, the results are calculated based on partial input data."},"job_id":{"type":"string","description":"Identifier for the anomaly detection job."},"probability":{"type":"number","description":"The probability that the influencer has this behavior, in the range 0 to 1. This value can be held to a high\nprecision of over 300 decimal places, so the `influencer_score` is provided as a human-readable and friendly\ninterpretation of this value."},"result_type":{"type":"string","description":"Internal. This value is always set to `influencer`."},"timestamp":{"description":"The start time of the bucket for which these results were calculated."},"foo":{"type":"string","description":"Additional influencer properties are added, depending on the fields being analyzed. For example, if it’s\nanalyzing `user_name` as an influencer, a field `user_name` is added to the result document. This\ninformation enables you to filter the anomaly results more easily."}},"required":["bucket_span","influencer_score","influencer_field_name","influencer_field_value","initial_influencer_score","is_interim","job_id","probability","result_type","timestamp"]},"ml._types__JobStats":{"type":"object","properties":{"assignment_explanation":{"type":"string","description":"For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job."},"data_counts":{"$ref":"./ml._types.json#/$defs/ml._types__DataCounts","description":"An object that describes the quantity of input to the job and any related error counts.\nThe `data_count` values are cumulative for the lifetime of a job.\nIf a model snapshot is reverted or old results are deleted, the job counts are not reset."},"forecasts_stats":{"$ref":"./ml._types.json#/$defs/ml._types__JobForecastStatistics","description":"An object that provides statistical information about forecasts belonging to this job.\nSome statistics are omitted if no forecasts have been made."},"job_id":{"type":"string","description":"Identifier for the anomaly detection job."},"model_size_stats":{"$ref":"./ml._types.json#/$defs/ml._types__ModelSizeStats","description":"An object that provides information about the size and contents of the model."},"node":{"$ref":"./ml._types.json#/$defs/ml._types__DiscoveryNodeCompact","description":"Contains properties for the node that runs the job.\nThis information is available only for open jobs.","x-availability":{"stack":{}}},"open_time":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"For open jobs only, the elapsed time for which the job has been open."},"state":{"$ref":"./ml._types.json#/$defs/ml._types__JobState","description":"The status of the anomaly detection job, which can be one of the following values: `closed`, `closing`, `failed`, `opened`, `opening`."},"timing_stats":{"$ref":"./ml._types.json#/$defs/ml._types__JobTimingStats","description":"An object that provides statistical information about timing aspect of this job."},"deleting":{"type":"boolean","description":"Indicates that the process of deleting the job is in progress but not yet completed. It is only reported when `true`."}},"required":["data_counts","forecasts_stats","job_id","model_size_stats","state","timing_stats"]},"ml._types__DataCounts":{"type":"object","properties":{"bucket_count":{"type":"number"},"earliest_record_timestamp":{"type":"number"},"empty_bucket_count":{"type":"number"},"input_bytes":{"type":"number"},"input_field_count":{"type":"number"},"input_record_count":{"type":"number"},"invalid_date_count":{"type":"number"},"job_id":{"type":"string"},"last_data_time":{"type":"number"},"latest_empty_bucket_timestamp":{"type":"number"},"latest_record_timestamp":{"type":"number"},"latest_sparse_bucket_timestamp":{"type":"number"},"latest_bucket_timestamp":{"type":"number"},"log_time":{"type":"number"},"missing_field_count":{"type":"number"},"out_of_order_timestamp_count":{"type":"number"},"processed_field_count":{"type":"number"},"processed_record_count":{"type":"number"},"sparse_bucket_count":{"type":"number"}},"required":["bucket_count","empty_bucket_count","input_bytes","input_field_count","input_record_count","invalid_date_count","job_id","missing_field_count","out_of_order_timestamp_count","processed_field_count","processed_record_count","sparse_bucket_count"]},"ml._types__JobForecastStatistics":{"type":"object","properties":{"memory_bytes":{"$ref":"./ml._types.json#/$defs/ml._types__JobStatistics"},"processing_time_ms":{"$ref":"./ml._types.json#/$defs/ml._types__JobStatistics"},"records":{"$ref":"./ml._types.json#/$defs/ml._types__JobStatistics"},"status":{"type":"object","additionalProperties":{"type":"number"}},"total":{"type":"number"},"forecasted_jobs":{"type":"number"}},"required":["total","forecasted_jobs"]},"ml._types__JobStatistics":{"type":"object","properties":{"avg":{"type":"number"},"max":{"type":"number"},"min":{"type":"number"},"total":{"type":"number"}},"required":["avg","max","min","total"]},"ml._types__ModelSizeStats":{"type":"object","properties":{"bucket_allocation_failures_count":{"type":"number"},"job_id":{"type":"string"},"log_time":{"$ref":"./_types.json#/$defs/_types__DateTime"},"memory_status":{"$ref":"./ml._types.json#/$defs/ml._types__MemoryStatus"},"model_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"model_bytes_exceeded":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"model_bytes_memory_limit":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"output_memory_allocator_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"peak_model_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"assignment_memory_basis":{"type":"string"},"result_type":{"type":"string"},"total_by_field_count":{"type":"number"},"total_over_field_count":{"type":"number"},"total_partition_field_count":{"type":"number"},"categorization_status":{"$ref":"./ml._types.json#/$defs/ml._types__CategorizationStatus"},"categorized_doc_count":{"type":"number"},"dead_category_count":{"type":"number"},"failed_category_count":{"type":"number"},"frequent_category_count":{"type":"number"},"rare_category_count":{"type":"number"},"total_category_count":{"type":"number"},"timestamp":{"type":"number"}},"required":["bucket_allocation_failures_count","job_id","log_time","memory_status","model_bytes","result_type","total_by_field_count","total_over_field_count","total_partition_field_count","categorization_status","categorized_doc_count","dead_category_count","failed_category_count","frequent_category_count","rare_category_count","total_category_count"]},"ml._types__JobTimingStats":{"type":"object","properties":{"average_bucket_processing_time_ms":{},"bucket_count":{"type":"number"},"exponential_average_bucket_processing_time_ms":{},"exponential_average_bucket_processing_time_per_hour_ms":{},"job_id":{"type":"string"},"total_bucket_processing_time_ms":{},"maximum_bucket_processing_time_ms":{},"minimum_bucket_processing_time_ms":{}},"required":["bucket_count","exponential_average_bucket_processing_time_per_hour_ms","job_id","total_bucket_processing_time_ms"]},"ml._types__Job":{"type":"object","properties":{"allow_lazy_open":{"type":"boolean","description":"Advanced configuration option.\nSpecifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node."},"analysis_config":{"$ref":"./ml._types.json#/$defs/ml._types__AnalysisConfig","description":"The analysis configuration, which specifies how to analyze the data.\nAfter you create a job, you cannot change the analysis configuration; all the properties are informational."},"analysis_limits":{"$ref":"./ml._types.json#/$defs/ml._types__AnalysisLimits","description":"Limits can be applied for the resources required to hold the mathematical models in memory.\nThese limits are approximate and can be set per job.\nThey do not control the memory used by other processes, for example the Elasticsearch Java processes."},"background_persist_interval":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Advanced configuration option.\nThe time between each periodic persistence of the model.\nThe default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time.\nThe smallest allowed value is 1 hour."},"blocked":{"$ref":"./ml._types.json#/$defs/ml._types__JobBlocked"},"create_time":{"$ref":"./_types.json#/$defs/_types__DateTime"},"custom_settings":{"$ref":"./ml._types.json#/$defs/ml._types__CustomSettings","description":"Advanced configuration option.\nContains custom metadata about the job."},"daily_model_snapshot_retention_after_days":{"type":"number","description":"Advanced configuration option, which affects the automatic removal of old model snapshots for this job.\nIt specifies a period of time (in days) after which only the first snapshot per day is retained.\nThis period is relative to the timestamp of the most recent snapshot for this job.\nValid values range from 0 to `model_snapshot_retention_days`."},"data_description":{"$ref":"./ml._types.json#/$defs/ml._types__DataDescription","description":"The data description defines the format of the input data when you send data to the job by using the post data API.\nNote that when configuring a datafeed, these properties are automatically set.\nWhen data is received via the post data API, it is not stored in Elasticsearch.\nOnly the results for anomaly detection are retained."},"datafeed_config":{"$ref":"./ml._types.json#/$defs/ml._types__Datafeed","description":"The datafeed, which retrieves data from Elasticsearch for analysis by the job.\nYou can associate only one datafeed with each anomaly detection job."},"deleting":{"type":"boolean","description":"Indicates that the process of deleting the job is in progress but not yet completed.\nIt is only reported when `true`."},"description":{"type":"string","description":"A description of the job."},"finished_time":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"If the job closed or failed, this is the time the job finished, otherwise it is `null`.\nThis property is informational; you cannot change its value."},"groups":{"type":"array","items":{"type":"string"},"description":"A list of job groups.\nA job can belong to no groups or many."},"job_id":{"type":"string","description":"Identifier for the anomaly detection job.\nThis identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.\nIt must start and end with alphanumeric characters."},"job_type":{"type":"string","description":"Reserved for future use, currently set to `anomaly_detector`."},"job_version":{"type":"string","description":"The machine learning configuration version number at which the the job was created."},"model_plot_config":{"$ref":"./ml._types.json#/$defs/ml._types__ModelPlotConfig","description":"This advanced configuration option stores model information along with the results.\nIt provides a more detailed view into anomaly detection.\nModel plot provides a simplified and indicative view of the model and its bounds."},"model_snapshot_id":{"type":"string"},"model_snapshot_retention_days":{"type":"number","description":"Advanced configuration option, which affects the automatic removal of old model snapshots for this job.\nIt specifies the maximum period of time (in days) that snapshots are retained.\nThis period is relative to the timestamp of the most recent snapshot for this job.\nBy default, snapshots ten days older than the newest snapshot are deleted."},"renormalization_window_days":{"type":"number","description":"Advanced configuration option.\nThe period over which adjustments to the score are applied, as new data is seen.\nThe default value is the longer of 30 days or 100 `bucket_spans`."},"results_index_name":{"type":"string","description":"A text string that affects the name of the machine learning results index.\nThe default value is `shared`, which generates an index named `.ml-anomalies-shared`."},"results_retention_days":{"type":"number","description":"Advanced configuration option.\nThe period of time (in days) that results are retained.\nAge is calculated relative to the timestamp of the latest bucket result.\nIf this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch.\nThe default value is null, which means all results are retained.\nAnnotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results.\nAnnotations added by users are retained forever."}},"required":["allow_lazy_open","analysis_config","data_description","job_id","model_snapshot_retention_days","results_index_name"]},"ml._types__AnalysisLimits":{"type":"object","properties":{"categorization_examples_limit":{"type":"number","description":"The maximum number of examples stored per category in memory and in the results data store. If you increase this value, more examples are available, however it requires that you have more storage available. If you set this value to 0, no examples are stored. NOTE: The `categorization_examples_limit` applies only to analysis that uses categorization."},"model_memory_limit":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The approximate maximum amount of memory resources that are required for analytical processing. Once this limit is approached, data pruning becomes more aggressive. Upon exceeding this limit, new entities are not modeled. If the `xpack.ml.max_model_memory_limit` setting has a value greater than 0 and less than 1024mb, that value is used instead of the default. The default value is relatively small to ensure that high resource usage is a conscious decision. If you have jobs that are expected to analyze high cardinality fields, you will likely need to use a higher value. If you specify a number instead of a string, the units are assumed to be MiB. Specifying a string is recommended for clarity. If you specify a byte size unit of `b` or `kb` and the number does not equate to a discrete number of megabytes, it is rounded down to the closest MiB. The minimum valid value is 1 MiB. If you specify a value less than 1 MiB, an error occurs. If you specify a value for the `xpack.ml.max_model_memory_limit` setting, an error occurs when you try to create jobs that have `model_memory_limit` values greater than that setting value."}}},"ml._types__JobBlocked":{"type":"object","properties":{"reason":{"$ref":"./ml._types.json#/$defs/ml._types__JobBlockedReason"},"task_id":{"type":"string"}},"required":["reason"]},"ml._types__JobBlockedReason":{"enum":["delete","reset","revert"]},"ml._types__CustomSettings":{"description":"Custom metadata about the job"},"ml._types__DataDescription":{"type":"object","properties":{"format":{"type":"string","description":"Only JSON format is supported at this time."},"time_field":{"type":"string","description":"The name of the field that contains the timestamp."},"time_format":{"type":"string","description":"The time format, which can be `epoch`, `epoch_ms`, or a custom pattern. The value `epoch` refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The value `epoch_ms` indicates that time is measured in milliseconds since the epoch. The `epoch` and `epoch_ms` time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: `yyyy-MM-dd'T'HH:mm:ssX`. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails."},"field_delimiter":{"type":"string"}}},"ml._types__ModelPlotConfig":{"type":"object","properties":{"annotations_enabled":{"type":"boolean","description":"If true, enables calculation and storage of the model change annotations for each entity that is being analyzed.","x-availability":{"stack":{"since":"7.9.0"},"serverless":{}}},"enabled":{"type":"boolean","description":"If true, enables calculation and storage of the model bounds for each entity that is being analyzed."},"terms":{"type":"string","description":"Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer.","x-availability":{"stack":{"since":"7.9.0"},"serverless":{}}}}},"ml._types__ModelSnapshotUpgrade":{"type":"object","properties":{"job_id":{"type":"string"},"snapshot_id":{"type":"string"},"state":{"$ref":"./ml._types.json#/$defs/ml._types__SnapshotUpgradeState"},"node":{"$ref":"./ml._types.json#/$defs/ml._types__DiscoveryNode","x-availability":{"stack":{}}},"assignment_explanation":{"type":"string"}},"required":["job_id","snapshot_id","state","node","assignment_explanation"]},"ml._types__SnapshotUpgradeState":{"enum":["loading_old_state","saving_new_state","stopped","failed"]},"ml._types__DiscoveryNode":{"type":"object","additionalProperties":{"$ref":"./ml._types.json#/$defs/ml._types__DiscoveryNodeContent"},"minProperties":1,"maxProperties":1},"ml._types__DiscoveryNodeContent":{"type":"object","properties":{"name":{"type":"string"},"ephemeral_id":{"type":"string"},"transport_address":{"type":"string"},"external_id":{"type":"string"},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"roles":{"type":"array","items":{"type":"string"}},"version":{"type":"string"},"min_index_version":{"type":"number"},"max_index_version":{"type":"number"}},"required":["ephemeral_id","transport_address","external_id","attributes","roles","version","min_index_version","max_index_version"]},"ml._types__ModelSnapshot":{"type":"object","properties":{"description":{"type":"string","description":"An optional description of the job."},"job_id":{"type":"string","description":"A numerical character string that uniquely identifies the job that the snapshot was created for."},"latest_record_time_stamp":{"type":"number","description":"The timestamp of the latest processed record."},"latest_result_time_stamp":{"type":"number","description":"The timestamp of the latest bucket result."},"min_version":{"type":"string","description":"The minimum version required to be able to restore the model snapshot."},"model_size_stats":{"$ref":"./ml._types.json#/$defs/ml._types__ModelSizeStats","description":"Summary information describing the model."},"retain":{"type":"boolean","description":"If true, this snapshot will not be deleted during automatic cleanup of snapshots older than model_snapshot_retention_days. However, this snapshot will be deleted when the job is deleted. The default value is false."},"snapshot_doc_count":{"type":"number","description":"For internal use only."},"snapshot_id":{"type":"string","description":"A numerical character string that uniquely identifies the model snapshot."},"timestamp":{"type":"number","description":"The creation timestamp for the snapshot."}},"required":["job_id","min_version","retain","snapshot_doc_count","snapshot_id","timestamp"]},"ml._types__OverallBucket":{"type":"object","properties":{"bucket_span":{"description":"The length of the bucket in seconds. Matches the job with the longest bucket_span value."},"is_interim":{"type":"boolean","description":"If true, this is an interim result. In other words, the results are calculated based on partial input data."},"jobs":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__OverallBucketJob"},"description":"An array of objects that contain the max_anomaly_score per job_id."},"overall_score":{"type":"number","description":"The top_n average of the maximum bucket anomaly_score per job."},"result_type":{"type":"string","description":"Internal. This is always set to overall_bucket."},"timestamp":{"description":"The start time of the bucket for which these results were calculated."},"timestamp_string":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The start time of the bucket for which these results were calculated."}},"required":["bucket_span","is_interim","jobs","overall_score","result_type","timestamp"]},"ml._types__OverallBucketJob":{"type":"object","properties":{"job_id":{"type":"string"},"max_anomaly_score":{"type":"number"}},"required":["job_id","max_anomaly_score"]},"ml._types__Anomaly":{"type":"object","properties":{"actual":{"type":"array","items":{"type":"number"},"description":"The actual value for the bucket."},"anomaly_score_explanation":{"$ref":"./ml._types.json#/$defs/ml._types__AnomalyExplanation","description":"Information about the factors impacting the initial anomaly score."},"bucket_span":{"description":"The length of the bucket in seconds. This value matches the `bucket_span` that is specified in the job."},"by_field_name":{"type":"string","description":"The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split."},"by_field_value":{"type":"string","description":"The value of `by_field_name`."},"causes":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__AnomalyCause"},"description":"For population analysis, an over field must be specified in the detector. This property contains an array of anomaly records that are the causes for the anomaly that has been identified for the over field. This sub-resource contains the most anomalous records for the `over_field_name`. For scalability reasons, a maximum of the 10 most significant causes of the anomaly are returned. As part of the core analytical modeling, these low-level anomaly records are aggregated for their parent over field record. The `causes` resource contains similar elements to the record resource, namely `actual`, `typical`, `geo_results.actual_point`, `geo_results.typical_point`, `*_field_name` and `*_field_value`. Probability and scores are not applicable to causes."},"detector_index":{"type":"number","description":"A unique identifier for the detector."},"field_name":{"type":"string","description":"Certain functions require a field to operate on, for example, `sum()`. For those functions, this value is the name of the field to be analyzed."},"function":{"type":"string","description":"The function in which the anomaly occurs, as specified in the detector configuration. For example, `max`."},"function_description":{"type":"string","description":"The description of the function in which the anomaly occurs, as specified in the detector configuration."},"geo_results":{"$ref":"./ml._types.json#/$defs/ml._types__GeoResults","description":"If the detector function is `lat_long`, this object contains comma delimited strings for the latitude and longitude of the actual and typical values."},"influencers":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__Influence"},"description":"If influencers were specified in the detector configuration, this array contains influencers that contributed to or were to blame for an anomaly."},"initial_record_score":{"type":"number","description":"A normalized score between 0-100, which is based on the probability of the anomalousness of this record. This is the initial value that was calculated at the time the bucket was processed."},"is_interim":{"type":"boolean","description":"If true, this is an interim result. In other words, the results are calculated based on partial input data."},"job_id":{"type":"string","description":"Identifier for the anomaly detection job."},"over_field_name":{"type":"string","description":"The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits."},"over_field_value":{"type":"string","description":"The value of `over_field_name`."},"partition_field_name":{"type":"string","description":"The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field."},"partition_field_value":{"type":"string","description":"The value of `partition_field_name`."},"probability":{"type":"number","description":"The probability of the individual anomaly occurring, in the range 0 to 1. For example, `0.0000772031`. This value can be held to a high precision of over 300 decimal places, so the `record_score` is provided as a human-readable and friendly interpretation of this."},"record_score":{"type":"number","description":"A normalized score between 0-100, which is based on the probability of the anomalousness of this record. Unlike `initial_record_score`, this value will be updated by a re-normalization process as new data is analyzed."},"result_type":{"type":"string","description":"Internal. This is always set to `record`."},"timestamp":{"description":"The start time of the bucket for which these results were calculated."},"typical":{"type":"array","items":{"type":"number"},"description":"The typical value for the bucket, according to analytical modeling."}},"required":["bucket_span","detector_index","initial_record_score","is_interim","job_id","probability","record_score","result_type","timestamp"]},"ml._types__AnomalyExplanation":{"type":"object","properties":{"anomaly_characteristics_impact":{"type":"number","description":"Impact from the duration and magnitude of the detected anomaly relative to the historical average."},"anomaly_length":{"type":"number","description":"Length of the detected anomaly in the number of buckets."},"anomaly_type":{"type":"string","description":"Type of the detected anomaly: `spike` or `dip`."},"high_variance_penalty":{"type":"boolean","description":"Indicates reduction of anomaly score for the bucket with large confidence intervals. If a bucket has large confidence intervals, the score is reduced."},"incomplete_bucket_penalty":{"type":"boolean","description":"If the bucket contains fewer samples than expected, the score is reduced."},"lower_confidence_bound":{"type":"number","description":"Lower bound of the 95% confidence interval."},"multi_bucket_impact":{"type":"number","description":"Impact of the deviation between actual and typical values in the past 12 buckets."},"single_bucket_impact":{"type":"number","description":"Impact of the deviation between actual and typical values in the current bucket."},"typical_value":{"type":"number","description":"Typical (expected) value for this bucket."},"upper_confidence_bound":{"type":"number","description":"Upper bound of the 95% confidence interval."}}},"ml._types__AnomalyCause":{"type":"object","properties":{"actual":{"type":"array","items":{"type":"number"}},"by_field_name":{"type":"string"},"by_field_value":{"type":"string"},"correlated_by_field_value":{"type":"string"},"field_name":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."},"function":{"type":"string"},"function_description":{"type":"string"},"geo_results":{"$ref":"./ml._types.json#/$defs/ml._types__GeoResults"},"influencers":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__Influence"}},"over_field_name":{"type":"string"},"over_field_value":{"type":"string"},"partition_field_name":{"type":"string"},"partition_field_value":{"type":"string"},"probability":{"type":"number"},"typical":{"type":"array","items":{"type":"number"}}},"required":["probability"]},"ml._types__GeoResults":{"type":"object","properties":{"actual_point":{"type":"string","description":"The actual value for the bucket formatted as a `geo_point`."},"typical_point":{"type":"string","description":"The typical value for the bucket formatted as a `geo_point`."}}},"ml._types__Influence":{"type":"object","properties":{"influencer_field_name":{"type":"string"},"influencer_field_values":{"type":"array","items":{"type":"string"}}},"required":["influencer_field_name","influencer_field_values"]},"ml._types__Include":{"enum":["definition","feature_importance_baseline","hyperparameters","total_feature_importance","definition_status"]},"ml._types__TrainedModelConfig":{"type":"object","properties":{"model_id":{"type":"string","description":"Identifier for the trained model."},"model_type":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelType","description":"The model type"},"tags":{"type":"array","items":{"type":"string"},"description":"A comma delimited string of tags. A trained model can have many tags, or none."},"version":{"type":"string","description":"The Elasticsearch version number in which the trained model was created."},"compressed_definition":{"type":"string"},"created_by":{"type":"string","description":"Information on the creator of the trained model."},"create_time":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The time when the trained model was created."},"default_field_map":{"type":"object","additionalProperties":{"type":"string"},"description":"Any field map described in the inference configuration takes precedence."},"description":{"type":"string","description":"The free-text description of the trained model."},"estimated_heap_memory_usage_bytes":{"type":"number","description":"The estimated heap usage in bytes to keep the trained model in memory."},"estimated_operations":{"type":"number","description":"The estimated number of operations to use the trained model."},"fully_defined":{"type":"boolean","description":"True if the full model definition is present."},"inference_config":{"$ref":"./ml._types.json#/$defs/ml._types__InferenceConfigCreateContainer","description":"The default configuration for inference. This can be either a regression, classification, or one of the many NLP focused configurations. It must match the underlying definition.trained_model's target_type. For pre-packaged models such as ELSER the config is not required."},"input":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelConfigInput","description":"The input field names for the model definition."},"license_level":{"type":"string","description":"The license level of the trained model."},"metadata":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelConfigMetadata","description":"An object containing metadata about the trained model. For example, models created by data frame analytics contain analysis_config and input objects."},"model_size_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"model_package":{"$ref":"./ml._types.json#/$defs/ml._types__ModelPackageConfig"},"location":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelLocation"},"platform_architecture":{"type":"string"},"prefix_strings":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelPrefixStrings"}},"required":["model_id","tags","input"]},"ml._types__TrainedModelType":{"enum":["tree_ensemble","lang_ident","pytorch"]},"ml._types__InferenceConfigCreateContainer":{"type":"object","properties":{"regression":{"$ref":"./ml._types.json#/$defs/ml._types__RegressionInferenceOptions","description":"Regression configuration for inference."},"classification":{"$ref":"./ml._types.json#/$defs/ml._types__ClassificationInferenceOptions","description":"Classification configuration for inference."},"text_classification":{"$ref":"./ml._types.json#/$defs/ml._types__TextClassificationInferenceOptions","description":"Text classification configuration for inference.","x-availability":{"stack":{"since":"8.0.0"},"serverless":{}}},"zero_shot_classification":{"$ref":"./ml._types.json#/$defs/ml._types__ZeroShotClassificationInferenceOptions","description":"Zeroshot classification configuration for inference.","x-availability":{"stack":{"since":"8.0.0"},"serverless":{}}},"fill_mask":{"$ref":"./ml._types.json#/$defs/ml._types__FillMaskInferenceOptions","description":"Fill mask configuration for inference.","x-availability":{"stack":{"since":"8.0.0"},"serverless":{}}},"learning_to_rank":{"$ref":"./ml._types.json#/$defs/ml._types__LearningToRankConfig"},"ner":{"$ref":"./ml._types.json#/$defs/ml._types__NerInferenceOptions","description":"Named entity recognition configuration for inference.","x-availability":{"stack":{"since":"8.0.0"},"serverless":{}}},"pass_through":{"$ref":"./ml._types.json#/$defs/ml._types__PassThroughInferenceOptions","description":"Pass through configuration for inference.","x-availability":{"stack":{"since":"8.0.0"},"serverless":{}}},"text_embedding":{"$ref":"./ml._types.json#/$defs/ml._types__TextEmbeddingInferenceOptions","description":"Text embedding configuration for inference.","x-availability":{"stack":{"since":"8.0.0"},"serverless":{}}},"text_expansion":{"$ref":"./ml._types.json#/$defs/ml._types__TextExpansionInferenceOptions","description":"Text expansion configuration for inference.","x-availability":{"stack":{"since":"8.8.0"},"serverless":{}}},"question_answering":{"$ref":"./ml._types.json#/$defs/ml._types__QuestionAnsweringInferenceOptions","description":"Question answering configuration for inference.","x-availability":{"stack":{"since":"8.3.0"},"serverless":{}}}},"description":"Inference configuration provided when storing the model config"},"ml._types__TextClassificationInferenceOptions":{"type":"object","properties":{"num_top_classes":{"type":"number","description":"Specifies the number of top class predictions to return. Defaults to 0."},"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__TokenizationConfigContainer","description":"The tokenization options"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"classification_labels":{"type":"array","items":{"type":"string"},"description":"Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels"},"vocabulary":{"$ref":"./ml._types.json#/$defs/ml._types__Vocabulary"}},"description":"Text classification configuration options"},"ml._types__TokenizationConfigContainer":{"type":"object","properties":{"bert":{"$ref":"./ml._types.json#/$defs/ml._types__NlpBertTokenizationConfig","description":"Indicates BERT tokenization and its options"},"bert_ja":{"$ref":"./ml._types.json#/$defs/ml._types__NlpBertTokenizationConfig","description":"Indicates BERT Japanese tokenization and its options"},"mpnet":{"$ref":"./ml._types.json#/$defs/ml._types__NlpBertTokenizationConfig","description":"Indicates MPNET tokenization and its options","x-availability":{"stack":{"since":"8.1.0"},"serverless":{}}},"roberta":{"$ref":"./ml._types.json#/$defs/ml._types__NlpRobertaTokenizationConfig","description":"Indicates RoBERTa tokenization and its options","x-availability":{"stack":{"since":"8.2.0"},"serverless":{}}},"xlm_roberta":{"$ref":"./ml._types.json#/$defs/ml._types__XlmRobertaTokenizationConfig"}},"description":"Tokenization options stored in inference configuration"},"ml._types__NlpBertTokenizationConfig":{"type":"object","properties":{"do_lower_case":{"type":"boolean","description":"Should the tokenizer lower case the text"},"max_sequence_length":{"type":"number","description":"Maximum input sequence length for the model"},"span":{"type":"number","description":"Tokenization spanning options. Special value of -1 indicates no spanning takes place"},"truncate":{"$ref":"./ml._types.json#/$defs/ml._types__TokenizationTruncate","description":"Should tokenization input be automatically truncated before sending to the model for inference"},"with_special_tokens":{"type":"boolean","description":"Is tokenization completed with special tokens"}},"description":"BERT and MPNet tokenization configuration options"},"ml._types__TokenizationTruncate":{"enum":["first","second","none"]},"ml._types__NlpRobertaTokenizationConfig":{"type":"object","properties":{"do_lower_case":{"type":"boolean","description":"Should the tokenizer lower case the text"},"max_sequence_length":{"type":"number","description":"Maximum input sequence length for the model"},"span":{"type":"number","description":"Tokenization spanning options. Special value of -1 indicates no spanning takes place"},"truncate":{"$ref":"./ml._types.json#/$defs/ml._types__TokenizationTruncate","description":"Should tokenization input be automatically truncated before sending to the model for inference"},"with_special_tokens":{"type":"boolean","description":"Is tokenization completed with special tokens"},"add_prefix_space":{"type":"boolean","description":"Should the tokenizer prefix input with a space character"}},"description":"RoBERTa tokenization configuration options"},"ml._types__XlmRobertaTokenizationConfig":{"type":"object","properties":{"do_lower_case":{"type":"boolean","description":"Should the tokenizer lower case the text"},"max_sequence_length":{"type":"number","description":"Maximum input sequence length for the model"},"span":{"type":"number","description":"Tokenization spanning options. Special value of -1 indicates no spanning takes place"},"truncate":{"$ref":"./ml._types.json#/$defs/ml._types__TokenizationTruncate","description":"Should tokenization input be automatically truncated before sending to the model for inference"},"with_special_tokens":{"type":"boolean","description":"Is tokenization completed with special tokens"}}},"ml._types__Vocabulary":{"type":"object","properties":{"index":{"type":"string"}},"required":["index"]},"ml._types__ZeroShotClassificationInferenceOptions":{"type":"object","properties":{"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__TokenizationConfigContainer","description":"The tokenization options to update when inferring"},"hypothesis_template":{"type":"string","description":"Hypothesis template used when tokenizing labels for prediction"},"classification_labels":{"type":"array","items":{"type":"string"},"description":"The zero shot classification labels indicating entailment, neutral, and contradiction\nMust contain exactly and only entailment, neutral, and contradiction"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"multi_label":{"type":"boolean","description":"Indicates if more than one true label exists."},"labels":{"type":"array","items":{"type":"string"},"description":"The labels to predict."}},"required":["classification_labels"],"description":"Zero shot classification configuration options"},"ml._types__FillMaskInferenceOptions":{"type":"object","properties":{"mask_token":{"type":"string","description":"The string/token which will be removed from incoming documents and replaced with the inference prediction(s).\nIn a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer\nhas a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests.\nHowever, if this field is present in a request, its value must match the predefined value for that model/tokenizer,\notherwise the request will fail."},"num_top_classes":{"type":"number","description":"Specifies the number of top class predictions to return. Defaults to 0."},"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__TokenizationConfigContainer","description":"The tokenization options to update when inferring"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"vocabulary":{"$ref":"./ml._types.json#/$defs/ml._types__Vocabulary"}},"description":"Fill mask inference options"},"ml._types__LearningToRankConfig":{"type":"object","properties":{"default_params":{"type":"object","additionalProperties":{}},"feature_extractors":{"type":"array","items":{"type":"object","additionalProperties":{"$ref":"./ml._types.json#/$defs/ml._types__QueryFeatureExtractor"}}},"num_top_feature_importance_values":{"type":"number"}},"required":["num_top_feature_importance_values"]},"ml._types__QueryFeatureExtractor":{"type":"object","properties":{"default_score":{"type":"number"},"feature_name":{"type":"string"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer"}},"required":["feature_name","query"]},"ml._types__NerInferenceOptions":{"type":"object","properties":{"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__TokenizationConfigContainer","description":"The tokenization options"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"classification_labels":{"type":"array","items":{"type":"string"},"description":"The token classification labels. Must be IOB formatted tags"},"vocabulary":{"$ref":"./ml._types.json#/$defs/ml._types__Vocabulary"}},"description":"Named entity recognition options"},"ml._types__PassThroughInferenceOptions":{"type":"object","properties":{"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__TokenizationConfigContainer","description":"The tokenization options"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"vocabulary":{"$ref":"./ml._types.json#/$defs/ml._types__Vocabulary"}},"description":"Pass through configuration options"},"ml._types__TextEmbeddingInferenceOptions":{"type":"object","properties":{"embedding_size":{"type":"number","description":"The number of dimensions in the embedding output"},"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__TokenizationConfigContainer","description":"The tokenization options"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"vocabulary":{"$ref":"./ml._types.json#/$defs/ml._types__Vocabulary"}},"description":"Text embedding inference options"},"ml._types__TextExpansionInferenceOptions":{"type":"object","properties":{"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__TokenizationConfigContainer","description":"The tokenization options"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"vocabulary":{"$ref":"./ml._types.json#/$defs/ml._types__Vocabulary"}},"description":"Text expansion inference options"},"ml._types__QuestionAnsweringInferenceOptions":{"type":"object","properties":{"num_top_classes":{"type":"number","description":"Specifies the number of top class predictions to return. Defaults to 0."},"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__TokenizationConfigContainer","description":"The tokenization options to update when inferring"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"max_answer_length":{"type":"number","description":"The maximum answer length to consider"}},"description":"Question answering inference options"},"ml._types__TrainedModelConfigInput":{"type":"object","properties":{"field_names":{"type":"array","items":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."},"description":"An array of input field names for the model."}},"required":["field_names"]},"ml._types__TrainedModelConfigMetadata":{"type":"object","properties":{"model_aliases":{"type":"array","items":{"type":"string"}},"feature_importance_baseline":{"type":"object","additionalProperties":{"type":"string"},"description":"An object that contains the baseline for feature importance values. For regression analysis, it is a single value. For classification analysis, there is a value for each class."},"hyperparameters":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__Hyperparameter"},"description":"List of the available hyperparameters optimized during the fine_parameter_tuning phase as well as specified by the user."},"total_feature_importance":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__TotalFeatureImportance"},"description":"An array of the total feature importance for each feature used from the training data set. This array of objects is returned if data frame analytics trained the model and the request includes total_feature_importance in the include request parameter."}}},"ml._types__Hyperparameter":{"type":"object","properties":{"absolute_importance":{"type":"number","description":"A positive number showing how much the parameter influences the variation of the loss function. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization."},"name":{"type":"string","description":"Name of the hyperparameter."},"relative_importance":{"type":"number","description":"A number between 0 and 1 showing the proportion of influence on the variation of the loss function among all tuned hyperparameters. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization."},"supplied":{"type":"boolean","description":"Indicates if the hyperparameter is specified by the user (true) or optimized (false)."},"value":{"type":"number","description":"The value of the hyperparameter, either optimized or specified by the user."}},"required":["name","supplied","value"]},"ml._types__TotalFeatureImportance":{"type":"object","properties":{"feature_name":{"type":"string","description":"The feature for which this importance was calculated."},"importance":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__TotalFeatureImportanceStatistics"},"description":"A collection of feature importance statistics related to the training data set for this particular feature."},"classes":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__TotalFeatureImportanceClass"},"description":"If the trained model is a classification model, feature importance statistics are gathered per target class value."}},"required":["feature_name","importance","classes"]},"ml._types__TotalFeatureImportanceStatistics":{"type":"object","properties":{"mean_magnitude":{"type":"number","description":"The average magnitude of this feature across all the training data. This value is the average of the absolute values of the importance for this feature."},"max":{"type":"number","description":"The maximum importance value across all the training data for this feature."},"min":{"type":"number","description":"The minimum importance value across all the training data for this feature."}},"required":["mean_magnitude","max","min"]},"ml._types__TotalFeatureImportanceClass":{"type":"object","properties":{"class_name":{"type":"string","description":"The target class value. Could be a string, boolean, or number."},"importance":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__TotalFeatureImportanceStatistics"},"description":"A collection of feature importance statistics related to the training data set for this particular feature."}},"required":["class_name","importance"]},"ml._types__ModelPackageConfig":{"type":"object","properties":{"create_time":{},"description":{"type":"string"},"inference_config":{"type":"object","additionalProperties":{}},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata"},"minimum_version":{"type":"string"},"model_repository":{"type":"string"},"model_type":{"type":"string"},"packaged_model_id":{"type":"string"},"platform_architecture":{"type":"string"},"prefix_strings":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelPrefixStrings"},"size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"sha256":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"vocabulary_file":{"type":"string"}},"required":["packaged_model_id"]},"ml._types__TrainedModelPrefixStrings":{"type":"object","properties":{"ingest":{"type":"string","description":"String prepended to input at ingest"},"search":{"type":"string","description":"String prepended to input at search"}}},"ml._types__TrainedModelLocation":{"type":"object","properties":{"index":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelLocationIndex"}},"required":["index"]},"ml._types__TrainedModelLocationIndex":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"ml._types__TrainedModelStats":{"type":"object","properties":{"deployment_stats":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelDeploymentStats","description":"A collection of deployment stats, which is present when the models are deployed."},"inference_stats":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelInferenceStats","description":"A collection of inference stats fields."},"ingest":{"type":"object","additionalProperties":{},"description":"A collection of ingest stats for the model across all nodes.\nThe values are summations of the individual node statistics.\nThe format matches the ingest section in the nodes stats API."},"model_id":{"type":"string","description":"The unique identifier of the trained model."},"model_size_stats":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelSizeStats","description":"A collection of model size stats."},"pipeline_count":{"type":"number","description":"The number of ingest pipelines that currently refer to the model."}},"required":["model_id","model_size_stats","pipeline_count"]},"ml._types__TrainedModelDeploymentStats":{"type":"object","properties":{"adaptive_allocations":{"$ref":"./ml._types.json#/$defs/ml._types__AdaptiveAllocationsSettings"},"allocation_status":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelDeploymentAllocationStatus","description":"The detailed allocation status for the deployment."},"cache_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"deployment_id":{"type":"string","description":"The unique identifier for the trained model deployment."},"error_count":{"type":"number","description":"The sum of `error_count` for all nodes in the deployment."},"inference_count":{"type":"number","description":"The sum of `inference_count` for all nodes in the deployment."},"model_id":{"type":"string","description":"The unique identifier for the trained model."},"nodes":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelDeploymentNodesStats"},"description":"The deployment stats for each node that currently has the model allocated.\nIn serverless, stats are reported for a single unnamed virtual node."},"number_of_allocations":{"type":"number","description":"The number of allocations requested."},"peak_throughput_per_minute":{"type":"number"},"priority":{"$ref":"./ml._types.json#/$defs/ml._types__TrainingPriority"},"queue_capacity":{"type":"number","description":"The number of inference requests that can be queued before new requests are rejected."},"rejected_execution_count":{"type":"number","description":"The sum of `rejected_execution_count` for all nodes in the deployment.\nIndividual nodes reject an inference request if the inference queue is full.\nThe queue size is controlled by the `queue_capacity` setting in the start\ntrained model deployment API."},"reason":{"type":"string","description":"The reason for the current deployment state. Usually only populated when\nthe model is not deployed to a node."},"start_time":{"description":"The epoch timestamp when the deployment started."},"state":{"$ref":"./ml._types.json#/$defs/ml._types__DeploymentAssignmentState","description":"The overall state of the deployment."},"threads_per_allocation":{"type":"number","description":"The number of threads used be each allocation during inference."},"timeout_count":{"type":"number","description":"The sum of `timeout_count` for all nodes in the deployment."}},"required":["deployment_id","model_id","nodes","peak_throughput_per_minute","priority","start_time"]},"ml._types__AdaptiveAllocationsSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If true, adaptive_allocations is enabled"},"min_number_of_allocations":{"type":"number","description":"Specifies the minimum number of allocations to scale to.\nIf set, it must be greater than or equal to 0.\nIf not defined, the deployment scales to 0."},"max_number_of_allocations":{"type":"number","description":"Specifies the maximum number of allocations to scale to.\nIf set, it must be greater than or equal to min_number_of_allocations."}},"required":["enabled"]},"ml._types__TrainedModelDeploymentAllocationStatus":{"type":"object","properties":{"allocation_count":{"type":"number","description":"The current number of nodes where the model is allocated."},"state":{"$ref":"./ml._types.json#/$defs/ml._types__DeploymentAllocationState","description":"The detailed allocation state related to the nodes."},"target_allocation_count":{"type":"number","description":"The desired number of nodes for model allocation."}},"required":["allocation_count","state","target_allocation_count"]},"ml._types__DeploymentAllocationState":{"enum":["started","starting","fully_allocated"]},"ml._types__TrainedModelDeploymentNodesStats":{"type":"object","properties":{"average_inference_time_ms":{"description":"The average time for each inference call to complete on this node."},"average_inference_time_ms_last_minute":{},"average_inference_time_ms_excluding_cache_hits":{"description":"The average time for each inference call to complete on this node, excluding cache"},"average_inference_process_memory_rss_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"error_count":{"type":"number","description":"The number of errors when evaluating the trained model."},"inference_count":{"type":"number","description":"The total number of inference calls made against this node for this model."},"inference_cache_hit_count":{"type":"number"},"inference_cache_hit_count_last_minute":{"type":"number"},"last_access":{"description":"The epoch time stamp of the last inference call for the model on this node."},"node":{"$ref":"./ml._types.json#/$defs/ml._types__DiscoveryNode","description":"Information pertaining to the node.","x-availability":{"stack":{}}},"number_of_allocations":{"type":"number","description":"The number of allocations assigned to this node."},"number_of_pending_requests":{"type":"number","description":"The number of inference requests queued to be processed."},"peak_throughput_per_minute":{"type":"number"},"rejected_execution_count":{"type":"number","description":"The number of inference requests that were not processed because the queue was full."},"routing_state":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelAssignmentRoutingStateAndReason","description":"The current routing state and reason for the current routing state for this allocation."},"start_time":{"description":"The epoch timestamp when the allocation started."},"threads_per_allocation":{"type":"number","description":"The number of threads used by each allocation during inference."},"throughput_last_minute":{"type":"number"},"timeout_count":{"type":"number","description":"The number of inference requests that timed out before being processed."}},"required":["peak_throughput_per_minute","routing_state","throughput_last_minute"]},"ml._types__TrainedModelAssignmentRoutingStateAndReason":{"type":"object","properties":{"reason":{"type":"string","description":"The reason for the current state. It is usually populated only when the\n`routing_state` is `failed`."},"routing_state":{"$ref":"./ml._types.json#/$defs/ml._types__RoutingState","description":"The current routing state."}},"required":["routing_state"]},"ml._types__RoutingState":{"enum":["failed","started","starting","stopped","stopping"]},"ml._types__TrainingPriority":{"enum":["normal","low"]},"ml._types__DeploymentAssignmentState":{"enum":["started","starting","stopping","failed"]},"ml._types__TrainedModelInferenceStats":{"type":"object","properties":{"cache_miss_count":{"type":"number","description":"The number of times the model was loaded for inference and was not retrieved from the cache.\nIf this number is close to the `inference_count`, the cache is not being appropriately used.\nThis can be solved by increasing the cache size or its time-to-live (TTL).\nRefer to general machine learning settings for the appropriate settings."},"failure_count":{"type":"number","description":"The number of failures when using the model for inference."},"inference_count":{"type":"number","description":"The total number of times the model has been called for inference.\nThis is across all inference contexts, including all pipelines."},"missing_all_fields_count":{"type":"number","description":"The number of inference calls where all the training features for the model were missing."},"timestamp":{"description":"The time when the statistics were last updated."}},"required":["cache_miss_count","failure_count","inference_count","missing_all_fields_count","timestamp"]},"ml._types__TrainedModelSizeStats":{"type":"object","properties":{"model_size_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The size of the model in bytes."},"required_native_memory_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The amount of memory required to load the model in bytes."}},"required":["model_size_bytes","required_native_memory_bytes"]},"ml._types__InferenceConfigUpdateContainer":{"type":"object","properties":{"regression":{"$ref":"./ml._types.json#/$defs/ml._types__RegressionInferenceOptions","description":"Regression configuration for inference."},"classification":{"$ref":"./ml._types.json#/$defs/ml._types__ClassificationInferenceOptions","description":"Classification configuration for inference."},"text_classification":{"$ref":"./ml._types.json#/$defs/ml._types__TextClassificationInferenceUpdateOptions","description":"Text classification configuration for inference."},"zero_shot_classification":{"$ref":"./ml._types.json#/$defs/ml._types__ZeroShotClassificationInferenceUpdateOptions","description":"Zeroshot classification configuration for inference."},"fill_mask":{"$ref":"./ml._types.json#/$defs/ml._types__FillMaskInferenceUpdateOptions","description":"Fill mask configuration for inference."},"ner":{"$ref":"./ml._types.json#/$defs/ml._types__NerInferenceUpdateOptions","description":"Named entity recognition configuration for inference."},"pass_through":{"$ref":"./ml._types.json#/$defs/ml._types__PassThroughInferenceUpdateOptions","description":"Pass through configuration for inference."},"text_embedding":{"$ref":"./ml._types.json#/$defs/ml._types__TextEmbeddingInferenceUpdateOptions","description":"Text embedding configuration for inference."},"text_expansion":{"$ref":"./ml._types.json#/$defs/ml._types__TextExpansionInferenceUpdateOptions","description":"Text expansion configuration for inference."},"question_answering":{"$ref":"./ml._types.json#/$defs/ml._types__QuestionAnsweringInferenceUpdateOptions","description":"Question answering configuration for inference"}}},"ml._types__TextClassificationInferenceUpdateOptions":{"type":"object","properties":{"num_top_classes":{"type":"number","description":"Specifies the number of top class predictions to return. Defaults to 0."},"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__NlpTokenizationUpdateOptions","description":"The tokenization options to update when inferring"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"classification_labels":{"type":"array","items":{"type":"string"},"description":"Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels"}}},"ml._types__NlpTokenizationUpdateOptions":{"type":"object","properties":{"truncate":{"$ref":"./ml._types.json#/$defs/ml._types__TokenizationTruncate","description":"Truncate options to apply"},"span":{"type":"number","description":"Span options to apply"}}},"ml._types__ZeroShotClassificationInferenceUpdateOptions":{"type":"object","properties":{"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__NlpTokenizationUpdateOptions","description":"The tokenization options to update when inferring"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"multi_label":{"type":"boolean","description":"Update the configured multi label option. Indicates if more than one true label exists. Defaults to the configured value."},"labels":{"type":"array","items":{"type":"string"},"description":"The labels to predict."}},"required":["labels"]},"ml._types__FillMaskInferenceUpdateOptions":{"type":"object","properties":{"num_top_classes":{"type":"number","description":"Specifies the number of top class predictions to return. Defaults to 0."},"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__NlpTokenizationUpdateOptions","description":"The tokenization options to update when inferring"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."}}},"ml._types__NerInferenceUpdateOptions":{"type":"object","properties":{"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__NlpTokenizationUpdateOptions","description":"The tokenization options to update when inferring"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."}}},"ml._types__PassThroughInferenceUpdateOptions":{"type":"object","properties":{"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__NlpTokenizationUpdateOptions","description":"The tokenization options to update when inferring"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."}}},"ml._types__TextEmbeddingInferenceUpdateOptions":{"type":"object","properties":{"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__NlpTokenizationUpdateOptions"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."}}},"ml._types__TextExpansionInferenceUpdateOptions":{"type":"object","properties":{"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__NlpTokenizationUpdateOptions"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."}}},"ml._types__QuestionAnsweringInferenceUpdateOptions":{"type":"object","properties":{"question":{"type":"string","description":"The question to answer given the inference context"},"num_top_classes":{"type":"number","description":"Specifies the number of top class predictions to return. Defaults to 0."},"tokenization":{"$ref":"./ml._types.json#/$defs/ml._types__NlpTokenizationUpdateOptions","description":"The tokenization options to update when inferring"},"results_field":{"type":"string","description":"The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value."},"max_answer_length":{"type":"number","description":"The maximum answer length to consider for extraction"}},"required":["question"]},"ml._types__InferenceResponseResult":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelEntities"},"description":"If the model is trained for named entity recognition (NER) tasks, the response contains the recognized entities."},"is_truncated":{"type":"boolean","description":"Indicates whether the input text was truncated to meet the model's maximum sequence length limit. This property\nis present only when it is true."},"predicted_value":{"anyOf":[{"$ref":"./ml._types.json#/$defs/ml._types__PredictedValue"},{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__PredictedValue"}}],"description":"If the model is trained for a text classification or zero shot classification task, the response is the\npredicted class.\nFor named entity recognition (NER) tasks, it contains the annotated text output.\nFor fill mask tasks, it contains the top prediction for replacing the mask token.\nFor text embedding tasks, it contains the raw numerical text embedding values.\nFor regression models, its a numerical value\nFor classification models, it may be an integer, double, boolean or string depending on prediction type"},"predicted_value_sequence":{"type":"string","description":"For fill mask tasks, the response contains the input text sequence with the mask token replaced by the predicted\nvalue.\nAdditionally"},"prediction_probability":{"type":"number","description":"Specifies a probability for the predicted value."},"prediction_score":{"type":"number","description":"Specifies a confidence score for the predicted value."},"top_classes":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__TopClassEntry"},"description":"For fill mask, text classification, and zero shot classification tasks, the response contains a list of top\nclass entries."},"warning":{"type":"string","description":"If the request failed, the response contains the reason for the failure."},"feature_importance":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelInferenceFeatureImportance"},"description":"The feature importance for the inference results. Relevant only for classification or regression models"}}},"ml._types__TrainedModelEntities":{"type":"object","properties":{"class_name":{"type":"string"},"class_probability":{"type":"number"},"entity":{"type":"string"},"start_pos":{"type":"number"},"end_pos":{"type":"number"}},"required":["class_name","class_probability","entity","start_pos","end_pos"]},"ml._types__PredictedValue":{"anyOf":[{"$ref":"./_types.json#/$defs/_types__ScalarValue"},{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__ScalarValue"}}]},"ml._types__TopClassEntry":{"type":"object","properties":{"class_name":{"type":"string"},"class_probability":{"type":"number"},"class_score":{"type":"number"}},"required":["class_name","class_probability","class_score"]},"ml._types__TrainedModelInferenceFeatureImportance":{"type":"object","properties":{"feature_name":{"type":"string"},"importance":{"type":"number"},"classes":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelInferenceClassImportance"}}},"required":["feature_name"]},"ml._types__TrainedModelInferenceClassImportance":{"type":"object","properties":{"class_name":{"type":"string"},"importance":{"type":"number"}},"required":["class_name","importance"]},"ml._types__DatafeedConfig":{"type":"object","properties":{"aggregations":{"type":"object","additionalProperties":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer"},"description":"If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data."},"chunking_config":{"$ref":"./ml._types.json#/$defs/ml._types__ChunkingConfig","description":"Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated and is an advanced configuration option."},"datafeed_id":{"type":"string","description":"A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. The default value is the job identifier."},"delayed_data_check_config":{"$ref":"./ml._types.json#/$defs/ml._types__DelayedDataCheckConfig","description":"Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the `query_delay` option is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds."},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: `150s`. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation."},"indices":{"$ref":"./_types.json#/$defs/_types__Indices","description":"An array of index names. Wildcards are supported. If any indices are in remote clusters, the machine learning nodes must have the `remote_cluster_client` role."},"indices_options":{"$ref":"./_types.json#/$defs/_types__IndicesOptions","description":"Specifies index expansion options that are used during search."},"job_id":{"type":"string"},"max_empty_searches":{"type":"number","description":"If a real-time datafeed has never seen any data (including during any initial training period) then it will automatically stop itself and close its associated job after this many real-time searches that return no documents. In other words, it will stop after `frequency` times `max_empty_searches` of real-time operation. If not set then a datafeed with no end time that sees no data will remain started until it is explicitly stopped."},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch."},"query_delay":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between `60s` and `120s`. This randomness improves the query performance when there are multiple jobs running on the same node."},"runtime_mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RuntimeFields","description":"Specifies runtime fields for the datafeed search."},"script_fields":{"type":"object","additionalProperties":{"$ref":"./_types.json#/$defs/_types__ScriptField"},"description":"Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields."},"scroll_size":{"type":"number","description":"The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of `index.max_result_window`, which is 10,000 by default."}}},"ml._types__JobConfig":{"type":"object","properties":{"allow_lazy_open":{"type":"boolean","description":"Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node."},"analysis_config":{"$ref":"./ml._types.json#/$defs/ml._types__AnalysisConfig","description":"The analysis configuration, which specifies how to analyze the data.\nAfter you create a job, you cannot change the analysis configuration; all the properties are informational."},"analysis_limits":{"$ref":"./ml._types.json#/$defs/ml._types__AnalysisLimits","description":"Limits can be applied for the resources required to hold the mathematical models in memory.\nThese limits are approximate and can be set per job.\nThey do not control the memory used by other processes, for example the Elasticsearch Java processes."},"background_persist_interval":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Advanced configuration option.\nThe time between each periodic persistence of the model.\nThe default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time.\nThe smallest allowed value is 1 hour."},"custom_settings":{"$ref":"./ml._types.json#/$defs/ml._types__CustomSettings","description":"Advanced configuration option.\nContains custom metadata about the job."},"daily_model_snapshot_retention_after_days":{"type":"number","description":"Advanced configuration option, which affects the automatic removal of old model snapshots for this job.\nIt specifies a period of time (in days) after which only the first snapshot per day is retained.\nThis period is relative to the timestamp of the most recent snapshot for this job."},"data_description":{"$ref":"./ml._types.json#/$defs/ml._types__DataDescription","description":"The data description defines the format of the input data when you send data to the job by using the post data API.\nNote that when configure a datafeed, these properties are automatically set."},"datafeed_config":{"$ref":"./ml._types.json#/$defs/ml._types__DatafeedConfig","description":"The datafeed, which retrieves data from Elasticsearch for analysis by the job.\nYou can associate only one datafeed with each anomaly detection job."},"description":{"type":"string","description":"A description of the job."},"groups":{"type":"array","items":{"type":"string"},"description":"A list of job groups. A job can belong to no groups or many."},"job_id":{"type":"string","description":"Identifier for the anomaly detection job.\nThis identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.\nIt must start and end with alphanumeric characters."},"model_plot_config":{"$ref":"./ml._types.json#/$defs/ml._types__ModelPlotConfig","description":"This advanced configuration option stores model information along with the results.\nIt provides a more detailed view into anomaly detection.\nModel plot provides a simplified and indicative view of the model and its bounds."},"model_snapshot_retention_days":{"type":"number","description":"Advanced configuration option, which affects the automatic removal of old model snapshots for this job.\nIt specifies the maximum period of time (in days) that snapshots are retained.\nThis period is relative to the timestamp of the most recent snapshot for this job.\nThe default value is `10`, which means snapshots ten days older than the newest snapshot are deleted."},"renormalization_window_days":{"type":"number","description":"Advanced configuration option.\nThe period over which adjustments to the score are applied, as new data is seen.\nThe default value is the longer of 30 days or 100 `bucket_spans`."},"results_index_name":{"type":"string","description":"A text string that affects the name of the machine learning results index.\nThe default value is `shared`, which generates an index named `.ml-anomalies-shared`."},"results_retention_days":{"type":"number","description":"Advanced configuration option.\nThe period of time (in days) that results are retained.\nAge is calculated relative to the timestamp of the latest bucket result.\nIf this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch.\nThe default value is null, which means all results are retained.\nAnnotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results.\nAnnotations added by users are retained forever."}},"required":["analysis_config","data_description"]},"ml._types__AnalysisConfigRead":{"type":"object","properties":{"bucket_span":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The size of the interval that the analysis is aggregated into, typically between `5m` and `1h`. This value should be either a whole number of days or equate to a\nwhole number of buckets in one day. If the anomaly detection job uses a datafeed with aggregations, this value must also be divisible by the interval of the date histogram aggregation."},"detectors":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__DetectorRead"},"description":"Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned."},"influencers":{"type":"array","items":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."},"description":"A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity."},"categorization_analyzer":{"$ref":"./ml._types.json#/$defs/ml._types__CategorizationAnalyzer","description":"If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as `categorization_filters`. The categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process. The `categorization_analyzer` field can be specified either as a string or as an object. If it is a string, it must refer to a built-in analyzer or one added by another plugin."},"categorization_field_name":{"type":"string","description":"If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`."},"categorization_filters":{"type":"array","items":{"type":"string"},"description":"If `categorization_field_name` is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as `categorization_analyzer`. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the `categorization_analyzer` property instead and include the filters as pattern_replace character filters. The effect is exactly the same."},"latency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is applicable only when you send data by using the post data API."},"model_prune_window":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the `bucket_span`. If set too low, important information may be removed from the model. For jobs created in 8.1 and later, the default value is the greater of `30d` or 20 times `bucket_span`."},"multivariate_by_fields":{"type":"boolean","description":"This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to `true`, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the `multivariate_by_fields` property, you must also specify `by_field_name` in your detector."},"per_partition_categorization":{"$ref":"./ml._types.json#/$defs/ml._types__PerPartitionCategorization","description":"Settings related to how categorization interacts with partition fields."},"summary_count_field_name":{"type":"string","description":"If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function."}},"required":["bucket_span","detectors","influencers"]},"ml._types__DetectorRead":{"type":"object","properties":{"function":{"type":"string","description":"The analysis function that is used. For example, `count`, `rare`, `mean`, `min`, `max`, or `sum`."},"by_field_name":{"type":"string","description":"The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split."},"custom_rules":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__DetectionRule"},"description":"Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules."},"detector_description":{"type":"string","description":"A description of the detector."},"detector_index":{"type":"number","description":"A unique identifier for the detector. This identifier is based on the order of the detectors in the `analysis_config`, starting at zero. If you specify a value for this property, it is ignored."},"exclude_frequent":{"$ref":"./ml._types.json#/$defs/ml._types__ExcludeFrequent","description":"If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set `exclude_frequent` to `all` for both fields, or to `by` or `over` for those specific fields."},"field_name":{"type":"string","description":"The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes."},"over_field_name":{"type":"string","description":"The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits."},"partition_field_name":{"type":"string","description":"The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field."},"use_null":{"type":"boolean","description":"Defines whether a new series is used as the null series when there is no value for the by or partition fields."}},"required":["function"]},"ml._types__TrainedModelAssignment":{"type":"object","properties":{"adaptive_allocations":{"anyOf":[{"$ref":"./ml._types.json#/$defs/ml._types__AdaptiveAllocationsSettings"},{"type":"null"}]},"assignment_state":{"$ref":"./ml._types.json#/$defs/ml._types__DeploymentAssignmentState","description":"The overall assignment state."},"max_assigned_allocations":{"type":"number"},"reason":{"type":"string"},"routing_table":{"type":"object","additionalProperties":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelAssignmentRoutingTable"},"description":"The allocation state for each node."},"start_time":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The timestamp when the deployment started."},"task_parameters":{"$ref":"./ml._types.json#/$defs/ml._types__TrainedModelAssignmentTaskParameters"}},"required":["assignment_state","routing_table","start_time","task_parameters"]},"ml._types__TrainedModelAssignmentRoutingTable":{"type":"object","properties":{"reason":{"type":"string","description":"The reason for the current state. It is usually populated only when the\n`routing_state` is `failed`."},"routing_state":{"$ref":"./ml._types.json#/$defs/ml._types__RoutingState","description":"The current routing state."},"current_allocations":{"type":"number","description":"Current number of allocations."},"target_allocations":{"type":"number","description":"Target number of allocations."}},"required":["routing_state","current_allocations","target_allocations"]},"ml._types__TrainedModelAssignmentTaskParameters":{"type":"object","properties":{"model_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The size of the trained model in bytes."},"model_id":{"type":"string","description":"The unique identifier for the trained model."},"deployment_id":{"type":"string","description":"The unique identifier for the trained model deployment."},"cache_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The size of the trained model cache.","x-availability":{"stack":{"since":"8.4.0"},"serverless":{}}},"number_of_allocations":{"type":"number","description":"The total number of allocations this model is assigned across ML nodes."},"priority":{"$ref":"./ml._types.json#/$defs/ml._types__TrainingPriority"},"per_deployment_memory_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"per_allocation_memory_bytes":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"queue_capacity":{"type":"number","description":"Number of inference requests are allowed in the queue at a time."},"threads_per_allocation":{"type":"number","description":"Number of threads per allocation."}},"required":["model_bytes","model_id","deployment_id","number_of_allocations","priority","per_deployment_memory_bytes","per_allocation_memory_bytes","queue_capacity","threads_per_allocation"]},"ml._types__AnalysisMemoryLimit":{"type":"object","properties":{"model_memory_limit":{"type":"string","description":"Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes."}},"required":["model_memory_limit"]},"ml._types__DetectorUpdate":{"type":"object","properties":{"detector_index":{"type":"number","description":"A unique identifier for the detector.\nThis identifier is based on the order of the detectors in the `analysis_config`, starting at zero."},"description":{"type":"string","description":"A description of the detector."},"custom_rules":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__DetectionRule"},"description":"An array of custom rule objects, which enable you to customize the way detectors operate.\nFor example, a rule may dictate to the detector conditions under which results should be skipped.\nKibana refers to custom rules as job rules."}},"required":["detector_index"]},"ml._types__TransformAuthorization":{"type":"object","properties":{"api_key":{"$ref":"./ml._types.json#/$defs/ml._types__ApiKeyAuthorization","description":"If an API key was used for the most recent update to the transform, its name and identifier are listed in the response."},"roles":{"type":"array","items":{"type":"string"},"description":"If a user ID was used for the most recent update to the transform, its roles at the time of the update are listed in the response."},"service_account":{"type":"string","description":"If a service account was used for the most recent update to the transform, the account name is listed in the response."}}}}}