@elastic/schemas 0.5.1 → 0.6.0

package/lib/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/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/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/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/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/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/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" } } }

package/lib/es/json/ml.preview_datafeed.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.preview_datafeed", "description": "Preview a datafeed.\n\nThis API returns the first \"page\" of search results from a datafeed.\nYou can preview an existing datafeed or provide configuration details for a datafeed\nand anomaly detection job in the API. The preview shows the structure of the data\nthat will be passed to the anomaly detection engine.\nIMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that\ncalled the API. However, when the datafeed starts it uses the roles of the last user that created or updated the\ndatafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials.\nYou can also use secondary authorization headers to supply the credentials.", "x-api": { "id": "ml.preview_datafeed", "name": "preview-datafeed", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/datafeeds/{datafeed_id}/_preview", "x-urls": [{ "path": "/_ml/datafeeds/{datafeed_id}/_preview", "methods": ["GET", "POST"] }, { "path": "/_ml/datafeeds/_preview", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "The start time from where the datafeed preview should begin", "x-found-in": "query" }, "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "The end time when the datafeed preview should stop", "x-found-in": "query" }, "datafeed_config": { "$ref": "./ml._types.json#/$defs/ml._types__DatafeedConfig", "description": "The datafeed definition to preview.", "x-found-in": "body" }, "job_config": { "$ref": "./ml._types.json#/$defs/ml._types__JobConfig", "description": "The configuration details for the anomaly detection job that is associated with the datafeed. If the\n`datafeed_config` object does not include a `job_id` that references an existing anomaly detection job, you must\nsupply this `job_config` object. If you include both a `job_id` and a `job_config`, the latter information is\nused. You cannot specify a `job_config` object unless you also supply a `datafeed_config` object.", "x-found-in": "body" }, "datafeed_id": { "type": "string", "description": "A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase\nalphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric\ncharacters. NOTE: If you use this path parameter, you cannot provide datafeed or anomaly detection job\nconfiguration details in the request body.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.preview_datafeed", "description": "Preview a datafeed.\n\nThis API returns the first \"page\" of search results from a datafeed.\nYou can preview an existing datafeed or provide configuration details for a datafeed\nand anomaly detection job in the API. The preview shows the structure of the data\nthat will be passed to the anomaly detection engine.\nIMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that\ncalled the API. However, when the datafeed starts it uses the roles of the last user that created or updated the\ndatafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials.\nYou can also use secondary authorization headers to supply the credentials.", "x-api": { "id": "ml.preview_datafeed", "name": "preview-datafeed", "namespace": "ml" }, "x-method": "GET", "x-path": "/_ml/datafeeds/{datafeed_id}/_preview", "x-urls": [{ "path": "/_ml/datafeeds/{datafeed_id}/_preview", "methods": ["GET", "POST"] }, { "path": "/_ml/datafeeds/_preview", "methods": ["GET", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "The start time from where the datafeed preview should begin", "x-found-in": "query" }, "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "The end time when the datafeed preview should stop", "x-found-in": "query" }, "datafeed_config": { "$ref": "./ml._types.json#/$defs/ml._types__DatafeedConfig", "description": "The datafeed definition to preview.", "x-found-in": "body" }, "job_config": { "$ref": "./ml._types.json#/$defs/ml._types__JobConfig", "description": "The configuration details for the anomaly detection job that is associated with the datafeed. If the\n`datafeed_config` object does not include a `job_id` that references an existing anomaly detection job, you must\nsupply this `job_config` object. If you include both a `job_id` and a `job_config`, the latter information is\nused. You cannot specify a `job_config` object unless you also supply a `datafeed_config` object.", "x-found-in": "body" }, "datafeed_id": { "type": "string", "description": "A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase\nalphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric\ncharacters. NOTE: If you use this path parameter, you cannot provide datafeed or anomaly detection job\nconfiguration details in the request body.", "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/es/json/ml.put_calendar.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.put_calendar", "description": "Create a calendar.", "x-api": { "id": "ml.put_calendar", "name": "put-calendar", "namespace": "ml" }, "x-method": "PUT", "x-path": "/_ml/calendars/{calendar_id}", "x-urls": [{ "path": "/_ml/calendars/{calendar_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "job_ids": { "type": "array", "items": { "type": "string" }, "description": "An array of anomaly detection job identifiers.", "x-found-in": "body" }, "description": { "type": "string", "description": "A description of the calendar.", "x-found-in": "body" }, "calendar_id": { "type": "string", "description": "A string that uniquely identifies a calendar.", "x-found-in": "path" } }, "required": ["calendar_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.put_calendar", "description": "Create a calendar.", "x-api": { "id": "ml.put_calendar", "name": "put-calendar", "namespace": "ml" }, "x-method": "PUT", "x-path": "/_ml/calendars/{calendar_id}", "x-urls": [{ "path": "/_ml/calendars/{calendar_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "job_ids": { "type": "array", "items": { "type": "string" }, "description": "An array of anomaly detection job identifiers.", "x-found-in": "body" }, "description": { "type": "string", "description": "A description of the calendar.", "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"] }

package/lib/es/json/ml.put_calendar_job.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.put_calendar_job", "description": "Add anomaly detection job to calendar.", "x-api": { "id": "ml.put_calendar_job", "name": "put-calendar-job", "namespace": "ml" }, "x-method": "PUT", "x-path": "/_ml/calendars/{calendar_id}/jobs/{job_id}", "x-urls": [{ "path": "/_ml/calendars/{calendar_id}/jobs/{job_id}", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "calendar_id": { "type": "string", "description": "A string that uniquely identifies a calendar.", "x-found-in": "path" }, "job_id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups.", "x-found-in": "path" } }, "required": ["calendar_id", "job_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.put_calendar_job", "description": "Add anomaly detection job to calendar.", "x-api": { "id": "ml.put_calendar_job", "name": "put-calendar-job", "namespace": "ml" }, "x-method": "PUT", "x-path": "/_ml/calendars/{calendar_id}/jobs/{job_id}", "x-urls": [{ "path": "/_ml/calendars/{calendar_id}/jobs/{job_id}", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "calendar_id": { "type": "string", "description": "A string that uniquely identifies a calendar.", "x-found-in": "path" }, "job_id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups.", "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", "job_id"] }

package/lib/es/json/ml.put_data_frame_analytics.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.put_data_frame_analytics", "description": "Create a data frame analytics job.\n\nThis API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.\nBy default, the query used in the source configuration is `{\"match_all\": {}}`.\n\nIf the destination index does not exist, it is created automatically when you start the job.\n\nIf you supply only a subset of the regression or classification parameters, hyperparameter optimization occurs. It determines a value for each of the undefined parameters.", "x-api": { "id": "ml.put_data_frame_analytics", "name": "put-data-frame-analytics", "namespace": "ml" }, "x-method": "PUT", "x-path": "/_ml/data_frame/analytics/{id}", "x-urls": [{ "path": "/_ml/data_frame/analytics/{id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.3.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "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. If\nset to `false` and a machine learning node with capacity to run the job\ncannot be immediately found, the API returns an error. If set to `true`,\nthe API does not return an error; the job waits in the `starting` state\nuntil sufficient machine learning node capacity is available. This\nbehavior is also affected by the cluster-wide\n`xpack.ml.max_lazy_ml_nodes` setting.", "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" }, "analyzed_fields": { "$ref": "./ml._types.json#/$defs/ml._types__DataframeAnalysisAnalyzedFields", "description": "Specifies `includes` and/or `excludes` patterns to select which fields\nwill be included in the analysis. The patterns specified in `excludes`\nare applied last, therefore `excludes` takes precedence. In other words,\nif the same field is specified in both `includes` and `excludes`, then\nthe field will not be included in the analysis. If `analyzed_fields` is\nnot set, only the relevant fields will be included. For example, all the\nnumeric fields for outlier detection.\nThe supported fields vary for each type of analysis. Outlier detection\nrequires numeric or `boolean` data to analyze. The algorithms don’t\nsupport missing values therefore fields that have data types other than\nnumeric or boolean are ignored. Documents where included fields contain\nmissing values, null values, or an array are also ignored. Therefore the\n`dest` index may contain documents that don’t have an outlier score.\nRegression supports fields that are numeric, `boolean`, `text`,\n`keyword`, and `ip` data types. It is also tolerant of missing values.\nFields that are supported are included in the analysis, other fields are\nignored. Documents where included fields contain an array with two or\nmore values are also ignored. Documents in the `dest` index that don’t\ncontain a results field are not included in the regression analysis.\nClassification supports fields that are numeric, `boolean`, `text`,\n`keyword`, and `ip` data types. It is also tolerant of missing values.\nFields that are supported are included in the analysis, other fields are\nignored. Documents where included fields contain an array with two or\nmore values are also ignored. Documents in the `dest` index that don’t\ncontain a results field are not included in the classification analysis.\nClassification analysis can be improved by mapping ordinal variable\nvalues to a single number. For example, in case of age ranges, you can\nmodel the values as `0-14 = 0`, `15-24 = 1`, `25-34 = 2`, and so on.", "x-found-in": "body" }, "description": { "type": "string", "description": "A description of the job.", "x-found-in": "body" }, "dest": { "$ref": "./ml._types.json#/$defs/ml._types__DataframeAnalyticsDestination", "description": "The destination configuration.", "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" }, "_meta": { "$ref": "./_types.json#/$defs/_types__Metadata", "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\nto create data frame analytics jobs that have `model_memory_limit` values\ngreater than that setting.", "x-found-in": "body" }, "source": { "$ref": "./ml._types.json#/$defs/ml._types__DataframeAnalyticsSource", "description": "The configuration of how to source the analysis data.", "x-found-in": "body" }, "headers": { "$ref": "./_types.json#/$defs/_types__HttpHeaders", "x-found-in": "body", "x-availability": { "stack": { "since": "8.0.0" }, "serverless": {} } }, "version": { "type": "string", "x-found-in": "body", "x-availability": { "stack": { "since": "7.16.0" }, "serverless": {} } }, "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" } }, "required": ["id", "analysis", "dest", "source"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.put_data_frame_analytics", "description": "Create a data frame analytics job.\n\nThis API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.\nBy default, the query used in the source configuration is `{\"match_all\": {}}`.\n\nIf the destination index does not exist, it is created automatically when you start the job.\n\nIf you supply only a subset of the regression or classification parameters, hyperparameter optimization occurs. It determines a value for each of the undefined parameters.", "x-api": { "id": "ml.put_data_frame_analytics", "name": "put-data-frame-analytics", "namespace": "ml" }, "x-method": "PUT", "x-path": "/_ml/data_frame/analytics/{id}", "x-urls": [{ "path": "/_ml/data_frame/analytics/{id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.3.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "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. If\nset to `false` and a machine learning node with capacity to run the job\ncannot be immediately found, the API returns an error. If set to `true`,\nthe API does not return an error; the job waits in the `starting` state\nuntil sufficient machine learning node capacity is available. This\nbehavior is also affected by the cluster-wide\n`xpack.ml.max_lazy_ml_nodes` setting.", "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" }, "analyzed_fields": { "$ref": "./ml._types.json#/$defs/ml._types__DataframeAnalysisAnalyzedFields", "description": "Specifies `includes` and/or `excludes` patterns to select which fields\nwill be included in the analysis. The patterns specified in `excludes`\nare applied last, therefore `excludes` takes precedence. In other words,\nif the same field is specified in both `includes` and `excludes`, then\nthe field will not be included in the analysis. If `analyzed_fields` is\nnot set, only the relevant fields will be included. For example, all the\nnumeric fields for outlier detection.\nThe supported fields vary for each type of analysis. Outlier detection\nrequires numeric or `boolean` data to analyze. The algorithms don’t\nsupport missing values therefore fields that have data types other than\nnumeric or boolean are ignored. Documents where included fields contain\nmissing values, null values, or an array are also ignored. Therefore the\n`dest` index may contain documents that don’t have an outlier score.\nRegression supports fields that are numeric, `boolean`, `text`,\n`keyword`, and `ip` data types. It is also tolerant of missing values.\nFields that are supported are included in the analysis, other fields are\nignored. Documents where included fields contain an array with two or\nmore values are also ignored. Documents in the `dest` index that don’t\ncontain a results field are not included in the regression analysis.\nClassification supports fields that are numeric, `boolean`, `text`,\n`keyword`, and `ip` data types. It is also tolerant of missing values.\nFields that are supported are included in the analysis, other fields are\nignored. Documents where included fields contain an array with two or\nmore values are also ignored. Documents in the `dest` index that don’t\ncontain a results field are not included in the classification analysis.\nClassification analysis can be improved by mapping ordinal variable\nvalues to a single number. For example, in case of age ranges, you can\nmodel the values as `0-14 = 0`, `15-24 = 1`, `25-34 = 2`, and so on.", "x-found-in": "body" }, "description": { "type": "string", "description": "A description of the job.", "x-found-in": "body" }, "dest": { "$ref": "./ml._types.json#/$defs/ml._types__DataframeAnalyticsDestination", "description": "The destination configuration.", "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" }, "_meta": { "$ref": "./_types.json#/$defs/_types__Metadata", "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\nto create data frame analytics jobs that have `model_memory_limit` values\ngreater than that setting.", "x-found-in": "body" }, "source": { "$ref": "./ml._types.json#/$defs/ml._types__DataframeAnalyticsSource", "description": "The configuration of how to source the analysis data.", "x-found-in": "body" }, "headers": { "$ref": "./_types.json#/$defs/_types__HttpHeaders", "x-found-in": "body", "x-availability": { "stack": { "since": "8.0.0" }, "serverless": {} } }, "version": { "type": "string", "x-found-in": "body", "x-availability": { "stack": { "since": "7.16.0" }, "serverless": {} } }, "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" } }, "required": ["id", "analysis", "dest", "source"] }

package/lib/es/json/ml.put_datafeed.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.put_datafeed", "description": "Create a datafeed.\n\nDatafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.\nYou can associate only one datafeed with each anomaly detection job.\nThe datafeed contains a query that runs at a defined interval (`frequency`).\nIf you are concerned about delayed data, you can add a delay (`query_delay') at each interval.\nBy default, the datafeed uses the following query: `{\"match_all\": {\"boost\": 1}}`.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had\nat the time of creation and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.\nYou must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed\ndirectly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index.", "x-api": { "id": "ml.put_datafeed", "name": "put-datafeed", "namespace": "ml" }, "x-method": "PUT", "x-path": "/_ml/datafeeds/{datafeed_id}", "x-urls": [{ "path": "/_ml/datafeeds/{datafeed_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines\nwhether wildcard expressions match hidden data streams. Supports comma-separated values.", "x-found-in": "query" }, "ignore_throttled": { "type": "boolean", "description": "If true, concrete, expanded, or aliased indices are ignored when frozen.", "x-found-in": "query", "x-deprecated": { "since": "7.16.0" } }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "aggregations": { "type": "object", "additionalProperties": { "$ref": "./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer" }, "description": "If set, the datafeed performs aggregation searches.\nSupport for aggregations is limited and should be used only with low cardinality data.", "x-found-in": "body" }, "chunking_config": { "$ref": "./ml._types.json#/$defs/ml._types__ChunkingConfig", "description": "Datafeeds might be required to search over long time periods, for several months or years.\nThis search is split into time chunks in order to ensure the load on Elasticsearch is managed.\nChunking configuration controls how the size of these time chunks are calculated;\nit is an advanced configuration option.", "x-found-in": "body" }, "delayed_data_check_config": { "$ref": "./ml._types.json#/$defs/ml._types__DelayedDataCheckConfig", "description": "Specifies whether the datafeed checks for missing data and the size of the window.\nThe datafeed can optionally search over indices that have already been read in an effort to determine whether\nany data has subsequently been added to the index. If missing data is found, it is a good indication that the\n`query_delay` is set too low and the data is being indexed after the datafeed has passed that moment in time.\nThis check runs only on real-time datafeeds.", "x-found-in": "body" }, "frequency": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The interval at which scheduled queries are made while the datafeed runs in real time.\nThe default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible\nfraction of the bucket span. When `frequency` is shorter than the bucket span, interim results for the last\n(partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses\naggregations, this value must be divisible by the interval of the date histogram aggregation.", "x-found-in": "body" }, "indices": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the master\nnodes and the machine learning nodes must have the `remote_cluster_client` role.", "x-found-in": "body" }, "indices_options": { "$ref": "./_types.json#/$defs/_types__IndicesOptions", "description": "Specifies index expansion options that are used during search", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "body" }, "max_empty_searches": { "type": "number", "description": "If a real-time datafeed has never seen any data (including during any initial training period), it automatically\nstops and closes the associated job after this many real-time searches return no documents. In other words,\nit stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no\nend time that sees no data remains started until it is explicitly stopped. By default, it is not set.", "x-found-in": "body" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an\nElasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this\nobject is passed verbatim to Elasticsearch.", "x-found-in": "body" }, "query_delay": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might\nnot be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default\nvalue is randomly selected between `60s` and `120s`. This randomness improves the query performance\nwhen there are multiple jobs running on the same node.", "x-found-in": "body" }, "runtime_mappings": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__RuntimeFields", "description": "Specifies runtime fields for the datafeed search.", "x-found-in": "body" }, "script_fields": { "type": "object", "additionalProperties": { "$ref": "./_types.json#/$defs/_types__ScriptField" }, "description": "Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.\nThe detector configuration objects in a job can contain functions that use these script fields.", "x-found-in": "body" }, "scroll_size": { "type": "number", "description": "The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations.\nThe maximum value is the value of `index.max_result_window`, which is 10,000 by default.", "x-found-in": "body" }, "headers": { "$ref": "./_types.json#/$defs/_types__HttpHeaders", "x-found-in": "body", "x-availability": { "stack": { "since": "8.0.0" }, "serverless": {} } }, "datafeed_id": { "type": "string", "description": "A numerical character string that uniquely identifies the datafeed.\nThis identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.\nIt must start and end with alphanumeric characters.", "x-found-in": "path" } }, "required": ["datafeed_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.put_datafeed", "description": "Create a datafeed.\n\nDatafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.\nYou can associate only one datafeed with each anomaly detection job.\nThe datafeed contains a query that runs at a defined interval (`frequency`).\nIf you are concerned about delayed data, you can add a delay (`query_delay') at each interval.\nBy default, the datafeed uses the following query: `{\"match_all\": {\"boost\": 1}}`.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had\nat the time of creation and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.\nYou must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed\ndirectly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index.", "x-api": { "id": "ml.put_datafeed", "name": "put-datafeed", "namespace": "ml" }, "x-method": "PUT", "x-path": "/_ml/datafeeds/{datafeed_id}", "x-urls": [{ "path": "/_ml/datafeeds/{datafeed_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines\nwhether wildcard expressions match hidden data streams. Supports comma-separated values.", "x-found-in": "query" }, "ignore_throttled": { "type": "boolean", "description": "If true, concrete, expanded, or aliased indices are ignored when frozen.", "x-found-in": "query", "x-deprecated": { "since": "7.16.0" } }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "aggregations": { "type": "object", "additionalProperties": { "$ref": "./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer" }, "description": "If set, the datafeed performs aggregation searches.\nSupport for aggregations is limited and should be used only with low cardinality data.", "x-found-in": "body" }, "chunking_config": { "$ref": "./ml._types.json#/$defs/ml._types__ChunkingConfig", "description": "Datafeeds might be required to search over long time periods, for several months or years.\nThis search is split into time chunks in order to ensure the load on Elasticsearch is managed.\nChunking configuration controls how the size of these time chunks are calculated;\nit is an advanced configuration option.", "x-found-in": "body" }, "delayed_data_check_config": { "$ref": "./ml._types.json#/$defs/ml._types__DelayedDataCheckConfig", "description": "Specifies whether the datafeed checks for missing data and the size of the window.\nThe datafeed can optionally search over indices that have already been read in an effort to determine whether\nany data has subsequently been added to the index. If missing data is found, it is a good indication that the\n`query_delay` is set too low and the data is being indexed after the datafeed has passed that moment in time.\nThis check runs only on real-time datafeeds.", "x-found-in": "body" }, "frequency": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The interval at which scheduled queries are made while the datafeed runs in real time.\nThe default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible\nfraction of the bucket span. When `frequency` is shorter than the bucket span, interim results for the last\n(partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses\naggregations, this value must be divisible by the interval of the date histogram aggregation.", "x-found-in": "body" }, "indices": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the master\nnodes and the machine learning nodes must have the `remote_cluster_client` role.", "x-found-in": "body" }, "indices_options": { "$ref": "./_types.json#/$defs/_types__IndicesOptions", "description": "Specifies index expansion options that are used during search", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "body" }, "max_empty_searches": { "type": "number", "description": "If a real-time datafeed has never seen any data (including during any initial training period), it automatically\nstops and closes the associated job after this many real-time searches return no documents. In other words,\nit stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no\nend time that sees no data remains started until it is explicitly stopped. By default, it is not set.", "x-found-in": "body" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an\nElasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this\nobject is passed verbatim to Elasticsearch.", "x-found-in": "body" }, "query_delay": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might\nnot be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default\nvalue is randomly selected between `60s` and `120s`. This randomness improves the query performance\nwhen there are multiple jobs running on the same node.", "x-found-in": "body" }, "runtime_mappings": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__RuntimeFields", "description": "Specifies runtime fields for the datafeed search.", "x-found-in": "body" }, "script_fields": { "type": "object", "additionalProperties": { "$ref": "./_types.json#/$defs/_types__ScriptField" }, "description": "Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.\nThe detector configuration objects in a job can contain functions that use these script fields.", "x-found-in": "body" }, "scroll_size": { "type": "number", "description": "The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations.\nThe maximum value is the value of `index.max_result_window`, which is 10,000 by default.", "x-found-in": "body" }, "headers": { "$ref": "./_types.json#/$defs/_types__HttpHeaders", "x-found-in": "body", "x-availability": { "stack": { "since": "8.0.0" }, "serverless": {} } }, "datafeed_id": { "type": "string", "description": "A numerical character string that uniquely identifies the datafeed.\nThis identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.\nIt must start and end with alphanumeric characters.", "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": ["datafeed_id"] }

package/lib/es/json/ml.put_filter.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.put_filter", "description": "Create a filter.\n\nA filter contains a list of strings. It can be used by one or more anomaly detection jobs.\nSpecifically, filters are referenced in the `custom_rules` property of detector configuration objects.", "x-api": { "id": "ml.put_filter", "name": "put-filter", "namespace": "ml" }, "x-method": "PUT", "x-path": "/_ml/filters/{filter_id}", "x-urls": [{ "path": "/_ml/filters/{filter_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "description": { "type": "string", "description": "A description of the filter.", "x-found-in": "body" }, "items": { "type": "array", "items": { "type": "string" }, "description": "The items of the filter. A wildcard `*` can be used at the beginning or the end of an item.\nUp to 10000 items are allowed in each filter.", "x-found-in": "body" }, "filter_id": { "type": "string", "description": "A string that uniquely identifies a filter.", "x-found-in": "path" } }, "required": ["filter_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.put_filter", "description": "Create a filter.\n\nA filter contains a list of strings. It can be used by one or more anomaly detection jobs.\nSpecifically, filters are referenced in the `custom_rules` property of detector configuration objects.", "x-api": { "id": "ml.put_filter", "name": "put-filter", "namespace": "ml" }, "x-method": "PUT", "x-path": "/_ml/filters/{filter_id}", "x-urls": [{ "path": "/_ml/filters/{filter_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "description": { "type": "string", "description": "A description of the filter.", "x-found-in": "body" }, "items": { "type": "array", "items": { "type": "string" }, "description": "The items of the filter. A wildcard `*` can be used at the beginning or the end of an item.\nUp to 10000 items are allowed in each filter.", "x-found-in": "body" }, "filter_id": { "type": "string", "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" } }, "required": ["filter_id"] }

package/lib/es/json/ml.put_job.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.put_job", "description": "Create an anomaly detection job.\n\nIf you include a `datafeed_config`, you must have read index privileges on the source index.\nIf you include a `datafeed_config` but do not provide a query, the datafeed uses `{\"match_all\": {\"boost\": 1}}`.", "x-api": { "id": "ml.put_job", "name": "put-job", "namespace": "ml" }, "x-method": "PUT", "x-path": "/_ml/anomaly_detectors/{job_id}", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines\nwhether wildcard expressions match hidden data streams. Supports comma-separated values.", "x-found-in": "query" }, "ignore_throttled": { "type": "boolean", "description": "If `true`, concrete, expanded or aliased indices are ignored when frozen.", "x-found-in": "query", "x-deprecated": { "since": "7.16.0" } }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "allow_lazy_open": { "type": "boolean", "description": "Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available.", "x-found-in": "body" }, "analysis_config": { "$ref": "./ml._types.json#/$defs/ml._types__AnalysisConfig", "description": "Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.", "x-found-in": "body" }, "analysis_limits": { "$ref": "./ml._types.json#/$defs/ml._types__AnalysisLimits", "description": "Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes.", "x-found-in": "body" }, "background_persist_interval": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the `background_persist_interval` value too low.", "x-found-in": "body" }, "custom_settings": { "$ref": "./ml._types.json#/$defs/ml._types__CustomSettings", "description": "Advanced configuration option. Contains custom meta data about the job.", "x-found-in": "body" }, "daily_model_snapshot_retention_after_days": { "type": "number", "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to `model_snapshot_retention_days`.", "x-found-in": "body" }, "data_description": { "$ref": "./ml._types.json#/$defs/ml._types__DataDescription", "description": "Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained.", "x-found-in": "body" }, "datafeed_config": { "$ref": "./ml._types.json#/$defs/ml._types__DatafeedConfig", "description": "Defines a datafeed for the anomaly detection job. If Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead.", "x-found-in": "body" }, "description": { "type": "string", "description": "A description of the job.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", "x-found-in": "path" }, "groups": { "type": "array", "items": { "type": "string" }, "description": "A list of job groups. A job can belong to no groups or many.", "x-found-in": "body" }, "model_plot_config": { "$ref": "./ml._types.json#/$defs/ml._types__ModelPlotConfig", "description": "This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced.", "x-found-in": "body" }, "model_snapshot_retention_days": { "type": "number", "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted.", "x-found-in": "body" }, "renormalization_window_days": { "type": "number", "description": "Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans.", "x-found-in": "body" }, "results_index_name": { "type": "string", "description": "A text string that affects the name of the machine learning results index. By default, the job generates an index named `.ml-anomalies-shared`.", "x-found-in": "body" }, "results_retention_days": { "type": "number", "description": "Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever.", "x-found-in": "body" } }, "required": ["job_id", "analysis_config", "data_description"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.put_job", "description": "Create an anomaly detection job.\n\nIf you include a `datafeed_config`, you must have read index privileges on the source index.\nIf you include a `datafeed_config` but do not provide a query, the datafeed uses `{\"match_all\": {\"boost\": 1}}`.", "x-api": { "id": "ml.put_job", "name": "put-job", "namespace": "ml" }, "x-method": "PUT", "x-path": "/_ml/anomaly_detectors/{job_id}", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "allow_no_indices": { "type": "boolean", "description": "A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines\nwhether wildcard expressions match hidden data streams. Supports comma-separated values.", "x-found-in": "query" }, "ignore_throttled": { "type": "boolean", "description": "If `true`, concrete, expanded or aliased indices are ignored when frozen.", "x-found-in": "query", "x-deprecated": { "since": "7.16.0" } }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.", "x-found-in": "query" }, "allow_lazy_open": { "type": "boolean", "description": "Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available.", "x-found-in": "body" }, "analysis_config": { "$ref": "./ml._types.json#/$defs/ml._types__AnalysisConfig", "description": "Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.", "x-found-in": "body" }, "analysis_limits": { "$ref": "./ml._types.json#/$defs/ml._types__AnalysisLimits", "description": "Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes.", "x-found-in": "body" }, "background_persist_interval": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the `background_persist_interval` value too low.", "x-found-in": "body" }, "custom_settings": { "$ref": "./ml._types.json#/$defs/ml._types__CustomSettings", "description": "Advanced configuration option. Contains custom meta data about the job.", "x-found-in": "body" }, "daily_model_snapshot_retention_after_days": { "type": "number", "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to `model_snapshot_retention_days`.", "x-found-in": "body" }, "data_description": { "$ref": "./ml._types.json#/$defs/ml._types__DataDescription", "description": "Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained.", "x-found-in": "body" }, "datafeed_config": { "$ref": "./ml._types.json#/$defs/ml._types__DatafeedConfig", "description": "Defines a datafeed for the anomaly detection job. If Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead.", "x-found-in": "body" }, "description": { "type": "string", "description": "A description of the job.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", "x-found-in": "path" }, "groups": { "type": "array", "items": { "type": "string" }, "description": "A list of job groups. A job can belong to no groups or many.", "x-found-in": "body" }, "model_plot_config": { "$ref": "./ml._types.json#/$defs/ml._types__ModelPlotConfig", "description": "This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced.", "x-found-in": "body" }, "model_snapshot_retention_days": { "type": "number", "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted.", "x-found-in": "body" }, "renormalization_window_days": { "type": "number", "description": "Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans.", "x-found-in": "body" }, "results_index_name": { "type": "string", "description": "A text string that affects the name of the machine learning results index. By default, the job generates an index named `.ml-anomalies-shared`.", "x-found-in": "body" }, "results_retention_days": { "type": "number", "description": "Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever.", "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": ["job_id", "analysis_config", "data_description"] }

package/lib/es/json/ml.put_trained_model.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.put_trained_model", "description": "Create a trained model.\n\nEnable you to supply a trained model that is not created by data frame analytics.", "x-api": { "id": "ml.put_trained_model", "name": "put-trained-model", "namespace": "ml" }, "x-method": "PUT", "x-path": "/_ml/trained_models/{model_id}", "x-urls": [{ "path": "/_ml/trained_models/{model_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.10.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "defer_definition_decompression": { "type": "boolean", "description": "If set to `true` and a `compressed_definition` is provided,\nthe request defers definition decompression and skips relevant\nvalidations.", "x-found-in": "query", "x-availability": { "stack": { "since": "8.0.0" }, "serverless": {} } }, "wait_for_completion": { "type": "boolean", "description": "Whether to wait for all child operations (e.g. model download)\nto complete.", "x-found-in": "query", "x-availability": { "stack": { "since": "8.8.0" }, "serverless": {} } }, "compressed_definition": { "type": "string", "description": "The compressed (GZipped and Base64 encoded) inference definition of the\nmodel. If compressed_definition is specified, then definition cannot be\nspecified.", "x-found-in": "body" }, "definition": { "$ref": "./ml.put_trained_model.json#/$defs/ml.put_trained_model__Definition", "description": "The inference definition for the model. If definition is specified, then\ncompressed_definition cannot be specified.", "x-found-in": "body" }, "description": { "type": "string", "description": "A human-readable description of the inference trained model.", "x-found-in": "body" }, "inference_config": { "$ref": "./ml._types.json#/$defs/ml._types__InferenceConfigCreateContainer", "description": "The default configuration for inference. This can be either a regression\nor classification configuration. It must match the underlying\ndefinition.trained_model's target_type. For pre-packaged models such as\nELSER the config is not required.", "x-found-in": "body" }, "input": { "$ref": "./ml.put_trained_model.json#/$defs/ml.put_trained_model__Input", "description": "The input field names for the model definition.", "x-found-in": "body" }, "metadata": { "description": "An object map that contains metadata about the model.", "x-found-in": "body" }, "model_type": { "$ref": "./ml._types.json#/$defs/ml._types__TrainedModelType", "description": "The model type.", "x-found-in": "body" }, "model_size_bytes": { "type": "number", "description": "The estimated memory usage in bytes to keep the trained model in memory.\nThis property is supported only if defer_definition_decompression is true\nor the model definition is not supplied.", "x-found-in": "body" }, "platform_architecture": { "type": "string", "description": "The platform architecture (if applicable) of the trained mode. If the model\nonly works on one platform, because it is heavily optimized for a particular\nprocessor architecture and OS combination, then this field specifies which.\nThe format of the string must match the platform identifiers used by Elasticsearch,\nso one of, `linux-x86_64`, `linux-aarch64`, `darwin-aarch64`,\nor `windows-x86_64`. For portable models (those that work independent of processor\narchitecture or OS features), leave this field unset.", "x-found-in": "body" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "An array of tags to organize the model.", "x-found-in": "body" }, "prefix_strings": { "$ref": "./ml._types.json#/$defs/ml._types__TrainedModelPrefixStrings", "description": "Optional prefix strings applied at inference", "x-found-in": "body", "x-availability": { "stack": { "since": "8.12.0" }, "serverless": {} } }, "model_id": { "type": "string", "description": "The unique identifier of the trained model.", "x-found-in": "path" } }, "required": ["model_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.put_trained_model", "description": "Create a trained model.\n\nEnable you to supply a trained model that is not created by data frame analytics.", "x-api": { "id": "ml.put_trained_model", "name": "put-trained-model", "namespace": "ml" }, "x-method": "PUT", "x-path": "/_ml/trained_models/{model_id}", "x-urls": [{ "path": "/_ml/trained_models/{model_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.10.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "defer_definition_decompression": { "type": "boolean", "description": "If set to `true` and a `compressed_definition` is provided,\nthe request defers definition decompression and skips relevant\nvalidations.", "x-found-in": "query", "x-availability": { "stack": { "since": "8.0.0" }, "serverless": {} } }, "wait_for_completion": { "type": "boolean", "description": "Whether to wait for all child operations (e.g. model download)\nto complete.", "x-found-in": "query", "x-availability": { "stack": { "since": "8.8.0" }, "serverless": {} } }, "compressed_definition": { "type": "string", "description": "The compressed (GZipped and Base64 encoded) inference definition of the\nmodel. If compressed_definition is specified, then definition cannot be\nspecified.", "x-found-in": "body" }, "definition": { "$ref": "./ml.put_trained_model.json#/$defs/ml.put_trained_model__Definition", "description": "The inference definition for the model. If definition is specified, then\ncompressed_definition cannot be specified.", "x-found-in": "body" }, "description": { "type": "string", "description": "A human-readable description of the inference trained model.", "x-found-in": "body" }, "inference_config": { "$ref": "./ml._types.json#/$defs/ml._types__InferenceConfigCreateContainer", "description": "The default configuration for inference. This can be either a regression\nor classification configuration. It must match the underlying\ndefinition.trained_model's target_type. For pre-packaged models such as\nELSER the config is not required.", "x-found-in": "body" }, "input": { "$ref": "./ml.put_trained_model.json#/$defs/ml.put_trained_model__Input", "description": "The input field names for the model definition.", "x-found-in": "body" }, "metadata": { "description": "An object map that contains metadata about the model.", "x-found-in": "body" }, "model_type": { "$ref": "./ml._types.json#/$defs/ml._types__TrainedModelType", "description": "The model type.", "x-found-in": "body" }, "model_size_bytes": { "type": "number", "description": "The estimated memory usage in bytes to keep the trained model in memory.\nThis property is supported only if defer_definition_decompression is true\nor the model definition is not supplied.", "x-found-in": "body" }, "platform_architecture": { "type": "string", "description": "The platform architecture (if applicable) of the trained mode. If the model\nonly works on one platform, because it is heavily optimized for a particular\nprocessor architecture and OS combination, then this field specifies which.\nThe format of the string must match the platform identifiers used by Elasticsearch,\nso one of, `linux-x86_64`, `linux-aarch64`, `darwin-aarch64`,\nor `windows-x86_64`. For portable models (those that work independent of processor\narchitecture or OS features), leave this field unset.", "x-found-in": "body" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "An array of tags to organize the model.", "x-found-in": "body" }, "prefix_strings": { "$ref": "./ml._types.json#/$defs/ml._types__TrainedModelPrefixStrings", "description": "Optional prefix strings applied at inference", "x-found-in": "body", "x-availability": { "stack": { "since": "8.12.0" }, "serverless": {} } }, "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"] }

package/lib/es/json/ml.put_trained_model_alias.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.put_trained_model_alias", "description": "Create or update a trained model alias.\n\nA trained model alias is a logical name used to reference a single trained\nmodel.\nYou can use aliases instead of trained model identifiers to make it easier to\nreference your models. For example, you can use aliases in inference\naggregations and processors.\nAn alias must be unique and refer to only a single trained model. However,\nyou can have multiple aliases for each trained model.\nIf you use this API to update an alias such that it references a different\ntrained model ID and the model uses a different type of data frame analytics,\nan error occurs. For example, this situation occurs if you have a trained\nmodel for regression analysis and a trained model for classification\nanalysis; you cannot reassign an alias from one type of trained model to\nanother.\nIf you use this API to update an alias and there are very few input fields in\ncommon between the old and new trained models for the model alias, the API\nreturns a warning.", "x-api": { "id": "ml.put_trained_model_alias", "name": "put-trained-model-alias", "namespace": "ml" }, "x-method": "PUT", "x-path": "/_ml/trained_models/{model_id}/model_aliases/{model_alias}", "x-urls": [{ "path": "/_ml/trained_models/{model_id}/model_aliases/{model_alias}", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.13.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "reassign": { "type": "boolean", "description": "Specifies whether the alias gets reassigned to the specified trained\nmodel if it is already assigned to a different model. If the alias is\nalready assigned and this parameter is false, the API returns an error.", "x-found-in": "query" }, "model_alias": { "type": "string", "description": "The alias to create or update. This value cannot end in numbers.", "x-found-in": "path" }, "model_id": { "type": "string", "description": "The identifier for the trained model that the alias refers to.", "x-found-in": "path" } }, "required": ["model_alias", "model_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.put_trained_model_alias", "description": "Create or update a trained model alias.\n\nA trained model alias is a logical name used to reference a single trained\nmodel.\nYou can use aliases instead of trained model identifiers to make it easier to\nreference your models. For example, you can use aliases in inference\naggregations and processors.\nAn alias must be unique and refer to only a single trained model. However,\nyou can have multiple aliases for each trained model.\nIf you use this API to update an alias such that it references a different\ntrained model ID and the model uses a different type of data frame analytics,\nan error occurs. For example, this situation occurs if you have a trained\nmodel for regression analysis and a trained model for classification\nanalysis; you cannot reassign an alias from one type of trained model to\nanother.\nIf you use this API to update an alias and there are very few input fields in\ncommon between the old and new trained models for the model alias, the API\nreturns a warning.", "x-api": { "id": "ml.put_trained_model_alias", "name": "put-trained-model-alias", "namespace": "ml" }, "x-method": "PUT", "x-path": "/_ml/trained_models/{model_id}/model_aliases/{model_alias}", "x-urls": [{ "path": "/_ml/trained_models/{model_id}/model_aliases/{model_alias}", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.13.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "reassign": { "type": "boolean", "description": "Specifies whether the alias gets reassigned to the specified trained\nmodel if it is already assigned to a different model. If the alias is\nalready assigned and this parameter is false, the API returns an error.", "x-found-in": "query" }, "model_alias": { "type": "string", "description": "The alias to create or update. This value cannot end in numbers.", "x-found-in": "path" }, "model_id": { "type": "string", "description": "The identifier for the trained model that the alias refers to.", "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_alias", "model_id"] }

package/lib/es/json/ml.put_trained_model_definition_part.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.put_trained_model_definition_part", "description": "Create part of a trained model definition.", "x-api": { "id": "ml.put_trained_model_definition_part", "name": "put-trained-model-definition-part", "namespace": "ml" }, "x-method": "PUT", "x-path": "/_ml/trained_models/{model_id}/definition/{part}", "x-urls": [{ "path": "/_ml/trained_models/{model_id}/definition/{part}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.0.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "definition": { "type": "string", "description": "The definition part for the model. Must be a base64 encoded string.", "x-found-in": "body" }, "total_definition_length": { "type": "number", "description": "The total uncompressed definition length in bytes. Not base64 encoded.", "x-found-in": "body" }, "total_parts": { "type": "number", "description": "The total number of parts that will be uploaded. Must be greater than 0.", "x-found-in": "body" }, "model_id": { "type": "string", "description": "The unique identifier of the trained model.", "x-found-in": "path" }, "part": { "type": "number", "description": "The definition part number. When the definition is loaded for inference the definition parts are streamed in the\norder of their part number. The first part must be `0` and the final part must be `total_parts - 1`.", "x-found-in": "path" } }, "required": ["model_id", "part", "definition", "total_definition_length", "total_parts"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.put_trained_model_definition_part", "description": "Create part of a trained model definition.", "x-api": { "id": "ml.put_trained_model_definition_part", "name": "put-trained-model-definition-part", "namespace": "ml" }, "x-method": "PUT", "x-path": "/_ml/trained_models/{model_id}/definition/{part}", "x-urls": [{ "path": "/_ml/trained_models/{model_id}/definition/{part}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.0.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "definition": { "type": "string", "description": "The definition part for the model. Must be a base64 encoded string.", "x-found-in": "body" }, "total_definition_length": { "type": "number", "description": "The total uncompressed definition length in bytes. Not base64 encoded.", "x-found-in": "body" }, "total_parts": { "type": "number", "description": "The total number of parts that will be uploaded. Must be greater than 0.", "x-found-in": "body" }, "model_id": { "type": "string", "description": "The unique identifier of the trained model.", "x-found-in": "path" }, "part": { "type": "number", "description": "The definition part number. When the definition is loaded for inference the definition parts are streamed in the\norder of their part number. The first part must be `0` and the final part must be `total_parts - 1`.", "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", "part", "definition", "total_definition_length", "total_parts"] }

package/lib/es/json/ml.put_trained_model_vocabulary.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.put_trained_model_vocabulary", "description": "Create a trained model vocabulary.\n\nThis API is supported only for natural language processing (NLP) models.\nThe vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.", "x-api": { "id": "ml.put_trained_model_vocabulary", "name": "put-trained-model-vocabulary", "namespace": "ml" }, "x-method": "PUT", "x-path": "/_ml/trained_models/{model_id}/vocabulary", "x-urls": [{ "path": "/_ml/trained_models/{model_id}/vocabulary", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.0.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "vocabulary": { "type": "array", "items": { "type": "string" }, "description": "The model vocabulary, which must not be empty.", "x-found-in": "body" }, "merges": { "type": "array", "items": { "type": "string" }, "description": "The optional model merges if required by the tokenizer.", "x-found-in": "body", "x-availability": { "stack": { "since": "8.2.0" }, "serverless": {} } }, "scores": { "type": "array", "items": { "type": "number" }, "description": "The optional vocabulary value scores if required by the tokenizer.", "x-found-in": "body", "x-availability": { "stack": { "since": "8.9.0" }, "serverless": {} } }, "model_id": { "type": "string", "description": "The unique identifier of the trained model.", "x-found-in": "path" } }, "required": ["model_id", "vocabulary"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.put_trained_model_vocabulary", "description": "Create a trained model vocabulary.\n\nThis API is supported only for natural language processing (NLP) models.\nThe vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.", "x-api": { "id": "ml.put_trained_model_vocabulary", "name": "put-trained-model-vocabulary", "namespace": "ml" }, "x-method": "PUT", "x-path": "/_ml/trained_models/{model_id}/vocabulary", "x-urls": [{ "path": "/_ml/trained_models/{model_id}/vocabulary", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.0.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "vocabulary": { "type": "array", "items": { "type": "string" }, "description": "The model vocabulary, which must not be empty.", "x-found-in": "body" }, "merges": { "type": "array", "items": { "type": "string" }, "description": "The optional model merges if required by the tokenizer.", "x-found-in": "body", "x-availability": { "stack": { "since": "8.2.0" }, "serverless": {} } }, "scores": { "type": "array", "items": { "type": "number" }, "description": "The optional vocabulary value scores if required by the tokenizer.", "x-found-in": "body", "x-availability": { "stack": { "since": "8.9.0" }, "serverless": {} } }, "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", "vocabulary"] }

package/lib/es/json/ml.reset_job.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.reset_job", "description": "Reset an anomaly detection job.\n\nAll model state and results are deleted. The job is ready to start over as if\nit had just been created.\nIt is not currently possible to reset multiple jobs using wildcards or a\ncomma separated list.", "x-api": { "id": "ml.reset_job", "name": "reset-job", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/anomaly_detectors/{job_id}/_reset", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/_reset", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.14.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "wait_for_completion": { "type": "boolean", "description": "Should this request wait until the operation has completed before\nreturning.", "x-found-in": "query" }, "delete_user_annotations": { "type": "boolean", "description": "Specifies whether annotations that have been added by the\nuser should be deleted along with any auto-generated annotations when the job is\nreset.", "x-found-in": "query" }, "job_id": { "type": "string", "description": "The ID of the job to reset.", "x-found-in": "path" } }, "required": ["job_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.reset_job", "description": "Reset an anomaly detection job.\n\nAll model state and results are deleted. The job is ready to start over as if\nit had just been created.\nIt is not currently possible to reset multiple jobs using wildcards or a\ncomma separated list.", "x-api": { "id": "ml.reset_job", "name": "reset-job", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/anomaly_detectors/{job_id}/_reset", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/_reset", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.14.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "wait_for_completion": { "type": "boolean", "description": "Should this request wait until the operation has completed before\nreturning.", "x-found-in": "query" }, "delete_user_annotations": { "type": "boolean", "description": "Specifies whether annotations that have been added by the\nuser should be deleted along with any auto-generated annotations when the job is\nreset.", "x-found-in": "query" }, "job_id": { "type": "string", "description": "The ID of the job to reset.", "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/es/json/ml.revert_model_snapshot.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.revert_model_snapshot", "description": "Revert to a snapshot.\n\nThe machine learning features react quickly to anomalous input, learning new\nbehaviors in data. Highly anomalous input increases the variance in the\nmodels whilst the system learns whether this is a new step-change in behavior\nor a one-off event. In the case where this anomalous input is known to be a\none-off, then it might be appropriate to reset the model state to a time\nbefore this event. For example, you might consider reverting to a saved\nsnapshot after Black Friday or a critical system failure.", "x-api": { "id": "ml.revert_model_snapshot", "name": "revert-model-snapshot", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_revert", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_revert", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "delete_intervening_results": { "type": "boolean", "description": "Refer to the description for the `delete_intervening_results` query parameter.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "snapshot_id": { "type": "string", "description": "You can specify `empty` as the <snapshot_id>. Reverting to the empty\nsnapshot means the anomaly detection job starts learning a new model from\nscratch when it is started.", "x-found-in": "path" } }, "required": ["job_id", "snapshot_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.revert_model_snapshot", "description": "Revert to a snapshot.\n\nThe machine learning features react quickly to anomalous input, learning new\nbehaviors in data. Highly anomalous input increases the variance in the\nmodels whilst the system learns whether this is a new step-change in behavior\nor a one-off event. In the case where this anomalous input is known to be a\none-off, then it might be appropriate to reset the model state to a time\nbefore this event. For example, you might consider reverting to a saved\nsnapshot after Black Friday or a critical system failure.", "x-api": { "id": "ml.revert_model_snapshot", "name": "revert-model-snapshot", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_revert", "x-urls": [{ "path": "/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_revert", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "delete_intervening_results": { "type": "boolean", "description": "Refer to the description for the `delete_intervening_results` query parameter.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "snapshot_id": { "type": "string", "description": "You can specify `empty` as the <snapshot_id>. Reverting to the empty\nsnapshot means the anomaly detection job starts learning a new model from\nscratch when it is started.", "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/es/json/ml.set_upgrade_mode.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.set_upgrade_mode", "description": "Set upgrade_mode for ML indices.\n\nSets a cluster wide upgrade_mode setting that prepares machine learning\nindices for an upgrade.\nWhen upgrading your cluster, in some circumstances you must restart your\nnodes and reindex your machine learning indices. In those circumstances,\nthere must be no machine learning jobs running. You can close the machine\nlearning jobs, do the upgrade, then open all the jobs again. Alternatively,\nyou can use this API to temporarily halt tasks associated with the jobs and\ndatafeeds and prevent new jobs from opening. You can also use this API\nduring upgrades that do not require you to reindex your machine learning\nindices, though stopping jobs is not a requirement in that case.\nYou can see the current value for the upgrade_mode setting by using the get\nmachine learning info API.", "x-api": { "id": "ml.set_upgrade_mode", "name": "set-upgrade-mode", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/set_upgrade_mode", "x-urls": [{ "path": "/_ml/set_upgrade_mode", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.7.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "enabled": { "type": "boolean", "description": "When `true`, it enables `upgrade_mode` which temporarily halts all job\nand datafeed tasks and prohibits new job and datafeed tasks from\nstarting.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The time to wait for the request to be completed.", "x-found-in": "query" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.set_upgrade_mode", "description": "Set upgrade_mode for ML indices.\n\nSets a cluster wide upgrade_mode setting that prepares machine learning\nindices for an upgrade.\nWhen upgrading your cluster, in some circumstances you must restart your\nnodes and reindex your machine learning indices. In those circumstances,\nthere must be no machine learning jobs running. You can close the machine\nlearning jobs, do the upgrade, then open all the jobs again. Alternatively,\nyou can use this API to temporarily halt tasks associated with the jobs and\ndatafeeds and prevent new jobs from opening. You can also use this API\nduring upgrades that do not require you to reindex your machine learning\nindices, though stopping jobs is not a requirement in that case.\nYou can see the current value for the upgrade_mode setting by using the get\nmachine learning info API.", "x-api": { "id": "ml.set_upgrade_mode", "name": "set-upgrade-mode", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/set_upgrade_mode", "x-urls": [{ "path": "/_ml/set_upgrade_mode", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.7.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "enabled": { "type": "boolean", "description": "When `true`, it enables `upgrade_mode` which temporarily halts all job\nand datafeed tasks and prohibits new job and datafeed tasks from\nstarting.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The time to wait for the request to be completed.", "x-found-in": "query" }, "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/es/json/ml.start_data_frame_analytics.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.start_data_frame_analytics", "description": "Start a data frame analytics job.\n\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.\nIf the destination index does not exist, it is created automatically the\nfirst time you start the data frame analytics job. The\n`index.number_of_shards` and `index.number_of_replicas` settings for the\ndestination index are copied from the source index. If there are multiple\nsource indices, the destination index copies the highest setting values. The\nmappings for the destination index are also copied from the source indices.\nIf there are any mapping conflicts, the job fails to start.\nIf the destination index exists, it is used as is. You can therefore set up\nthe destination index in advance with custom settings and mappings.", "x-api": { "id": "ml.start_data_frame_analytics", "name": "start-data-frame-analytics", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/data_frame/analytics/{id}/_start", "x-urls": [{ "path": "/_ml/data_frame/analytics/{id}/_start", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.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 until the data frame analytics job\nstarts.", "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" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.start_data_frame_analytics", "description": "Start a data frame analytics job.\n\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.\nIf the destination index does not exist, it is created automatically the\nfirst time you start the data frame analytics job. The\n`index.number_of_shards` and `index.number_of_replicas` settings for the\ndestination index are copied from the source index. If there are multiple\nsource indices, the destination index copies the highest setting values. The\nmappings for the destination index are also copied from the source indices.\nIf there are any mapping conflicts, the job fails to start.\nIf the destination index exists, it is used as is. You can therefore set up\nthe destination index in advance with custom settings and mappings.", "x-api": { "id": "ml.start_data_frame_analytics", "name": "start-data-frame-analytics", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/data_frame/analytics/{id}/_start", "x-urls": [{ "path": "/_ml/data_frame/analytics/{id}/_start", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.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 until the data frame analytics job\nstarts.", "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" } }, "required": ["id"] }

package/lib/es/json/ml.start_datafeed.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.start_datafeed", "description": "Start datafeeds.\n\nA datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.\n\nBefore you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.\n\nIf you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.\nIf new data was indexed for that exact millisecond between stopping and starting, it will be ignored.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or\nupdate it had at the time of creation or update and runs the query using those same roles. If you provided secondary\nauthorization headers when you created or updated the datafeed, those credentials are used instead.", "x-api": { "id": "ml.start_datafeed", "name": "start-datafeed", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/datafeeds/{datafeed_id}/_start", "x-urls": [{ "path": "/_ml/datafeeds/{datafeed_id}/_start", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `end` 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" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Refer to the description for the `timeout` query parameter.", "x-found-in": "body" }, "datafeed_id": { "type": "string", "description": "A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase\nalphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric\ncharacters.", "x-found-in": "path" } }, "required": ["datafeed_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.start_datafeed", "description": "Start datafeeds.\n\nA datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.\n\nBefore you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.\n\nIf you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.\nIf new data was indexed for that exact millisecond between stopping and starting, it will be ignored.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or\nupdate it had at the time of creation or update and runs the query using those same roles. If you provided secondary\nauthorization headers when you created or updated the datafeed, those credentials are used instead.", "x-api": { "id": "ml.start_datafeed", "name": "start-datafeed", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/datafeeds/{datafeed_id}/_start", "x-urls": [{ "path": "/_ml/datafeeds/{datafeed_id}/_start", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `end` 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" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Refer to the description for the `timeout` query parameter.", "x-found-in": "body" }, "datafeed_id": { "type": "string", "description": "A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase\nalphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric\ncharacters.", "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": ["datafeed_id"] }

package/lib/es/json/ml.start_trained_model_deployment.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.start_trained_model_deployment", "description": "Start a trained model deployment.\n\nIt allocates the model to every machine learning node.", "x-api": { "id": "ml.start_trained_model_deployment", "name": "start-trained-model-deployment", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/trained_models/{model_id}/deployment/_start", "x-urls": [{ "path": "/_ml/trained_models/{model_id}/deployment/_start", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.0.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "cache_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The inference cache size (in memory outside the JVM heap) per node for the model.\nThe default value is the same size as the `model_size_bytes`. To disable the cache,\n`0b` can be provided.", "x-found-in": "query" }, "deployment_id": { "type": "string", "description": "A unique identifier for the deployment of the model.", "x-found-in": "query", "x-availability": { "stack": { "since": "8.8.0" } } }, "number_of_allocations": { "type": "number", "description": "The number of model allocations on each node where the model is deployed.\nAll allocations on a node share the same copy of the model in memory but use\na separate set of threads to evaluate the model.\nIncreasing this value generally increases the throughput.\nIf this setting is greater than the number of hardware threads\nit will automatically be changed to a value less than the number of hardware threads.\nIf adaptive_allocations is enabled, do not set this value, because it’s automatically set.", "x-found-in": "query" }, "priority": { "$ref": "./ml._types.json#/$defs/ml._types__TrainingPriority", "description": "The deployment priority", "x-found-in": "query" }, "queue_capacity": { "type": "number", "description": "Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds\nthis value, new requests are rejected with a 429 error.", "x-found-in": "query" }, "threads_per_allocation": { "type": "number", "description": "Sets the number of threads used by each model allocation during inference. This generally increases\nthe inference speed. The inference process is a compute-bound process; any number\ngreater than the number of available hardware threads on the machine does not increase the\ninference speed. If this setting is greater than the number of hardware threads\nit will automatically be changed to a value less than the number of hardware threads.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the model to deploy.", "x-found-in": "query" }, "wait_for": { "$ref": "./ml._types.json#/$defs/ml._types__DeploymentAllocationState", "description": "Specifies the allocation status to wait for before returning.", "x-found-in": "query" }, "adaptive_allocations": { "$ref": "./ml._types.json#/$defs/ml._types__AdaptiveAllocationsSettings", "description": "Adaptive allocations configuration. When enabled, the number of allocations\nis set based on the current load.\nIf adaptive_allocations is enabled, do not set the number of allocations manually.", "x-found-in": "body" }, "model_id": { "type": "string", "description": "The unique identifier of the trained model. Currently, only PyTorch models are supported.", "x-found-in": "path" } }, "required": ["model_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.start_trained_model_deployment", "description": "Start a trained model deployment.\n\nIt allocates the model to every machine learning node.", "x-api": { "id": "ml.start_trained_model_deployment", "name": "start-trained-model-deployment", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/trained_models/{model_id}/deployment/_start", "x-urls": [{ "path": "/_ml/trained_models/{model_id}/deployment/_start", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.0.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "cache_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The inference cache size (in memory outside the JVM heap) per node for the model.\nThe default value is the same size as the `model_size_bytes`. To disable the cache,\n`0b` can be provided.", "x-found-in": "query" }, "deployment_id": { "type": "string", "description": "A unique identifier for the deployment of the model.", "x-found-in": "query", "x-availability": { "stack": { "since": "8.8.0" } } }, "number_of_allocations": { "type": "number", "description": "The number of model allocations on each node where the model is deployed.\nAll allocations on a node share the same copy of the model in memory but use\na separate set of threads to evaluate the model.\nIncreasing this value generally increases the throughput.\nIf this setting is greater than the number of hardware threads\nit will automatically be changed to a value less than the number of hardware threads.\nIf adaptive_allocations is enabled, do not set this value, because it’s automatically set.", "x-found-in": "query" }, "priority": { "$ref": "./ml._types.json#/$defs/ml._types__TrainingPriority", "description": "The deployment priority", "x-found-in": "query" }, "queue_capacity": { "type": "number", "description": "Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds\nthis value, new requests are rejected with a 429 error.", "x-found-in": "query" }, "threads_per_allocation": { "type": "number", "description": "Sets the number of threads used by each model allocation during inference. This generally increases\nthe inference speed. The inference process is a compute-bound process; any number\ngreater than the number of available hardware threads on the machine does not increase the\ninference speed. If this setting is greater than the number of hardware threads\nit will automatically be changed to a value less than the number of hardware threads.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the model to deploy.", "x-found-in": "query" }, "wait_for": { "$ref": "./ml._types.json#/$defs/ml._types__DeploymentAllocationState", "description": "Specifies the allocation status to wait for before returning.", "x-found-in": "query" }, "adaptive_allocations": { "$ref": "./ml._types.json#/$defs/ml._types__AdaptiveAllocationsSettings", "description": "Adaptive allocations configuration. When enabled, the number of allocations\nis set based on the current load.\nIf adaptive_allocations is enabled, do not set the number of allocations manually.", "x-found-in": "body" }, "model_id": { "type": "string", "description": "The unique identifier of the trained model. Currently, only PyTorch models are supported.", "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"] }

package/lib/es/json/ml.stop_data_frame_analytics.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.stop_data_frame_analytics", "description": "Stop data frame analytics jobs.\n\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.", "x-api": { "id": "ml.stop_data_frame_analytics", "name": "stop-data-frame-analytics", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/data_frame/analytics/{id}/_stop", "x-urls": [{ "path": "/_ml/data_frame/analytics/{id}/_stop", "methods": ["POST"] }], "x-destructive": true, "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 is true, which returns an empty data_frame_analytics\narray when there are no matches and the subset of results when there are\npartial matches. If this parameter is false, the request returns a 404\nstatus code when there are no matches or only partial matches.", "x-found-in": "body" }, "force": { "type": "boolean", "description": "If true, the data frame analytics job is stopped forcefully.", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Controls the amount of time to wait until the data frame analytics job\nstops. Defaults to 20 seconds.", "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" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.stop_data_frame_analytics", "description": "Stop data frame analytics jobs.\n\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.", "x-api": { "id": "ml.stop_data_frame_analytics", "name": "stop-data-frame-analytics", "namespace": "ml" }, "x-method": "POST", "x-path": "/_ml/data_frame/analytics/{id}/_stop", "x-urls": [{ "path": "/_ml/data_frame/analytics/{id}/_stop", "methods": ["POST"] }], "x-destructive": true, "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 is true, which returns an empty data_frame_analytics\narray when there are no matches and the subset of results when there are\npartial matches. If this parameter is false, the request returns a 404\nstatus code when there are no matches or only partial matches.", "x-found-in": "body" }, "force": { "type": "boolean", "description": "If true, the data frame analytics job is stopped forcefully.", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Controls the amount of time to wait until the data frame analytics job\nstops. Defaults to 20 seconds.", "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" } }, "required": ["id"] }