@elastic/schemas 0.5.1 → 0.6.0

package/lib/cjs/es/json/ml.evaluate_data_frame.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.evaluate_data_frame", "description": "Evaluate data frame analytics.\n\nThe API packages together commonly used evaluation metrics for various types\nof machine learning features. This has been designed for use on indexes\ncreated by data frame analytics. Evaluation requires both a ground truth\nfield and an analytics result field to be present.", "x-api": { "id": "ml.evaluate_data_frame", "name": "evaluate-data-frame", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/data_frame/_evaluate", "x-urls": [{ "path": "/_ml/data_frame/_evaluate", "methods": ["POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.3.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "evaluation": { "$ref": "./ml._types.json#/$defs/ml._types__DataframeEvaluationContainer", "description": "Defines the type of evaluation you want to perform.", "x-found-in": "body" }, "index": { "type": "string", "description": "Defines the `index` in which the evaluation will be performed.", "x-found-in": "body" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "A query clause that retrieves a subset of data from the source index.", "x-found-in": "body" } }, "required": ["evaluation", "index"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.evaluate_data_frame", "description": "Evaluate data frame analytics.\n\nThe API packages together commonly used evaluation metrics for various types\nof machine learning features. This has been designed for use on indexes\ncreated by data frame analytics. Evaluation requires both a ground truth\nfield and an analytics result field to be present.", "x-api": { "id": "ml.evaluate_data_frame", "name": "evaluate-data-frame", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/data_frame/_evaluate", "x-urls": [{ "path": "/_ml/data_frame/_evaluate", "methods": ["POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.3.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "evaluation": { "$ref": "./ml._types.json#/$defs/ml._types__DataframeEvaluationContainer", "description": "Defines the type of evaluation you want to perform.", "x-found-in": "body" }, "index": { "type": "string", "description": "Defines the `index` in which the evaluation will be performed.", "x-found-in": "body" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "A query clause that retrieves a subset of data from the source index.", "x-found-in": "body" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["evaluation", "index"] }

package/lib/cjs/es/json/ml.explain_data_frame_analytics.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.explain_data_frame_analytics", "description": "Explain data frame analytics config.\n\nThis API provides explanations for a data frame analytics config that either\nexists already or one that has not been created yet. The following\nexplanations are provided:\n* which fields are included or not in the analysis and why,\n* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.\nIf you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", "x-api": { "id": "ml.explain_data_frame_analytics", "name": "explain-data-frame-analytics", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/data_frame/analytics/{id}/_explain", "x-urls": [{ "path": "/_ml/data_frame/analytics/_explain", "methods": ["GET", "POST"] }, { "path": "/_ml/data_frame/analytics/{id}/_explain", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.3.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "source": { "$ref": "./ml._types.json#/$defs/ml._types__DataframeAnalyticsSource", "description": "The configuration of how to source the analysis data. It requires an\nindex. Optionally, query and _source may be specified.", "x-found-in": "body" }, "dest": { "$ref": "./ml._types.json#/$defs/ml._types__DataframeAnalyticsDestination", "description": "The destination configuration, consisting of index and optionally\nresults_field (ml by default).", "x-found-in": "body" }, "analysis": { "$ref": "./ml._types.json#/$defs/ml._types__DataframeAnalysisContainer", "description": "The analysis configuration, which contains the information necessary to\nperform one of the following types of analysis: classification, outlier\ndetection, or regression.", "x-found-in": "body" }, "description": { "type": "string", "description": "A description of the job.", "x-found-in": "body" }, "model_memory_limit": { "type": "string", "description": "The approximate maximum amount of memory resources that are permitted for\nanalytical processing. If your `elasticsearch.yml` file contains an\n`xpack.ml.max_model_memory_limit` setting, an error occurs when you try to\ncreate data frame analytics jobs that have `model_memory_limit` values\ngreater than that setting.", "x-found-in": "body" }, "max_num_threads": { "type": "number", "description": "The maximum number of threads to be used by the analysis. Using more\nthreads may decrease the time necessary to complete the analysis at the\ncost of using more CPU. Note that the process may use additional threads\nfor operational functionality other than the analysis itself.", "x-found-in": "body" }, "analyzed_fields": { "$ref": "./ml._types.json#/$defs/ml._types__DataframeAnalysisAnalyzedFields", "description": "Specify includes and/or excludes patterns to select which fields will be\nincluded in the analysis. The patterns specified in excludes are applied\nlast, therefore excludes takes precedence. In other words, if the same\nfield is specified in both includes and excludes, then the field will not\nbe included in the analysis.", "x-found-in": "body" }, "allow_lazy_start": { "type": "boolean", "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node.", "x-found-in": "body" }, "id": { "type": "string", "description": "Identifier for the data frame analytics job. This identifier can contain\nlowercase alphanumeric characters (a-z and 0-9), hyphens, and\nunderscores. It must start and end with alphanumeric characters.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.explain_data_frame_analytics", "description": "Explain data frame analytics config.\n\nThis API provides explanations for a data frame analytics config that either\nexists already or one that has not been created yet. The following\nexplanations are provided:\n* which fields are included or not in the analysis and why,\n* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.\nIf you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", "x-api": { "id": "ml.explain_data_frame_analytics", "name": "explain-data-frame-analytics", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/data_frame/analytics/{id}/_explain", "x-urls": [{ "path": "/_ml/data_frame/analytics/_explain", "methods": ["GET", "POST"] }, { "path": "/_ml/data_frame/analytics/{id}/_explain", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.3.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "source": { "$ref": "./ml._types.json#/$defs/ml._types__DataframeAnalyticsSource", "description": "The configuration of how to source the analysis data. It requires an\nindex. Optionally, query and _source may be specified.", "x-found-in": "body" }, "dest": { "$ref": "./ml._types.json#/$defs/ml._types__DataframeAnalyticsDestination", "description": "The destination configuration, consisting of index and optionally\nresults_field (ml by default).", "x-found-in": "body" }, "analysis": { "$ref": "./ml._types.json#/$defs/ml._types__DataframeAnalysisContainer", "description": "The analysis configuration, which contains the information necessary to\nperform one of the following types of analysis: classification, outlier\ndetection, or regression.", "x-found-in": "body" }, "description": { "type": "string", "description": "A description of the job.", "x-found-in": "body" }, "model_memory_limit": { "type": "string", "description": "The approximate maximum amount of memory resources that are permitted for\nanalytical processing. If your `elasticsearch.yml` file contains an\n`xpack.ml.max_model_memory_limit` setting, an error occurs when you try to\ncreate data frame analytics jobs that have `model_memory_limit` values\ngreater than that setting.", "x-found-in": "body" }, "max_num_threads": { "type": "number", "description": "The maximum number of threads to be used by the analysis. Using more\nthreads may decrease the time necessary to complete the analysis at the\ncost of using more CPU. Note that the process may use additional threads\nfor operational functionality other than the analysis itself.", "x-found-in": "body" }, "analyzed_fields": { "$ref": "./ml._types.json#/$defs/ml._types__DataframeAnalysisAnalyzedFields", "description": "Specify includes and/or excludes patterns to select which fields will be\nincluded in the analysis. The patterns specified in excludes are applied\nlast, therefore excludes takes precedence. In other words, if the same\nfield is specified in both includes and excludes, then the field will not\nbe included in the analysis.", "x-found-in": "body" }, "allow_lazy_start": { "type": "boolean", "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node.", "x-found-in": "body" }, "id": { "type": "string", "description": "Identifier for the data frame analytics job. This identifier can contain\nlowercase alphanumeric characters (a-z and 0-9), hyphens, and\nunderscores. It must start and end with alphanumeric characters.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/cjs/es/json/ml.flush_job.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.flush_job", "description": "Force buffered data to be processed.\n\nThe flush jobs API is only applicable when sending data for analysis using\nthe post data API. Depending on the content of the buffer, then it might\nadditionally calculate new results. Both flush and close operations are\nsimilar, however the flush is more efficient if you are expecting to send\nmore data for analysis. When flushing, the job remains open and is available\nto continue analyzing data. A close operation additionally prunes and\npersists the model state to disk and the job must be opened again before\nanalyzing further data.", "x-api": { "id": "ml.flush_job", "name": "flush-job", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/anomaly_detectors/{job_id}/_flush", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/_flush", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "x-deprecated": { "since": "9.1.0", "description": "Forcing any buffered data to be processed is deprecated, in a future major version a datafeed will be required." }, "type": "object", "properties": { "advance_time": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `advance_time` query parameter.", "x-found-in": "body" }, "calc_interim": { "type": "boolean", "description": "Refer to the description for the `calc_interim` query parameter.", "x-found-in": "body" }, "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `end` query parameter.", "x-found-in": "body" }, "skip_time": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `skip_time` query parameter.", "x-found-in": "body" }, "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `start` query parameter.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" } }, "required": ["job_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.flush_job", "description": "Force buffered data to be processed.\n\nThe flush jobs API is only applicable when sending data for analysis using\nthe post data API. Depending on the content of the buffer, then it might\nadditionally calculate new results. Both flush and close operations are\nsimilar, however the flush is more efficient if you are expecting to send\nmore data for analysis. When flushing, the job remains open and is available\nto continue analyzing data. A close operation additionally prunes and\npersists the model state to disk and the job must be opened again before\nanalyzing further data.", "x-api": { "id": "ml.flush_job", "name": "flush-job", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/anomaly_detectors/{job_id}/_flush", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/_flush", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "x-deprecated": { "since": "9.1.0", "description": "Forcing any buffered data to be processed is deprecated, in a future major version a datafeed will be required." }, "type": "object", "properties": { "advance_time": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `advance_time` query parameter.", "x-found-in": "body" }, "calc_interim": { "type": "boolean", "description": "Refer to the description for the `calc_interim` query parameter.", "x-found-in": "body" }, "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `end` query parameter.", "x-found-in": "body" }, "skip_time": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `skip_time` query parameter.", "x-found-in": "body" }, "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `start` query parameter.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["job_id"] }

package/lib/cjs/es/json/ml.forecast.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.forecast", "description": "Predict future behavior of a time series.\n\nForecasts are not supported for jobs that perform population analysis; an\nerror occurs if you try to create a forecast for a job that has an\n`over_field_name` in its configuration. Forcasts predict future behavior\nbased on historical data.", "x-api": { "id": "ml.forecast", "name": "forecast", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/anomaly_detectors/{job_id}/_forecast", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/_forecast", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.1.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "duration": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Refer to the description for the `duration` query parameter.", "x-found-in": "body" }, "expires_in": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Refer to the description for the `expires_in` query parameter.", "x-found-in": "body" }, "max_model_memory": { "type": "string", "description": "Refer to the description for the `max_model_memory` query parameter.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job. The job must be open when you\ncreate a forecast; otherwise, an error occurs.", "x-found-in": "path" } }, "required": ["job_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.forecast", "description": "Predict future behavior of a time series.\n\nForecasts are not supported for jobs that perform population analysis; an\nerror occurs if you try to create a forecast for a job that has an\n`over_field_name` in its configuration. Forcasts predict future behavior\nbased on historical data.", "x-api": { "id": "ml.forecast", "name": "forecast", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/anomaly_detectors/{job_id}/_forecast", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/_forecast", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.1.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "duration": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Refer to the description for the `duration` query parameter.", "x-found-in": "body" }, "expires_in": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Refer to the description for the `expires_in` query parameter.", "x-found-in": "body" }, "max_model_memory": { "type": "string", "description": "Refer to the description for the `max_model_memory` query parameter.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job. The job must be open when you\ncreate a forecast; otherwise, an error occurs.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["job_id"] }

package/lib/cjs/es/json/ml.get_buckets.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_buckets", "description": "Get anomaly detection job results for buckets.\n\nThe API presents a chronological view of the records, grouped by bucket.", "x-api": { "id": "ml.get_buckets", "name": "get-buckets", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/anomaly_detectors/{job_id}/results/buckets/{timestamp}", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/results/buckets/{timestamp}", "methods": ["GET", "POST"] }, { "path": "/_ml/anomaly_detectors/{job_id}/results/buckets", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "anomaly_score": { "type": "number", "description": "Refer to the description for the `anomaly_score` query parameter.", "x-found-in": "body" }, "desc": { "type": "boolean", "description": "Refer to the description for the `desc` query parameter.", "x-found-in": "body" }, "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `end` query parameter.", "x-found-in": "body" }, "exclude_interim": { "type": "boolean", "description": "Refer to the description for the `exclude_interim` query parameter.", "x-found-in": "body" }, "expand": { "type": "boolean", "description": "Refer to the description for the `expand` query parameter.", "x-found-in": "body" }, "from": { "type": "number", "description": "Skips the specified number of buckets.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of buckets to obtain.", "x-found-in": "query" }, "sort": { "type": "string", "description": "Refer to the desription for the `sort` query parameter.", "x-found-in": "body" }, "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `start` query parameter.", "x-found-in": "body" }, "page": { "$ref": "./ml._types.json#/$defs/ml._types__Page", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "timestamp": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "The timestamp of a single bucket result. If you do not specify this\nparameter, the API returns information about all buckets.", "x-found-in": "path" } }, "required": ["job_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_buckets", "description": "Get anomaly detection job results for buckets.\n\nThe API presents a chronological view of the records, grouped by bucket.", "x-api": { "id": "ml.get_buckets", "name": "get-buckets", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/anomaly_detectors/{job_id}/results/buckets/{timestamp}", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/results/buckets/{timestamp}", "methods": ["GET", "POST"] }, { "path": "/_ml/anomaly_detectors/{job_id}/results/buckets", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "anomaly_score": { "type": "number", "description": "Refer to the description for the `anomaly_score` query parameter.", "x-found-in": "body" }, "desc": { "type": "boolean", "description": "Refer to the description for the `desc` query parameter.", "x-found-in": "body" }, "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `end` query parameter.", "x-found-in": "body" }, "exclude_interim": { "type": "boolean", "description": "Refer to the description for the `exclude_interim` query parameter.", "x-found-in": "body" }, "expand": { "type": "boolean", "description": "Refer to the description for the `expand` query parameter.", "x-found-in": "body" }, "from": { "type": "number", "description": "Skips the specified number of buckets.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of buckets to obtain.", "x-found-in": "query" }, "sort": { "type": "string", "description": "Refer to the desription for the `sort` query parameter.", "x-found-in": "body" }, "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `start` query parameter.", "x-found-in": "body" }, "page": { "$ref": "./ml._types.json#/$defs/ml._types__Page", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "timestamp": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "The timestamp of a single bucket result. If you do not specify this\nparameter, the API returns information about all buckets.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["job_id"] }

package/lib/cjs/es/json/ml.get_calendar_events.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_calendar_events", "description": "Get info about events in calendars.", "x-api": { "id": "ml.get_calendar_events", "name": "get-calendar-events", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/calendars/{calendar_id}/events", "x-urls": [{ "path": "/_ml/calendars/{calendar_id}/events", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Specifies to get events with timestamps earlier than this time.", "x-found-in": "query" }, "from": { "type": "number", "description": "Skips the specified number of events.", "x-found-in": "query" }, "job_id": { "type": "string", "description": "Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of `_all` or `*`.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of events to obtain.", "x-found-in": "query" }, "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Specifies to get events with timestamps after this time.", "x-found-in": "query" }, "calendar_id": { "type": "string", "description": "A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using `_all` or `*` or by omitting the calendar identifier.", "x-found-in": "path" } }, "required": ["calendar_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_calendar_events", "description": "Get info about events in calendars.", "x-api": { "id": "ml.get_calendar_events", "name": "get-calendar-events", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/calendars/{calendar_id}/events", "x-urls": [{ "path": "/_ml/calendars/{calendar_id}/events", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Specifies to get events with timestamps earlier than this time.", "x-found-in": "query" }, "from": { "type": "number", "description": "Skips the specified number of events.", "x-found-in": "query" }, "job_id": { "type": "string", "description": "Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of `_all` or `*`.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of events to obtain.", "x-found-in": "query" }, "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Specifies to get events with timestamps after this time.", "x-found-in": "query" }, "calendar_id": { "type": "string", "description": "A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using `_all` or `*` or by omitting the calendar identifier.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["calendar_id"] }

package/lib/cjs/es/json/ml.get_calendars.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_calendars", "description": "Get calendar configuration info.", "x-api": { "id": "ml.get_calendars", "name": "get-calendars", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/calendars/{calendar_id}", "x-urls": [{ "path": "/_ml/calendars", "methods": ["GET", "POST"] }, { "path": "/_ml/calendars/{calendar_id}", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "from": { "type": "number", "description": "Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier.", "x-found-in": "query" }, "page": { "$ref": "./ml._types.json#/$defs/ml._types__Page", "description": "This object is supported only when you omit the calendar identifier.", "x-found-in": "body" }, "calendar_id": { "type": "string", "description": "A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using `_all` or `*` or by omitting the calendar identifier.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_calendars", "description": "Get calendar configuration info.", "x-api": { "id": "ml.get_calendars", "name": "get-calendars", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/calendars/{calendar_id}", "x-urls": [{ "path": "/_ml/calendars", "methods": ["GET", "POST"] }, { "path": "/_ml/calendars/{calendar_id}", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "from": { "type": "number", "description": "Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier.", "x-found-in": "query" }, "page": { "$ref": "./ml._types.json#/$defs/ml._types__Page", "description": "This object is supported only when you omit the calendar identifier.", "x-found-in": "body" }, "calendar_id": { "type": "string", "description": "A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using `_all` or `*` or by omitting the calendar identifier.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/cjs/es/json/ml.get_categories.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_categories", "description": "Get anomaly detection job results for categories.", "x-api": { "id": "ml.get_categories", "name": "get-categories", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/anomaly_detectors/{job_id}/results/categories/{category_id}", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/results/categories/{category_id}", "methods": ["GET", "POST"] }, { "path": "/_ml/anomaly_detectors/{job_id}/results/categories", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "from": { "type": "number", "description": "Skips the specified number of categories.", "x-found-in": "query" }, "partition_field_value": { "type": "string", "description": "Only return categories for the specified partition.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of categories to obtain.", "x-found-in": "query" }, "page": { "$ref": "./ml._types.json#/$defs/ml._types__Page", "description": "Configures pagination.\nThis parameter has the `from` and `size` properties.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "category_id": { "type": "number", "description": "Identifier for the category, which is unique in the job. If you specify\nneither the category ID nor the partition_field_value, the API returns\ninformation about all categories. If you specify only the\npartition_field_value, it returns information about all categories for\nthe specified partition.", "x-found-in": "path" } }, "required": ["job_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_categories", "description": "Get anomaly detection job results for categories.", "x-api": { "id": "ml.get_categories", "name": "get-categories", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/anomaly_detectors/{job_id}/results/categories/{category_id}", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/results/categories/{category_id}", "methods": ["GET", "POST"] }, { "path": "/_ml/anomaly_detectors/{job_id}/results/categories", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "from": { "type": "number", "description": "Skips the specified number of categories.", "x-found-in": "query" }, "partition_field_value": { "type": "string", "description": "Only return categories for the specified partition.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of categories to obtain.", "x-found-in": "query" }, "page": { "$ref": "./ml._types.json#/$defs/ml._types__Page", "description": "Configures pagination.\nThis parameter has the `from` and `size` properties.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "category_id": { "type": "number", "description": "Identifier for the category, which is unique in the job. If you specify\nneither the category ID nor the partition_field_value, the API returns\ninformation about all categories. If you specify only the\npartition_field_value, it returns information about all categories for\nthe specified partition.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["job_id"] }

package/lib/cjs/es/json/ml.get_data_frame_analytics.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_data_frame_analytics", "description": "Get data frame analytics job configuration info.\n\nYou can get information for multiple data frame analytics jobs in a single\nAPI request by using a comma-separated list of data frame analytics jobs or a\nwildcard expression.", "x-api": { "id": "ml.get_data_frame_analytics", "name": "get-data-frame-analytics", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/data_frame/analytics/{id}", "x-urls": [{ "path": "/_ml/data_frame/analytics/{id}", "methods": ["GET"] }, { "path": "/_ml/data_frame/analytics", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.3.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_match": { "type": "boolean", "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no data frame analytics\njobs that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value returns an empty data_frame_analytics array when there\nare no matches and the subset of results when there are partial matches.\nIf this parameter is `false`, the request returns a 404 status code when\nthere are no matches or only partial matches.", "x-found-in": "query" }, "from": { "type": "number", "description": "Skips the specified number of data frame analytics jobs.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of data frame analytics jobs to obtain.", "x-found-in": "query" }, "exclude_generated": { "type": "boolean", "description": "Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.", "x-found-in": "query" }, "id": { "type": "string", "description": "Identifier for the data frame analytics job. If you do not specify this\noption, the API returns information for the first hundred data frame\nanalytics jobs.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_data_frame_analytics", "description": "Get data frame analytics job configuration info.\n\nYou can get information for multiple data frame analytics jobs in a single\nAPI request by using a comma-separated list of data frame analytics jobs or a\nwildcard expression.", "x-api": { "id": "ml.get_data_frame_analytics", "name": "get-data-frame-analytics", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/data_frame/analytics/{id}", "x-urls": [{ "path": "/_ml/data_frame/analytics/{id}", "methods": ["GET"] }, { "path": "/_ml/data_frame/analytics", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.3.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_match": { "type": "boolean", "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no data frame analytics\njobs that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value returns an empty data_frame_analytics array when there\nare no matches and the subset of results when there are partial matches.\nIf this parameter is `false`, the request returns a 404 status code when\nthere are no matches or only partial matches.", "x-found-in": "query" }, "from": { "type": "number", "description": "Skips the specified number of data frame analytics jobs.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of data frame analytics jobs to obtain.", "x-found-in": "query" }, "exclude_generated": { "type": "boolean", "description": "Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.", "x-found-in": "query" }, "id": { "type": "string", "description": "Identifier for the data frame analytics job. If you do not specify this\noption, the API returns information for the first hundred data frame\nanalytics jobs.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/cjs/es/json/ml.get_data_frame_analytics_stats.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_data_frame_analytics_stats", "description": "Get data frame analytics job stats.", "x-api": { "id": "ml.get_data_frame_analytics_stats", "name": "get-data-frame-analytics-stats", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/data_frame/analytics/{id}/_stats", "x-urls": [{ "path": "/_ml/data_frame/analytics/_stats", "methods": ["GET"] }, { "path": "/_ml/data_frame/analytics/{id}/_stats", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.3.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_match": { "type": "boolean", "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no data frame analytics\njobs that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value returns an empty data_frame_analytics array when there\nare no matches and the subset of results when there are partial matches.\nIf this parameter is `false`, the request returns a 404 status code when\nthere are no matches or only partial matches.", "x-found-in": "query" }, "from": { "type": "number", "description": "Skips the specified number of data frame analytics jobs.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of data frame analytics jobs to obtain.", "x-found-in": "query" }, "verbose": { "type": "boolean", "description": "Defines whether the stats response should be verbose.", "x-found-in": "query" }, "id": { "type": "string", "description": "Identifier for the data frame analytics job. If you do not specify this\noption, the API returns information for the first hundred data frame\nanalytics jobs.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_data_frame_analytics_stats", "description": "Get data frame analytics job stats.", "x-api": { "id": "ml.get_data_frame_analytics_stats", "name": "get-data-frame-analytics-stats", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/data_frame/analytics/{id}/_stats", "x-urls": [{ "path": "/_ml/data_frame/analytics/_stats", "methods": ["GET"] }, { "path": "/_ml/data_frame/analytics/{id}/_stats", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.3.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_match": { "type": "boolean", "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no data frame analytics\njobs that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value returns an empty data_frame_analytics array when there\nare no matches and the subset of results when there are partial matches.\nIf this parameter is `false`, the request returns a 404 status code when\nthere are no matches or only partial matches.", "x-found-in": "query" }, "from": { "type": "number", "description": "Skips the specified number of data frame analytics jobs.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of data frame analytics jobs to obtain.", "x-found-in": "query" }, "verbose": { "type": "boolean", "description": "Defines whether the stats response should be verbose.", "x-found-in": "query" }, "id": { "type": "string", "description": "Identifier for the data frame analytics job. If you do not specify this\noption, the API returns information for the first hundred data frame\nanalytics jobs.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/cjs/es/json/ml.get_datafeed_stats.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_datafeed_stats", "description": "Get datafeed stats.\n\nYou can get statistics for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget statistics for all datafeeds by using `_all`, by specifying `*` as the\n`<feed_id>`, or by omitting the `<feed_id>`. If the datafeed is stopped, the\nonly information you receive is the `datafeed_id` and the `state`.\nThis API returns a maximum of 10,000 datafeeds.", "x-api": { "id": "ml.get_datafeed_stats", "name": "get-datafeed-stats", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/datafeeds/{datafeed_id}/_stats", "x-urls": [{ "path": "/_ml/datafeeds/{datafeed_id}/_stats", "methods": ["GET"] }, { "path": "/_ml/datafeeds/_stats", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_match": { "type": "boolean", "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no datafeeds that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is `true`, which returns an empty `datafeeds` array\nwhen there are no matches and the subset of results when there are\npartial matches. If this parameter is `false`, the request returns a\n`404` status code when there are no matches or only partial matches.", "x-found-in": "query" }, "datafeed_id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "Identifier for the datafeed. It can be a datafeed identifier or a\nwildcard expression. If you do not specify one of these options, the API\nreturns information about all datafeeds.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_datafeed_stats", "description": "Get datafeed stats.\n\nYou can get statistics for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget statistics for all datafeeds by using `_all`, by specifying `*` as the\n`<feed_id>`, or by omitting the `<feed_id>`. If the datafeed is stopped, the\nonly information you receive is the `datafeed_id` and the `state`.\nThis API returns a maximum of 10,000 datafeeds.", "x-api": { "id": "ml.get_datafeed_stats", "name": "get-datafeed-stats", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/datafeeds/{datafeed_id}/_stats", "x-urls": [{ "path": "/_ml/datafeeds/{datafeed_id}/_stats", "methods": ["GET"] }, { "path": "/_ml/datafeeds/_stats", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_match": { "type": "boolean", "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no datafeeds that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is `true`, which returns an empty `datafeeds` array\nwhen there are no matches and the subset of results when there are\npartial matches. If this parameter is `false`, the request returns a\n`404` status code when there are no matches or only partial matches.", "x-found-in": "query" }, "datafeed_id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "Identifier for the datafeed. It can be a datafeed identifier or a\nwildcard expression. If you do not specify one of these options, the API\nreturns information about all datafeeds.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/cjs/es/json/ml.get_datafeeds.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_datafeeds", "description": "Get datafeeds configuration info.\n\nYou can get information for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget information for all datafeeds by using `_all`, by specifying `*` as the\n`<feed_id>`, or by omitting the `<feed_id>`.\nThis API returns a maximum of 10,000 datafeeds.", "x-api": { "id": "ml.get_datafeeds", "name": "get-datafeeds", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/datafeeds/{datafeed_id}", "x-urls": [{ "path": "/_ml/datafeeds/{datafeed_id}", "methods": ["GET"] }, { "path": "/_ml/datafeeds", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_match": { "type": "boolean", "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no datafeeds that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is `true`, which returns an empty `datafeeds` array\nwhen there are no matches and the subset of results when there are\npartial matches. If this parameter is `false`, the request returns a\n`404` status code when there are no matches or only partial matches.", "x-found-in": "query" }, "exclude_generated": { "type": "boolean", "description": "Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.", "x-found-in": "query" }, "datafeed_id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "Identifier for the datafeed. It can be a datafeed identifier or a\nwildcard expression. If you do not specify one of these options, the API\nreturns information about all datafeeds.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_datafeeds", "description": "Get datafeeds configuration info.\n\nYou can get information for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget information for all datafeeds by using `_all`, by specifying `*` as the\n`<feed_id>`, or by omitting the `<feed_id>`.\nThis API returns a maximum of 10,000 datafeeds.", "x-api": { "id": "ml.get_datafeeds", "name": "get-datafeeds", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/datafeeds/{datafeed_id}", "x-urls": [{ "path": "/_ml/datafeeds/{datafeed_id}", "methods": ["GET"] }, { "path": "/_ml/datafeeds", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_match": { "type": "boolean", "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no datafeeds that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is `true`, which returns an empty `datafeeds` array\nwhen there are no matches and the subset of results when there are\npartial matches. If this parameter is `false`, the request returns a\n`404` status code when there are no matches or only partial matches.", "x-found-in": "query" }, "exclude_generated": { "type": "boolean", "description": "Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.", "x-found-in": "query" }, "datafeed_id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "Identifier for the datafeed. It can be a datafeed identifier or a\nwildcard expression. If you do not specify one of these options, the API\nreturns information about all datafeeds.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/cjs/es/json/ml.get_filters.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_filters", "description": "Get filters.\n\nYou can get a single filter or all filters.", "x-api": { "id": "ml.get_filters", "name": "get-filters", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/filters/{filter_id}", "x-urls": [{ "path": "/_ml/filters", "methods": ["GET"] }, { "path": "/_ml/filters/{filter_id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "from": { "type": "number", "description": "Skips the specified number of filters.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of filters to obtain.", "x-found-in": "query" }, "filter_id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "A string that uniquely identifies a filter.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_filters", "description": "Get filters.\n\nYou can get a single filter or all filters.", "x-api": { "id": "ml.get_filters", "name": "get-filters", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/filters/{filter_id}", "x-urls": [{ "path": "/_ml/filters", "methods": ["GET"] }, { "path": "/_ml/filters/{filter_id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "from": { "type": "number", "description": "Skips the specified number of filters.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of filters to obtain.", "x-found-in": "query" }, "filter_id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "A string that uniquely identifies a filter.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/cjs/es/json/ml.get_influencers.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_influencers", "description": "Get anomaly detection job results for influencers.\n\nInfluencers are the entities that have contributed to, or are to blame for,\nthe anomalies. Influencer results are available only if an\n`influencer_field_name` is specified in the job configuration.", "x-api": { "id": "ml.get_influencers", "name": "get-influencers", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/anomaly_detectors/{job_id}/results/influencers", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/results/influencers", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "desc": { "type": "boolean", "description": "If true, the results are sorted in descending order.", "x-found-in": "query" }, "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Returns influencers with timestamps earlier than this time.\nThe default value means it is unset and results are not limited to\nspecific timestamps.", "x-found-in": "query" }, "exclude_interim": { "type": "boolean", "description": "If true, the output excludes interim results. By default, interim results\nare included.", "x-found-in": "query" }, "influencer_score": { "type": "number", "description": "Returns influencers with anomaly scores greater than or equal to this\nvalue.", "x-found-in": "query" }, "from": { "type": "number", "description": "Skips the specified number of influencers.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of influencers to obtain.", "x-found-in": "query" }, "sort": { "type": "string", "description": "Specifies the sort field for the requested influencers. By default, the\ninfluencers are sorted by the `influencer_score` value.", "x-found-in": "query" }, "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Returns influencers with timestamps after this time. The default value\nmeans it is unset and results are not limited to specific timestamps.", "x-found-in": "query" }, "page": { "$ref": "./ml._types.json#/$defs/ml._types__Page", "description": "Configures pagination.\nThis parameter has the `from` and `size` properties.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" } }, "required": ["job_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_influencers", "description": "Get anomaly detection job results for influencers.\n\nInfluencers are the entities that have contributed to, or are to blame for,\nthe anomalies. Influencer results are available only if an\n`influencer_field_name` is specified in the job configuration.", "x-api": { "id": "ml.get_influencers", "name": "get-influencers", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/anomaly_detectors/{job_id}/results/influencers", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/results/influencers", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "desc": { "type": "boolean", "description": "If true, the results are sorted in descending order.", "x-found-in": "query" }, "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Returns influencers with timestamps earlier than this time.\nThe default value means it is unset and results are not limited to\nspecific timestamps.", "x-found-in": "query" }, "exclude_interim": { "type": "boolean", "description": "If true, the output excludes interim results. By default, interim results\nare included.", "x-found-in": "query" }, "influencer_score": { "type": "number", "description": "Returns influencers with anomaly scores greater than or equal to this\nvalue.", "x-found-in": "query" }, "from": { "type": "number", "description": "Skips the specified number of influencers.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of influencers to obtain.", "x-found-in": "query" }, "sort": { "type": "string", "description": "Specifies the sort field for the requested influencers. By default, the\ninfluencers are sorted by the `influencer_score` value.", "x-found-in": "query" }, "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Returns influencers with timestamps after this time. The default value\nmeans it is unset and results are not limited to specific timestamps.", "x-found-in": "query" }, "page": { "$ref": "./ml._types.json#/$defs/ml._types__Page", "description": "Configures pagination.\nThis parameter has the `from` and `size` properties.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["job_id"] }

package/lib/cjs/es/json/ml.get_job_stats.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_job_stats", "description": "Get anomaly detection job stats.", "x-api": { "id": "ml.get_job_stats", "name": "get-job-stats", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/anomaly_detectors/{job_id}/_stats", "x-urls": [{ "path": "/_ml/anomaly_detectors/_stats", "methods": ["GET"] }, { "path": "/_ml/anomaly_detectors/{job_id}/_stats", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_match": { "type": "boolean", "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no jobs that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty `jobs` array when\nthere are no matches and the subset of results when there are partial\nmatches. If `false`, the API returns a `404` status\ncode when there are no matches or only partial matches.", "x-found-in": "query" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job. It can be a job identifier, a\ngroup name, a comma-separated list of jobs, or a wildcard expression. If\nyou do not specify one of these options, the API returns information for\nall anomaly detection jobs.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_job_stats", "description": "Get anomaly detection job stats.", "x-api": { "id": "ml.get_job_stats", "name": "get-job-stats", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/anomaly_detectors/{job_id}/_stats", "x-urls": [{ "path": "/_ml/anomaly_detectors/_stats", "methods": ["GET"] }, { "path": "/_ml/anomaly_detectors/{job_id}/_stats", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_match": { "type": "boolean", "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no jobs that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty `jobs` array when\nthere are no matches and the subset of results when there are partial\nmatches. If `false`, the API returns a `404` status\ncode when there are no matches or only partial matches.", "x-found-in": "query" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job. It can be a job identifier, a\ngroup name, a comma-separated list of jobs, or a wildcard expression. If\nyou do not specify one of these options, the API returns information for\nall anomaly detection jobs.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/cjs/es/json/ml.get_jobs.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_jobs", "description": "Get anomaly detection jobs configuration info.\n\nYou can get information for multiple anomaly detection jobs in a single API\nrequest by using a group name, a comma-separated list of jobs, or a wildcard\nexpression. You can get information for all anomaly detection jobs by using\n`_all`, by specifying `*` as the `<job_id>`, or by omitting the `<job_id>`.", "x-api": { "id": "ml.get_jobs", "name": "get-jobs", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/anomaly_detectors/{job_id}", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}", "methods": ["GET"] }, { "path": "/_ml/anomaly_detectors", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_match": { "type": "boolean", "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no jobs that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is `true`, which returns an empty `jobs` array when\nthere are no matches and the subset of results when there are partial\nmatches. If this parameter is `false`, the request returns a `404` status\ncode when there are no matches or only partial matches.", "x-found-in": "query" }, "exclude_generated": { "type": "boolean", "description": "Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.", "x-found-in": "query" }, "job_id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "Identifier for the anomaly detection job. It can be a job identifier, a\ngroup name, or a wildcard expression. If you do not specify one of these\noptions, the API returns information for all anomaly detection jobs.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_jobs", "description": "Get anomaly detection jobs configuration info.\n\nYou can get information for multiple anomaly detection jobs in a single API\nrequest by using a group name, a comma-separated list of jobs, or a wildcard\nexpression. You can get information for all anomaly detection jobs by using\n`_all`, by specifying `*` as the `<job_id>`, or by omitting the `<job_id>`.", "x-api": { "id": "ml.get_jobs", "name": "get-jobs", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/anomaly_detectors/{job_id}", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}", "methods": ["GET"] }, { "path": "/_ml/anomaly_detectors", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_match": { "type": "boolean", "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no jobs that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is `true`, which returns an empty `jobs` array when\nthere are no matches and the subset of results when there are partial\nmatches. If this parameter is `false`, the request returns a `404` status\ncode when there are no matches or only partial matches.", "x-found-in": "query" }, "exclude_generated": { "type": "boolean", "description": "Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.", "x-found-in": "query" }, "job_id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "Identifier for the anomaly detection job. It can be a job identifier, a\ngroup name, or a wildcard expression. If you do not specify one of these\noptions, the API returns information for all anomaly detection jobs.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/cjs/es/json/ml.get_memory_stats.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_memory_stats", "description": "Get machine learning memory usage info.\n\nGet information about how machine learning jobs and trained models are using memory,\non each node, both within the JVM heap, and natively, outside of the JVM.", "x-api": { "id": "ml.get_memory_stats", "name": "get-memory-stats", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/memory/{node_id}/_stats", "x-urls": [{ "path": "/_ml/memory/_stats", "methods": ["GET"] }, { "path": "/_ml/memory/{node_id}/_stats", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is received before the timeout\nexpires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request\nfails and returns an error.", "x-found-in": "query" }, "node_id": { "type": "string", "description": "The names of particular nodes in the cluster to target. For example, `nodeId1,nodeId2` or\n`ml:true`", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_memory_stats", "description": "Get machine learning memory usage info.\n\nGet information about how machine learning jobs and trained models are using memory,\non each node, both within the JVM heap, and natively, outside of the JVM.", "x-api": { "id": "ml.get_memory_stats", "name": "get-memory-stats", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/memory/{node_id}/_stats", "x-urls": [{ "path": "/_ml/memory/_stats", "methods": ["GET"] }, { "path": "/_ml/memory/{node_id}/_stats", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is received before the timeout\nexpires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request\nfails and returns an error.", "x-found-in": "query" }, "node_id": { "type": "string", "description": "The names of particular nodes in the cluster to target. For example, `nodeId1,nodeId2` or\n`ml:true`", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/cjs/es/json/ml.get_model_snapshot_upgrade_stats.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_model_snapshot_upgrade_stats", "description": "Get anomaly detection job model snapshot upgrade usage info.", "x-api": { "id": "ml.get_model_snapshot_upgrade_stats", "name": "get-model-snapshot-upgrade-stats", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade/_stats", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade/_stats", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.16.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "allow_no_match": { "type": "boolean", "description": "Specifies what to do when the request:\n\n -  Contains wildcard expressions and there are no jobs that match.\n -  Contains the _all string or no identifiers and there are no matches.\n -  Contains wildcard expressions and there are only partial matches.\n\nThe default value is true, which returns an empty jobs array when there are no matches and the subset of results\nwhen there are partial matches. If this parameter is false, the request returns a 404 status code when there are\nno matches or only partial matches.", "x-found-in": "query" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "snapshot_id": { "type": "string", "description": "A numerical character string that uniquely identifies the model snapshot. You can get information for multiple\nsnapshots by using a comma-separated list or a wildcard expression. You can get all snapshots by using `_all`,\nby specifying `*` as the snapshot ID, or by omitting the snapshot ID.", "x-found-in": "path" } }, "required": ["job_id", "snapshot_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_model_snapshot_upgrade_stats", "description": "Get anomaly detection job model snapshot upgrade usage info.", "x-api": { "id": "ml.get_model_snapshot_upgrade_stats", "name": "get-model-snapshot-upgrade-stats", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade/_stats", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade/_stats", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.16.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "allow_no_match": { "type": "boolean", "description": "Specifies what to do when the request:\n\n -  Contains wildcard expressions and there are no jobs that match.\n -  Contains the _all string or no identifiers and there are no matches.\n -  Contains wildcard expressions and there are only partial matches.\n\nThe default value is true, which returns an empty jobs array when there are no matches and the subset of results\nwhen there are partial matches. If this parameter is false, the request returns a 404 status code when there are\nno matches or only partial matches.", "x-found-in": "query" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "snapshot_id": { "type": "string", "description": "A numerical character string that uniquely identifies the model snapshot. You can get information for multiple\nsnapshots by using a comma-separated list or a wildcard expression. You can get all snapshots by using `_all`,\nby specifying `*` as the snapshot ID, or by omitting the snapshot ID.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["job_id", "snapshot_id"] }

package/lib/cjs/es/json/ml.get_model_snapshots.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_model_snapshots", "description": "Get model snapshots info.", "x-api": { "id": "ml.get_model_snapshots", "name": "get-model-snapshots", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}", "methods": ["GET", "POST"] }, { "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "desc": { "type": "boolean", "description": "Refer to the description for the `desc` query parameter.", "x-found-in": "body" }, "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `end` query parameter.", "x-found-in": "body" }, "from": { "type": "number", "description": "Skips the specified number of snapshots.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of snapshots to obtain.", "x-found-in": "query" }, "sort": { "type": "string", "description": "Refer to the description for the `sort` query parameter.", "x-found-in": "body" }, "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `start` query parameter.", "x-found-in": "body" }, "page": { "$ref": "./ml._types.json#/$defs/ml._types__Page", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "snapshot_id": { "type": "string", "description": "A numerical character string that uniquely identifies the model snapshot. You can get information for multiple\nsnapshots by using a comma-separated list or a wildcard expression. You can get all snapshots by using `_all`,\nby specifying `*` as the snapshot ID, or by omitting the snapshot ID.", "x-found-in": "path" } }, "required": ["job_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_model_snapshots", "description": "Get model snapshots info.", "x-api": { "id": "ml.get_model_snapshots", "name": "get-model-snapshots", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}", "methods": ["GET", "POST"] }, { "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "desc": { "type": "boolean", "description": "Refer to the description for the `desc` query parameter.", "x-found-in": "body" }, "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `end` query parameter.", "x-found-in": "body" }, "from": { "type": "number", "description": "Skips the specified number of snapshots.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of snapshots to obtain.", "x-found-in": "query" }, "sort": { "type": "string", "description": "Refer to the description for the `sort` query parameter.", "x-found-in": "body" }, "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `start` query parameter.", "x-found-in": "body" }, "page": { "$ref": "./ml._types.json#/$defs/ml._types__Page", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "snapshot_id": { "type": "string", "description": "A numerical character string that uniquely identifies the model snapshot. You can get information for multiple\nsnapshots by using a comma-separated list or a wildcard expression. You can get all snapshots by using `_all`,\nby specifying `*` as the snapshot ID, or by omitting the snapshot ID.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["job_id"] }

package/lib/cjs/es/json/ml.get_overall_buckets.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_overall_buckets", "description": "Get overall bucket results.\n\nRetrievs overall bucket results that summarize the bucket results of\nmultiple anomaly detection jobs.\n\nThe `overall_score` is calculated by combining the scores of all the\nbuckets within the overall bucket span. First, the maximum\n`anomaly_score` per anomaly detection job in the overall bucket is\ncalculated. Then the `top_n` of those scores are averaged to result in\nthe `overall_score`. This means that you can fine-tune the\n`overall_score` so that it is more or less sensitive to the number of\njobs that detect an anomaly at the same time. For example, if you set\n`top_n` to `1`, the `overall_score` is the maximum bucket score in the\noverall bucket. Alternatively, if you set `top_n` to the number of jobs,\nthe `overall_score` is high only when all jobs detect anomalies in that\noverall bucket. If you set the `bucket_span` parameter (to a value\ngreater than its default), the `overall_score` is the maximum\n`overall_score` of the overall buckets that have a span equal to the\njobs' largest bucket span.", "x-api": { "id": "ml.get_overall_buckets", "name": "get-overall-buckets", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/anomaly_detectors/{job_id}/results/overall_buckets", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/results/overall_buckets", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.1.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_match": { "type": "boolean", "description": "Refer to the description for the `allow_no_match` query parameter.", "x-found-in": "body" }, "bucket_span": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Refer to the description for the `bucket_span` query parameter.", "x-found-in": "body" }, "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `end` query parameter.", "x-found-in": "body" }, "exclude_interim": { "type": "boolean", "description": "Refer to the description for the `exclude_interim` query parameter.", "x-found-in": "body" }, "overall_score": { "type": "number", "description": "Refer to the description for the `overall_score` query parameter.", "x-found-in": "body" }, "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `start` query parameter.", "x-found-in": "body" }, "top_n": { "type": "number", "description": "Refer to the description for the `top_n` query parameter.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job. It can be a job identifier, a\ngroup name, a comma-separated list of jobs or groups, or a wildcard\nexpression.\n\nYou can summarize the bucket results for all anomaly detection jobs by\nusing `_all` or by specifying `*` as the `<job_id>`.", "x-found-in": "path" } }, "required": ["job_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_overall_buckets", "description": "Get overall bucket results.\n\nRetrievs overall bucket results that summarize the bucket results of\nmultiple anomaly detection jobs.\n\nThe `overall_score` is calculated by combining the scores of all the\nbuckets within the overall bucket span. First, the maximum\n`anomaly_score` per anomaly detection job in the overall bucket is\ncalculated. Then the `top_n` of those scores are averaged to result in\nthe `overall_score`. This means that you can fine-tune the\n`overall_score` so that it is more or less sensitive to the number of\njobs that detect an anomaly at the same time. For example, if you set\n`top_n` to `1`, the `overall_score` is the maximum bucket score in the\noverall bucket. Alternatively, if you set `top_n` to the number of jobs,\nthe `overall_score` is high only when all jobs detect anomalies in that\noverall bucket. If you set the `bucket_span` parameter (to a value\ngreater than its default), the `overall_score` is the maximum\n`overall_score` of the overall buckets that have a span equal to the\njobs' largest bucket span.", "x-api": { "id": "ml.get_overall_buckets", "name": "get-overall-buckets", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/anomaly_detectors/{job_id}/results/overall_buckets", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/results/overall_buckets", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.1.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_match": { "type": "boolean", "description": "Refer to the description for the `allow_no_match` query parameter.", "x-found-in": "body" }, "bucket_span": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Refer to the description for the `bucket_span` query parameter.", "x-found-in": "body" }, "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `end` query parameter.", "x-found-in": "body" }, "exclude_interim": { "type": "boolean", "description": "Refer to the description for the `exclude_interim` query parameter.", "x-found-in": "body" }, "overall_score": { "type": "number", "description": "Refer to the description for the `overall_score` query parameter.", "x-found-in": "body" }, "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `start` query parameter.", "x-found-in": "body" }, "top_n": { "type": "number", "description": "Refer to the description for the `top_n` query parameter.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job. It can be a job identifier, a\ngroup name, a comma-separated list of jobs or groups, or a wildcard\nexpression.\n\nYou can summarize the bucket results for all anomaly detection jobs by\nusing `_all` or by specifying `*` as the `<job_id>`.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["job_id"] }

package/lib/cjs/es/json/ml.get_records.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_records", "description": "Get anomaly records for an anomaly detection job.\n\nRecords contain the detailed analytical results. They describe the anomalous\nactivity that has been identified in the input data based on the detector\nconfiguration.\nThere can be many anomaly records depending on the characteristics and size\nof the input data. In practice, there are often too many to be able to\nmanually process them. The machine learning features therefore perform a\nsophisticated aggregation of the anomaly records into buckets.\nThe number of record results depends on the number of anomalies found in each\nbucket, which relates to the number of time series being modeled and the\nnumber of detectors.", "x-api": { "id": "ml.get_records", "name": "get-records", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/anomaly_detectors/{job_id}/results/records", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/results/records", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "desc": { "type": "boolean", "description": "Refer to the description for the `desc` query parameter.", "x-found-in": "body" }, "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `end` query parameter.", "x-found-in": "body" }, "exclude_interim": { "type": "boolean", "description": "Refer to the description for the `exclude_interim` query parameter.", "x-found-in": "body" }, "from": { "type": "number", "description": "Skips the specified number of records.", "x-found-in": "query" }, "record_score": { "type": "number", "description": "Refer to the description for the `record_score` query parameter.", "x-found-in": "body" }, "size": { "type": "number", "description": "Specifies the maximum number of records to obtain.", "x-found-in": "query" }, "sort": { "type": "string", "description": "Refer to the description for the `sort` query parameter.", "x-found-in": "body" }, "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `start` query parameter.", "x-found-in": "body" }, "page": { "$ref": "./ml._types.json#/$defs/ml._types__Page", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" } }, "required": ["job_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_records", "description": "Get anomaly records for an anomaly detection job.\n\nRecords contain the detailed analytical results. They describe the anomalous\nactivity that has been identified in the input data based on the detector\nconfiguration.\nThere can be many anomaly records depending on the characteristics and size\nof the input data. In practice, there are often too many to be able to\nmanually process them. The machine learning features therefore perform a\nsophisticated aggregation of the anomaly records into buckets.\nThe number of record results depends on the number of anomalies found in each\nbucket, which relates to the number of time series being modeled and the\nnumber of detectors.", "x-api": { "id": "ml.get_records", "name": "get-records", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/anomaly_detectors/{job_id}/results/records", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/results/records", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "desc": { "type": "boolean", "description": "Refer to the description for the `desc` query parameter.", "x-found-in": "body" }, "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `end` query parameter.", "x-found-in": "body" }, "exclude_interim": { "type": "boolean", "description": "Refer to the description for the `exclude_interim` query parameter.", "x-found-in": "body" }, "from": { "type": "number", "description": "Skips the specified number of records.", "x-found-in": "query" }, "record_score": { "type": "number", "description": "Refer to the description for the `record_score` query parameter.", "x-found-in": "body" }, "size": { "type": "number", "description": "Specifies the maximum number of records to obtain.", "x-found-in": "query" }, "sort": { "type": "string", "description": "Refer to the description for the `sort` query parameter.", "x-found-in": "body" }, "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `start` query parameter.", "x-found-in": "body" }, "page": { "$ref": "./ml._types.json#/$defs/ml._types__Page", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["job_id"] }

package/lib/cjs/es/json/ml.get_trained_models.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_trained_models", "description": "Get trained model configuration info.", "x-api": { "id": "ml.get_trained_models", "name": "get-trained-models", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/trained_models/{model_id}", "x-urls": [{ "path": "/_ml/trained_models/{model_id}", "methods": ["GET"] }, { "path": "/_ml/trained_models", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.10.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_match": { "type": "boolean", "description": "Specifies what to do when the request:\n\n- Contains wildcard expressions and there are no models that match.\n- Contains the _all string or no identifiers and there are no matches.\n- Contains wildcard expressions and there are only partial matches.\n\nIf true, it returns an empty array when there are no matches and the\nsubset of results when there are partial matches.", "x-found-in": "query" }, "decompress_definition": { "type": "boolean", "description": "Specifies whether the included model definition should be returned as a\nJSON map (true) or in a custom compressed format (false).", "x-found-in": "query" }, "exclude_generated": { "type": "boolean", "description": "Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.", "x-found-in": "query" }, "from": { "type": "number", "description": "Skips the specified number of models.", "x-found-in": "query" }, "include": { "$ref": "./ml._types.json#/$defs/ml._types__Include", "description": "A comma delimited string of optional fields to include in the response\nbody.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of models to obtain.", "x-found-in": "query" }, "tags": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "A comma delimited string of tags. A trained model can have many tags, or\nnone. When supplied, only trained models that contain all the supplied\ntags are returned.", "x-found-in": "query" }, "model_id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "The unique identifier of the trained model or a model alias.\n\nYou can get information for multiple trained models in a single API\nrequest by using a comma-separated list of model IDs or a wildcard\nexpression.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_trained_models", "description": "Get trained model configuration info.", "x-api": { "id": "ml.get_trained_models", "name": "get-trained-models", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/trained_models/{model_id}", "x-urls": [{ "path": "/_ml/trained_models/{model_id}", "methods": ["GET"] }, { "path": "/_ml/trained_models", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.10.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_match": { "type": "boolean", "description": "Specifies what to do when the request:\n\n- Contains wildcard expressions and there are no models that match.\n- Contains the _all string or no identifiers and there are no matches.\n- Contains wildcard expressions and there are only partial matches.\n\nIf true, it returns an empty array when there are no matches and the\nsubset of results when there are partial matches.", "x-found-in": "query" }, "decompress_definition": { "type": "boolean", "description": "Specifies whether the included model definition should be returned as a\nJSON map (true) or in a custom compressed format (false).", "x-found-in": "query" }, "exclude_generated": { "type": "boolean", "description": "Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.", "x-found-in": "query" }, "from": { "type": "number", "description": "Skips the specified number of models.", "x-found-in": "query" }, "include": { "$ref": "./ml._types.json#/$defs/ml._types__Include", "description": "A comma delimited string of optional fields to include in the response\nbody.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of models to obtain.", "x-found-in": "query" }, "tags": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "A comma delimited string of tags. A trained model can have many tags, or\nnone. When supplied, only trained models that contain all the supplied\ntags are returned.", "x-found-in": "query" }, "model_id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "The unique identifier of the trained model or a model alias.\n\nYou can get information for multiple trained models in a single API\nrequest by using a comma-separated list of model IDs or a wildcard\nexpression.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/cjs/es/json/ml.get_trained_models_stats.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_trained_models_stats", "description": "Get trained models usage info.\n\nYou can get usage information for multiple trained\nmodels in a single API request by using a comma-separated list of model IDs or a wildcard expression.", "x-api": { "id": "ml.get_trained_models_stats", "name": "get-trained-models-stats", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/trained_models/{model_id}/_stats", "x-urls": [{ "path": "/_ml/trained_models/{model_id}/_stats", "methods": ["GET"] }, { "path": "/_ml/trained_models/_stats", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.10.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_match": { "type": "boolean", "description": "Specifies what to do when the request:\n\n- Contains wildcard expressions and there are no models that match.\n- Contains the _all string or no identifiers and there are no matches.\n- Contains wildcard expressions and there are only partial matches.\n\nIf true, it returns an empty array when there are no matches and the\nsubset of results when there are partial matches.", "x-found-in": "query" }, "from": { "type": "number", "description": "Skips the specified number of models.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of models to obtain.", "x-found-in": "query" }, "model_id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "The unique identifier of the trained model or a model alias. It can be a\ncomma-separated list or a wildcard expression.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_trained_models_stats", "description": "Get trained models usage info.\n\nYou can get usage information for multiple trained\nmodels in a single API request by using a comma-separated list of model IDs or a wildcard expression.", "x-api": { "id": "ml.get_trained_models_stats", "name": "get-trained-models-stats", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/trained_models/{model_id}/_stats", "x-urls": [{ "path": "/_ml/trained_models/{model_id}/_stats", "methods": ["GET"] }, { "path": "/_ml/trained_models/_stats", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.10.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_match": { "type": "boolean", "description": "Specifies what to do when the request:\n\n- Contains wildcard expressions and there are no models that match.\n- Contains the _all string or no identifiers and there are no matches.\n- Contains wildcard expressions and there are only partial matches.\n\nIf true, it returns an empty array when there are no matches and the\nsubset of results when there are partial matches.", "x-found-in": "query" }, "from": { "type": "number", "description": "Skips the specified number of models.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of models to obtain.", "x-found-in": "query" }, "model_id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "The unique identifier of the trained model or a model alias. It can be a\ncomma-separated list or a wildcard expression.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/cjs/es/json/ml.infer_trained_model.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.infer_trained_model", "description": "Evaluate a trained model.", "x-api": { "id": "ml.infer_trained_model", "name": "infer-trained-model", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/trained_models/{model_id}/_infer", "x-urls": [{ "path": "/_ml/trained_models/{model_id}/_infer", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.3.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Controls the amount of time to wait for inference results.", "x-found-in": "query" }, "docs": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "description": "An array of objects to pass to the model for inference. The objects should contain a fields matching your\nconfigured trained model input. Typically, for NLP models, the field name is `text_field`.\nCurrently, for NLP models, only a single value is allowed.", "x-found-in": "body" }, "inference_config": { "$ref": "./ml._types.json#/$defs/ml._types__InferenceConfigUpdateContainer", "description": "The inference configuration updates to apply on the API call", "x-found-in": "body" }, "model_id": { "type": "string", "description": "The unique identifier of the trained model.", "x-found-in": "path" } }, "required": ["model_id", "docs"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.infer_trained_model", "description": "Evaluate a trained model.", "x-api": { "id": "ml.infer_trained_model", "name": "infer-trained-model", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/trained_models/{model_id}/_infer", "x-urls": [{ "path": "/_ml/trained_models/{model_id}/_infer", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.3.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Controls the amount of time to wait for inference results.", "x-found-in": "query" }, "docs": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "description": "An array of objects to pass to the model for inference. The objects should contain a fields matching your\nconfigured trained model input. Typically, for NLP models, the field name is `text_field`.\nCurrently, for NLP models, only a single value is allowed.", "x-found-in": "body" }, "inference_config": { "$ref": "./ml._types.json#/$defs/ml._types__InferenceConfigUpdateContainer", "description": "The inference configuration updates to apply on the API call", "x-found-in": "body" }, "model_id": { "type": "string", "description": "The unique identifier of the trained model.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["model_id", "docs"] }

package/lib/cjs/es/json/ml.info.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.info", "description": "Get machine learning information.\n\nGet defaults and limits used by machine learning.\nThis endpoint is designed to be used by a user interface that needs to fully\nunderstand machine learning configurations where some options are not\nspecified, meaning that the defaults should be used. This endpoint may be\nused to find out what those defaults are. It also provides information about\nthe maximum size of machine learning jobs that could run in the current\ncluster configuration.", "x-api": { "id": "ml.info", "name": "info", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/info", "x-urls": [{ "path": "/_ml/info", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.3.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": {} }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.info", "description": "Get machine learning information.\n\nGet defaults and limits used by machine learning.\nThis endpoint is designed to be used by a user interface that needs to fully\nunderstand machine learning configurations where some options are not\nspecified, meaning that the defaults should be used. This endpoint may be\nused to find out what those defaults are. It also provides information about\nthe maximum size of machine learning jobs that could run in the current\ncluster configuration.", "x-api": { "id": "ml.info", "name": "info", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/info", "x-urls": [{ "path": "/_ml/info", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.3.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/cjs/es/json/ml.open_job.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.open_job", "description": "Open anomaly detection jobs.\n\nAn anomaly detection job must be opened to be ready to receive and analyze\ndata. It can be opened and closed multiple times throughout its lifecycle.\nWhen you open a new job, it starts with an empty model.\nWhen you open an existing job, the most recent model state is automatically\nloaded. The job is ready to resume its analysis from where it left off, once\nnew data is received.", "x-api": { "id": "ml.open_job", "name": "open-job", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/anomaly_detectors/{job_id}/_open", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/_open", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Refer to the description for the `timeout` query parameter.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" } }, "required": ["job_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.open_job", "description": "Open anomaly detection jobs.\n\nAn anomaly detection job must be opened to be ready to receive and analyze\ndata. It can be opened and closed multiple times throughout its lifecycle.\nWhen you open a new job, it starts with an empty model.\nWhen you open an existing job, the most recent model state is automatically\nloaded. The job is ready to resume its analysis from where it left off, once\nnew data is received.", "x-api": { "id": "ml.open_job", "name": "open-job", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/anomaly_detectors/{job_id}/_open", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/_open", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Refer to the description for the `timeout` query parameter.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["job_id"] }

package/lib/cjs/es/json/ml.post_calendar_events.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.post_calendar_events", "description": "Add scheduled events to the calendar.", "x-api": { "id": "ml.post_calendar_events", "name": "post-calendar-events", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/calendars/{calendar_id}/events", "x-urls": [{ "path": "/_ml/calendars/{calendar_id}/events", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "events": { "type": "array", "items": { "$ref": "./ml._types.json#/$defs/ml._types__CalendarEvent" }, "description": "A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format.", "x-found-in": "body" }, "calendar_id": { "type": "string", "description": "A string that uniquely identifies a calendar.", "x-found-in": "path" } }, "required": ["calendar_id", "events"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.post_calendar_events", "description": "Add scheduled events to the calendar.", "x-api": { "id": "ml.post_calendar_events", "name": "post-calendar-events", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/calendars/{calendar_id}/events", "x-urls": [{ "path": "/_ml/calendars/{calendar_id}/events", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "events": { "type": "array", "items": { "$ref": "./ml._types.json#/$defs/ml._types__CalendarEvent" }, "description": "A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format.", "x-found-in": "body" }, "calendar_id": { "type": "string", "description": "A string that uniquely identifies a calendar.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["calendar_id", "events"] }

package/lib/cjs/es/json/ml.post_data.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.post_data", "description": "Send data to an anomaly detection job for analysis.\n\nIMPORTANT: For each job, data can be accepted from only a single connection at a time.\nIt is not currently possible to post data to multiple jobs using wildcards or a comma-separated list.", "x-api": { "id": "ml.post_data", "name": "post-data", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/anomaly_detectors/{job_id}/_data", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/_data", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" } }, "x-deprecated": { "since": "7.11.0", "description": "Posting data directly to anomaly detection jobs is deprecated, in a future major version a datafeed will be required." }, "x-body-format": "ndjson", "type": "object", "properties": { "reset_end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Specifies the end of the bucket resetting range.", "x-found-in": "query" }, "reset_start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Specifies the start of the bucket resetting range.", "x-found-in": "query" }, "data": { "type": "array", "items": {}, "x-found-in": "body", "x-body-root": true }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job. The job must have a state of open to receive and process the data.", "x-found-in": "path" } }, "required": ["job_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.post_data", "description": "Send data to an anomaly detection job for analysis.\n\nIMPORTANT: For each job, data can be accepted from only a single connection at a time.\nIt is not currently possible to post data to multiple jobs using wildcards or a comma-separated list.", "x-api": { "id": "ml.post_data", "name": "post-data", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/anomaly_detectors/{job_id}/_data", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/_data", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" } }, "x-deprecated": { "since": "7.11.0", "description": "Posting data directly to anomaly detection jobs is deprecated, in a future major version a datafeed will be required." }, "x-body-format": ["ndjson", "json"], "type": "object", "properties": { "reset_end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Specifies the end of the bucket resetting range.", "x-found-in": "query" }, "reset_start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Specifies the start of the bucket resetting range.", "x-found-in": "query" }, "data": { "type": "array", "items": {}, "x-found-in": "body", "x-body-root": true }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job. The job must have a state of open to receive and process the data.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["job_id"] }

package/lib/cjs/es/json/ml.preview_data_frame_analytics.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.preview_data_frame_analytics", "description": "Preview features used by data frame analytics.\n\nPreview the extracted features used by a data frame analytics config.", "x-api": { "id": "ml.preview_data_frame_analytics", "name": "preview-data-frame-analytics", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/data_frame/analytics/{id}/_preview", "x-urls": [{ "path": "/_ml/data_frame/analytics/_preview", "methods": ["GET", "POST"] }, { "path": "/_ml/data_frame/analytics/{id}/_preview", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.13.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "config": { "$ref": "./ml.preview_data_frame_analytics.json#/$defs/ml.preview_data_frame_analytics__DataframePreviewConfig", "description": "A data frame analytics config as described in create data frame analytics\njobs. Note that `id` and `dest` don’t need to be provided in the context of\nthis API.", "x-found-in": "body" }, "id": { "type": "string", "description": "Identifier for the data frame analytics job.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.preview_data_frame_analytics", "description": "Preview features used by data frame analytics.\n\nPreview the extracted features used by a data frame analytics config.", "x-api": { "id": "ml.preview_data_frame_analytics", "name": "preview-data-frame-analytics", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/data_frame/analytics/{id}/_preview", "x-urls": [{ "path": "/_ml/data_frame/analytics/_preview", "methods": ["GET", "POST"] }, { "path": "/_ml/data_frame/analytics/{id}/_preview", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.13.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "config": { "$ref": "./ml.preview_data_frame_analytics.json#/$defs/ml.preview_data_frame_analytics__DataframePreviewConfig", "description": "A data frame analytics config as described in create data frame analytics\njobs. Note that `id` and `dest` don’t need to be provided in the context of\nthis API.", "x-found-in": "body" }, "id": { "type": "string", "description": "Identifier for the data frame analytics job.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }