@elastic/schemas 0.5.1 → 0.6.0

package/src/es/json/ml.clear_trained_model_deployment_cache.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.clear_trained_model_deployment_cache","description":"Clear trained model deployment cache.\n\nCache will be cleared on all nodes where the trained model is assigned.\nA trained model deployment may have an inference cache enabled.\nAs requests are handled by each allocated node, their responses may be cached on that individual node.\nCalling this API clears the caches without restarting the deployment.","x-api":{"id":"ml.clear_trained_model_deployment_cache","name":"clear-trained-model-deployment-cache","namespace":"ml"},"x-method":"POST","x-path":"/_ml/trained_models/{model_id}/deployment/cache/_clear","x-urls":[{"path":"/_ml/trained_models/{model_id}/deployment/cache/_clear","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"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.clear_trained_model_deployment_cache","description":"Clear trained model deployment cache.\n\nCache will be cleared on all nodes where the trained model is assigned.\nA trained model deployment may have an inference cache enabled.\nAs requests are handled by each allocated node, their responses may be cached on that individual node.\nCalling this API clears the caches without restarting the deployment.","x-api":{"id":"ml.clear_trained_model_deployment_cache","name":"clear-trained-model-deployment-cache","namespace":"ml"},"x-method":"POST","x-path":"/_ml/trained_models/{model_id}/deployment/cache/_clear","x-urls":[{"path":"/_ml/trained_models/{model_id}/deployment/cache/_clear","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"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/src/es/json/ml.close_job.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.close_job","description":"Close anomaly detection jobs.\n\nA job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.\nWhen you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.\nIf you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.\nWhen a datafeed that has a specified end date stops, it automatically closes its associated job.","x-api":{"id":"ml.close_job","name":"close-job","namespace":"ml"},"x-method":"POST","x-path":"/_ml/anomaly_detectors/{job_id}/_close","x-urls":[{"path":"/_ml/anomaly_detectors/{job_id}/_close","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"5.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Refer to the description for the `allow_no_match` query parameter.","x-found-in":"body"},"force":{"type":"boolean","description":"Refer to the descriptiion for the `force` 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"},"job_id":{"type":"string","description":"Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can close all jobs by using `_all` or by specifying `*` as the job identifier.","x-found-in":"path"}},"required":["job_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.close_job","description":"Close anomaly detection jobs.\n\nA job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.\nWhen you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.\nIf you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.\nWhen a datafeed that has a specified end date stops, it automatically closes its associated job.","x-api":{"id":"ml.close_job","name":"close-job","namespace":"ml"},"x-method":"POST","x-path":"/_ml/anomaly_detectors/{job_id}/_close","x-urls":[{"path":"/_ml/anomaly_detectors/{job_id}/_close","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"5.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Refer to the description for the `allow_no_match` query parameter.","x-found-in":"body"},"force":{"type":"boolean","description":"Refer to the descriptiion for the `force` 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"},"job_id":{"type":"string","description":"Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can close all jobs by using `_all` or by specifying `*` as the job identifier.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["job_id"]}

package/src/es/json/ml.delete_calendar.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.delete_calendar","description":"Delete a calendar.\n\nRemove all scheduled events from a calendar, then delete it.","x-api":{"id":"ml.delete_calendar","name":"delete-calendar","namespace":"ml"},"x-method":"DELETE","x-path":"/_ml/calendars/{calendar_id}","x-urls":[{"path":"/_ml/calendars/{calendar_id}","methods":["DELETE"]}],"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"}},"required":["calendar_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.delete_calendar","description":"Delete a calendar.\n\nRemove all scheduled events from a calendar, then delete it.","x-api":{"id":"ml.delete_calendar","name":"delete-calendar","namespace":"ml"},"x-method":"DELETE","x-path":"/_ml/calendars/{calendar_id}","x-urls":[{"path":"/_ml/calendars/{calendar_id}","methods":["DELETE"]}],"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"},"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/src/es/json/ml.delete_calendar_event.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.delete_calendar_event","description":"Delete events from a calendar.","x-api":{"id":"ml.delete_calendar_event","name":"delete-calendar-event","namespace":"ml"},"x-method":"DELETE","x-path":"/_ml/calendars/{calendar_id}/events/{event_id}","x-urls":[{"path":"/_ml/calendars/{calendar_id}/events/{event_id}","methods":["DELETE"]}],"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"},"event_id":{"type":"string","description":"Identifier for the scheduled event.\nYou can obtain this identifier by using the get calendar events API.","x-found-in":"path"}},"required":["calendar_id","event_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.delete_calendar_event","description":"Delete events from a calendar.","x-api":{"id":"ml.delete_calendar_event","name":"delete-calendar-event","namespace":"ml"},"x-method":"DELETE","x-path":"/_ml/calendars/{calendar_id}/events/{event_id}","x-urls":[{"path":"/_ml/calendars/{calendar_id}/events/{event_id}","methods":["DELETE"]}],"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"},"event_id":{"type":"string","description":"Identifier for the scheduled event.\nYou can obtain this identifier by using the get calendar events API.","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","event_id"]}

package/src/es/json/ml.delete_calendar_job.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.delete_calendar_job","description":"Delete anomaly jobs from a calendar.","x-api":{"id":"ml.delete_calendar_job","name":"delete-calendar-job","namespace":"ml"},"x-method":"DELETE","x-path":"/_ml/calendars/{calendar_id}/jobs/{job_id}","x-urls":[{"path":"/_ml/calendars/{calendar_id}/jobs/{job_id}","methods":["DELETE"]}],"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\ncomma-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.delete_calendar_job","description":"Delete anomaly jobs from a calendar.","x-api":{"id":"ml.delete_calendar_job","name":"delete-calendar-job","namespace":"ml"},"x-method":"DELETE","x-path":"/_ml/calendars/{calendar_id}/jobs/{job_id}","x-urls":[{"path":"/_ml/calendars/{calendar_id}/jobs/{job_id}","methods":["DELETE"]}],"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\ncomma-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/src/es/json/ml.delete_data_frame_analytics.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.delete_data_frame_analytics","description":"Delete a data frame analytics job.","x-api":{"id":"ml.delete_data_frame_analytics","name":"delete-data-frame-analytics","namespace":"ml"},"x-method":"DELETE","x-path":"/_ml/data_frame/analytics/{id}","x-urls":[{"path":"/_ml/data_frame/analytics/{id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.3.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"force":{"type":"boolean","description":"If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The time to wait for the job to be deleted.","x-found-in":"query"},"id":{"type":"string","description":"Identifier for the data frame analytics job.","x-found-in":"path"}},"required":["id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.delete_data_frame_analytics","description":"Delete a data frame analytics job.","x-api":{"id":"ml.delete_data_frame_analytics","name":"delete-data-frame-analytics","namespace":"ml"},"x-method":"DELETE","x-path":"/_ml/data_frame/analytics/{id}","x-urls":[{"path":"/_ml/data_frame/analytics/{id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.3.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"force":{"type":"boolean","description":"If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The time to wait for the job to be deleted.","x-found-in":"query"},"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"}},"required":["id"]}

package/src/es/json/ml.delete_datafeed.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.delete_datafeed","description":"Delete a datafeed.","x-api":{"id":"ml.delete_datafeed","name":"delete-datafeed","namespace":"ml"},"x-method":"DELETE","x-path":"/_ml/datafeeds/{datafeed_id}","x-urls":[{"path":"/_ml/datafeeds/{datafeed_id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"5.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"force":{"type":"boolean","description":"Use to forcefully delete a started datafeed; this method is quicker than\nstopping and deleting the datafeed.","x-found-in":"query"},"datafeed_id":{"type":"string","description":"A numerical character string that uniquely identifies the datafeed. This\nidentifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, 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.delete_datafeed","description":"Delete a datafeed.","x-api":{"id":"ml.delete_datafeed","name":"delete-datafeed","namespace":"ml"},"x-method":"DELETE","x-path":"/_ml/datafeeds/{datafeed_id}","x-urls":[{"path":"/_ml/datafeeds/{datafeed_id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"5.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"force":{"type":"boolean","description":"Use to forcefully delete a started datafeed; this method is quicker than\nstopping and deleting the datafeed.","x-found-in":"query"},"datafeed_id":{"type":"string","description":"A numerical character string that uniquely identifies the datafeed. This\nidentifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, 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/src/es/json/ml.delete_expired_data.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.delete_expired_data","description":"Delete expired ML data.\n\nDelete all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using `_all`, by specifying `*` as the `<job_id>`, or by omitting the\n`<job_id>`.","x-api":{"id":"ml.delete_expired_data","name":"delete-expired-data","namespace":"ml"},"x-method":"DELETE","x-path":"/_ml/_delete_expired_data/{job_id}","x-urls":[{"path":"/_ml/_delete_expired_data/{job_id}","methods":["DELETE"]},{"path":"/_ml/_delete_expired_data","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"5.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"requests_per_second":{"type":"number","description":"The desired requests per second for the deletion processes. The default\nbehavior is no throttling.","x-found-in":"body"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"How long can the underlying delete processes run until they are canceled.","x-found-in":"body"},"job_id":{"type":"string","description":"Identifier for an anomaly detection job. It can be a job identifier, a\ngroup name, or a wildcard expression.","x-found-in":"path"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.delete_expired_data","description":"Delete expired ML data.\n\nDelete all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using `_all`, by specifying `*` as the `<job_id>`, or by omitting the\n`<job_id>`.","x-api":{"id":"ml.delete_expired_data","name":"delete-expired-data","namespace":"ml"},"x-method":"DELETE","x-path":"/_ml/_delete_expired_data/{job_id}","x-urls":[{"path":"/_ml/_delete_expired_data/{job_id}","methods":["DELETE"]},{"path":"/_ml/_delete_expired_data","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"5.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"requests_per_second":{"type":"number","description":"The desired requests per second for the deletion processes. The default\nbehavior is no throttling.","x-found-in":"body"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"How long can the underlying delete processes run until they are canceled.","x-found-in":"body"},"job_id":{"type":"string","description":"Identifier for an anomaly detection job. It can be a job identifier, a\ngroup name, 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/src/es/json/ml.delete_filter.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.delete_filter","description":"Delete a filter.\n\nIf an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.","x-api":{"id":"ml.delete_filter","name":"delete-filter","namespace":"ml"},"x-method":"DELETE","x-path":"/_ml/filters/{filter_id}","x-urls":[{"path":"/_ml/filters/{filter_id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"5.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"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.delete_filter","description":"Delete a filter.\n\nIf an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.","x-api":{"id":"ml.delete_filter","name":"delete-filter","namespace":"ml"},"x-method":"DELETE","x-path":"/_ml/filters/{filter_id}","x-urls":[{"path":"/_ml/filters/{filter_id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"5.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"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/src/es/json/ml.delete_forecast.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.delete_forecast","description":"Delete forecasts from a job.\n\nBy default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire.","x-api":{"id":"ml.delete_forecast","name":"delete-forecast","namespace":"ml"},"x-method":"DELETE","x-path":"/_ml/anomaly_detectors/{job_id}/_forecast/{forecast_id}","x-urls":[{"path":"/_ml/anomaly_detectors/{job_id}/_forecast","methods":["DELETE"]},{"path":"/_ml/anomaly_detectors/{job_id}/_forecast/{forecast_id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"6.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"allow_no_forecasts":{"type":"boolean","description":"Specifies whether an error occurs when there are no forecasts. In\nparticular, if this parameter is set to `false` and there are no\nforecasts associated with the job, attempts to delete all forecasts\nreturn an error.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the period of time to wait for the completion of the delete\noperation. When this period of time elapses, the API fails and returns an\nerror.","x-found-in":"query"},"job_id":{"type":"string","description":"Identifier for the anomaly detection job.","x-found-in":"path"},"forecast_id":{"type":"string","description":"A comma-separated list of forecast identifiers. If you do not specify\nthis optional parameter or if you specify `_all` or `*` the API deletes\nall forecasts from the job.","x-found-in":"path"}},"required":["job_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.delete_forecast","description":"Delete forecasts from a job.\n\nBy default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire.","x-api":{"id":"ml.delete_forecast","name":"delete-forecast","namespace":"ml"},"x-method":"DELETE","x-path":"/_ml/anomaly_detectors/{job_id}/_forecast/{forecast_id}","x-urls":[{"path":"/_ml/anomaly_detectors/{job_id}/_forecast","methods":["DELETE"]},{"path":"/_ml/anomaly_detectors/{job_id}/_forecast/{forecast_id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"6.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"allow_no_forecasts":{"type":"boolean","description":"Specifies whether an error occurs when there are no forecasts. In\nparticular, if this parameter is set to `false` and there are no\nforecasts associated with the job, attempts to delete all forecasts\nreturn an error.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the period of time to wait for the completion of the delete\noperation. When this period of time elapses, the API fails and returns an\nerror.","x-found-in":"query"},"job_id":{"type":"string","description":"Identifier for the anomaly detection job.","x-found-in":"path"},"forecast_id":{"type":"string","description":"A comma-separated list of forecast identifiers. If you do not specify\nthis optional parameter or if you specify `_all` or `*` the API deletes\nall forecasts from the 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/src/es/json/ml.delete_job.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.delete_job","description":"Delete an anomaly detection job.\n\nAll job configuration, model state and results are deleted.\nIt is not currently possible to delete multiple jobs using wildcards or a\ncomma separated list. If you delete a job that has a datafeed, the request\nfirst tries to delete the datafeed. This behavior is equivalent to calling\nthe delete datafeed API with the same timeout and force parameters as the\ndelete job request.","x-api":{"id":"ml.delete_job","name":"delete-job","namespace":"ml"},"x-method":"DELETE","x-path":"/_ml/anomaly_detectors/{job_id}","x-urls":[{"path":"/_ml/anomaly_detectors/{job_id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"5.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"force":{"type":"boolean","description":"Use to forcefully delete an opened job; this method is quicker than\nclosing and deleting the job.","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"},"wait_for_completion":{"type":"boolean","description":"Specifies whether the request should return immediately or wait until the\njob deletion completes.","x-found-in":"query"},"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.delete_job","description":"Delete an anomaly detection job.\n\nAll job configuration, model state and results are deleted.\nIt is not currently possible to delete multiple jobs using wildcards or a\ncomma separated list. If you delete a job that has a datafeed, the request\nfirst tries to delete the datafeed. This behavior is equivalent to calling\nthe delete datafeed API with the same timeout and force parameters as the\ndelete job request.","x-api":{"id":"ml.delete_job","name":"delete-job","namespace":"ml"},"x-method":"DELETE","x-path":"/_ml/anomaly_detectors/{job_id}","x-urls":[{"path":"/_ml/anomaly_detectors/{job_id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"5.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"force":{"type":"boolean","description":"Use to forcefully delete an opened job; this method is quicker than\nclosing and deleting the job.","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"},"wait_for_completion":{"type":"boolean","description":"Specifies whether the request should return immediately or wait until the\njob deletion completes.","x-found-in":"query"},"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/src/es/json/ml.delete_model_snapshot.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.delete_model_snapshot","description":"Delete a model snapshot.\n\nYou cannot delete the active model snapshot. To delete that snapshot, first\nrevert to a different one. To identify the active model snapshot, refer to\nthe `model_snapshot_id` in the results from the get jobs API.","x-api":{"id":"ml.delete_model_snapshot","name":"delete-model-snapshot","namespace":"ml"},"x-method":"DELETE","x-path":"/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}","x-urls":[{"path":"/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"5.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"job_id":{"type":"string","description":"Identifier for the anomaly detection job.","x-found-in":"path"},"snapshot_id":{"type":"string","description":"Identifier for the model snapshot.","x-found-in":"path"}},"required":["job_id","snapshot_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.delete_model_snapshot","description":"Delete a model snapshot.\n\nYou cannot delete the active model snapshot. To delete that snapshot, first\nrevert to a different one. To identify the active model snapshot, refer to\nthe `model_snapshot_id` in the results from the get jobs API.","x-api":{"id":"ml.delete_model_snapshot","name":"delete-model-snapshot","namespace":"ml"},"x-method":"DELETE","x-path":"/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}","x-urls":[{"path":"/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"5.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"job_id":{"type":"string","description":"Identifier for the anomaly detection job.","x-found-in":"path"},"snapshot_id":{"type":"string","description":"Identifier for the model snapshot.","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/src/es/json/ml.delete_trained_model.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.delete_trained_model","description":"Delete an unreferenced trained model.\n\nThe request deletes a trained inference model that is not referenced by an ingest pipeline.","x-api":{"id":"ml.delete_trained_model","name":"delete-trained-model","namespace":"ml"},"x-method":"DELETE","x-path":"/_ml/trained_models/{model_id}","x-urls":[{"path":"/_ml/trained_models/{model_id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.10.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"force":{"type":"boolean","description":"Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"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.delete_trained_model","description":"Delete an unreferenced trained model.\n\nThe request deletes a trained inference model that is not referenced by an ingest pipeline.","x-api":{"id":"ml.delete_trained_model","name":"delete-trained-model","namespace":"ml"},"x-method":"DELETE","x-path":"/_ml/trained_models/{model_id}","x-urls":[{"path":"/_ml/trained_models/{model_id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.10.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"force":{"type":"boolean","description":"Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"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/src/es/json/ml.delete_trained_model_alias.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.delete_trained_model_alias","description":"Delete a trained model alias.\n\nThis API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.","x-api":{"id":"ml.delete_trained_model_alias","name":"delete-trained-model-alias","namespace":"ml"},"x-method":"DELETE","x-path":"/_ml/trained_models/{model_id}/model_aliases/{model_alias}","x-urls":[{"path":"/_ml/trained_models/{model_id}/model_aliases/{model_alias}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.13.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"model_alias":{"type":"string","description":"The model alias to delete.","x-found-in":"path"},"model_id":{"type":"string","description":"The trained model ID to which the model alias refers.","x-found-in":"path"}},"required":["model_alias","model_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.delete_trained_model_alias","description":"Delete a trained model alias.\n\nThis API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.","x-api":{"id":"ml.delete_trained_model_alias","name":"delete-trained-model-alias","namespace":"ml"},"x-method":"DELETE","x-path":"/_ml/trained_models/{model_id}/model_aliases/{model_alias}","x-urls":[{"path":"/_ml/trained_models/{model_id}/model_aliases/{model_alias}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.13.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"model_alias":{"type":"string","description":"The model alias to delete.","x-found-in":"path"},"model_id":{"type":"string","description":"The trained model ID to which the model alias refers.","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/src/es/json/ml.estimate_model_memory.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.estimate_model_memory","description":"Estimate job model memory usage.\n\nMake an estimation of the memory usage for an anomaly detection job model.\nThe estimate is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.","x-api":{"id":"ml.estimate_model_memory","name":"estimate-model-memory","namespace":"ml"},"x-method":"POST","x-path":"/_ml/anomaly_detectors/_estimate_model_memory","x-urls":[{"path":"/_ml/anomaly_detectors/_estimate_model_memory","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.7.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"analysis_config":{"$ref":"./ml._types.json#/$defs/ml._types__AnalysisConfig","description":"For a list of the properties that you can specify in the\n`analysis_config` component of the body of this API.","x-found-in":"body"},"max_bucket_cardinality":{"type":"object","additionalProperties":{"type":"number"},"description":"Estimates of the highest cardinality in a single bucket that is observed\nfor influencer fields over the time period that the job analyzes data.\nTo produce a good answer, values must be provided for all influencer\nfields. Providing values for fields that are not listed as `influencers`\nhas no effect on the estimation.","x-found-in":"body"},"overall_cardinality":{"type":"object","additionalProperties":{"type":"number"},"description":"Estimates of the cardinality that is observed for fields over the whole\ntime period that the job analyzes data. To produce a good answer, values\nmust be provided for fields referenced in the `by_field_name`,\n`over_field_name` and `partition_field_name` of any detectors. Providing\nvalues for other fields has no effect on the estimation. It can be\nomitted from the request if no detectors have a `by_field_name`,\n`over_field_name` or `partition_field_name`.","x-found-in":"body"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.estimate_model_memory","description":"Estimate job model memory usage.\n\nMake an estimation of the memory usage for an anomaly detection job model.\nThe estimate is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.","x-api":{"id":"ml.estimate_model_memory","name":"estimate-model-memory","namespace":"ml"},"x-method":"POST","x-path":"/_ml/anomaly_detectors/_estimate_model_memory","x-urls":[{"path":"/_ml/anomaly_detectors/_estimate_model_memory","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.7.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"analysis_config":{"$ref":"./ml._types.json#/$defs/ml._types__AnalysisConfig","description":"For a list of the properties that you can specify in the\n`analysis_config` component of the body of this API.","x-found-in":"body"},"max_bucket_cardinality":{"type":"object","additionalProperties":{"type":"number"},"description":"Estimates of the highest cardinality in a single bucket that is observed\nfor influencer fields over the time period that the job analyzes data.\nTo produce a good answer, values must be provided for all influencer\nfields. Providing values for fields that are not listed as `influencers`\nhas no effect on the estimation.","x-found-in":"body"},"overall_cardinality":{"type":"object","additionalProperties":{"type":"number"},"description":"Estimates of the cardinality that is observed for fields over the whole\ntime period that the job analyzes data. To produce a good answer, values\nmust be provided for fields referenced in the `by_field_name`,\n`over_field_name` and `partition_field_name` of any detectors. Providing\nvalues for other fields has no effect on the estimation. It can be\nomitted from the request if no detectors have a `by_field_name`,\n`over_field_name` or `partition_field_name`.","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"}}}

package/src/es/json/ml.evaluate_data_frame.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"ml.evaluate_data_frame__DataframeClassificationSummary":{"type":"object","properties":{"auc_roc":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeEvaluationSummaryAucRoc","description":"The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve.\nIt is calculated for a specific class (provided as \"class_name\") treated as positive."},"accuracy":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeClassificationSummaryAccuracy","description":"Accuracy of predictions (per-class and overall)."},"multiclass_confusion_matrix":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeClassificationSummaryMulticlassConfusionMatrix","description":"Multiclass confusion matrix."},"precision":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeClassificationSummaryPrecision","description":"Precision of predictions (per-class and average)."},"recall":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeClassificationSummaryRecall","description":"Recall of predictions (per-class and average)."}}},"ml.evaluate_data_frame__DataframeEvaluationSummaryAucRoc":{"type":"object","properties":{"value":{"type":"number"},"curve":{"type":"array","items":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeEvaluationSummaryAucRocCurveItem"}}},"required":["value"]},"ml.evaluate_data_frame__DataframeEvaluationSummaryAucRocCurveItem":{"type":"object","properties":{"tpr":{"type":"number"},"fpr":{"type":"number"},"threshold":{"type":"number"}},"required":["tpr","fpr","threshold"]},"ml.evaluate_data_frame__DataframeClassificationSummaryAccuracy":{"type":"object","properties":{"classes":{"type":"array","items":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeEvaluationClass"}},"overall_accuracy":{"type":"number"}},"required":["classes","overall_accuracy"]},"ml.evaluate_data_frame__DataframeEvaluationClass":{"type":"object","properties":{"value":{"type":"number"},"class_name":{"type":"string"}},"required":["value","class_name"]},"ml.evaluate_data_frame__DataframeClassificationSummaryMulticlassConfusionMatrix":{"type":"object","properties":{"confusion_matrix":{"type":"array","items":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__ConfusionMatrixItem"}},"other_actual_class_count":{"type":"number"}},"required":["confusion_matrix","other_actual_class_count"]},"ml.evaluate_data_frame__ConfusionMatrixItem":{"type":"object","properties":{"actual_class":{"type":"string"},"actual_class_doc_count":{"type":"number"},"predicted_classes":{"type":"array","items":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__ConfusionMatrixPrediction"}},"other_predicted_class_doc_count":{"type":"number"}},"required":["actual_class","actual_class_doc_count","predicted_classes","other_predicted_class_doc_count"]},"ml.evaluate_data_frame__ConfusionMatrixPrediction":{"type":"object","properties":{"predicted_class":{"type":"string"},"count":{"type":"number"}},"required":["predicted_class","count"]},"ml.evaluate_data_frame__DataframeClassificationSummaryPrecision":{"type":"object","properties":{"classes":{"type":"array","items":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeEvaluationClass"}},"avg_precision":{"type":"number"}},"required":["classes","avg_precision"]},"ml.evaluate_data_frame__DataframeClassificationSummaryRecall":{"type":"object","properties":{"classes":{"type":"array","items":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeEvaluationClass"}},"avg_recall":{"type":"number"}},"required":["classes","avg_recall"]},"ml.evaluate_data_frame__DataframeOutlierDetectionSummary":{"type":"object","properties":{"auc_roc":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeEvaluationSummaryAucRoc","description":"The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve."},"precision":{"type":"object","additionalProperties":{"type":"number"},"description":"Set the different thresholds of the outlier score at where the metric is calculated."},"recall":{"type":"object","additionalProperties":{"type":"number"},"description":"Set the different thresholds of the outlier score at where the metric is calculated."},"confusion_matrix":{"type":"object","additionalProperties":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__ConfusionMatrixThreshold"},"description":"Set the different thresholds of the outlier score at where the metrics (`tp` - true positive, `fp` - false positive, `tn` - true negative, `fn` - false negative) are calculated."}}},"ml.evaluate_data_frame__ConfusionMatrixThreshold":{"type":"object","properties":{"true_positive":{"type":"number","description":"True Positive"},"false_positive":{"type":"number","description":"False Positive"},"true_negative":{"type":"number","description":"True Negative"},"false_negative":{"type":"number","description":"False Negative"}},"required":["true_positive","false_positive","true_negative","false_negative"]},"ml.evaluate_data_frame__DataframeRegressionSummary":{"type":"object","properties":{"huber":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeEvaluationValue","description":"Pseudo Huber loss function."},"mse":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeEvaluationValue","description":"Average squared difference between the predicted values and the actual (`ground truth`) value."},"msle":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeEvaluationValue","description":"Average squared difference between the logarithm of the predicted values and the logarithm of the actual (`ground truth`) value."},"r_squared":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeEvaluationValue","description":"Proportion of the variance in the dependent variable that is predictable from the independent variables."}}},"ml.evaluate_data_frame__DataframeEvaluationValue":{"type":"object","properties":{"value":{"type":"number"}},"required":["value"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"ml.evaluate_data_frame__DataframeClassificationSummary":{"type":"object","properties":{"auc_roc":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeEvaluationSummaryAucRoc","description":"The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve.\nIt is calculated for a specific class (provided as \"class_name\") treated as positive."},"accuracy":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeClassificationSummaryAccuracy","description":"Accuracy of predictions (per-class and overall)."},"multiclass_confusion_matrix":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeClassificationSummaryMulticlassConfusionMatrix","description":"Multiclass confusion matrix."},"precision":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeClassificationSummaryPrecision","description":"Precision of predictions (per-class and average)."},"recall":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeClassificationSummaryRecall","description":"Recall of predictions (per-class and average)."}}},"ml.evaluate_data_frame__DataframeEvaluationSummaryAucRoc":{"type":"object","properties":{"value":{"type":"number"},"curve":{"type":"array","items":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeEvaluationSummaryAucRocCurveItem"}}},"required":["value"]},"ml.evaluate_data_frame__DataframeEvaluationSummaryAucRocCurveItem":{"type":"object","properties":{"tpr":{"type":"number"},"fpr":{"type":"number"},"threshold":{"type":"number"}},"required":["tpr","fpr","threshold"]},"ml.evaluate_data_frame__DataframeClassificationSummaryAccuracy":{"type":"object","properties":{"classes":{"type":"array","items":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeEvaluationClass"}},"overall_accuracy":{"type":"number"}},"required":["classes","overall_accuracy"]},"ml.evaluate_data_frame__DataframeEvaluationClass":{"type":"object","properties":{"value":{"type":"number"},"class_name":{"type":"string"}},"required":["value","class_name"]},"ml.evaluate_data_frame__DataframeClassificationSummaryMulticlassConfusionMatrix":{"type":"object","properties":{"confusion_matrix":{"type":"array","items":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__ConfusionMatrixItem"}},"other_actual_class_count":{"type":"number"}},"required":["confusion_matrix","other_actual_class_count"]},"ml.evaluate_data_frame__ConfusionMatrixItem":{"type":"object","properties":{"actual_class":{"type":"string"},"actual_class_doc_count":{"type":"number"},"predicted_classes":{"type":"array","items":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__ConfusionMatrixPrediction"}},"other_predicted_class_doc_count":{"type":"number"}},"required":["actual_class","actual_class_doc_count","predicted_classes","other_predicted_class_doc_count"]},"ml.evaluate_data_frame__ConfusionMatrixPrediction":{"type":"object","properties":{"predicted_class":{"type":"string"},"count":{"type":"number"}},"required":["predicted_class","count"]},"ml.evaluate_data_frame__DataframeClassificationSummaryPrecision":{"type":"object","properties":{"classes":{"type":"array","items":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeEvaluationClass"}},"avg_precision":{"type":"number"}},"required":["classes","avg_precision"]},"ml.evaluate_data_frame__DataframeClassificationSummaryRecall":{"type":"object","properties":{"classes":{"type":"array","items":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeEvaluationClass"}},"avg_recall":{"type":"number"}},"required":["classes","avg_recall"]},"ml.evaluate_data_frame__DataframeOutlierDetectionSummary":{"type":"object","properties":{"auc_roc":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeEvaluationSummaryAucRoc","description":"The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve."},"precision":{"type":"object","additionalProperties":{"type":"number"},"description":"Set the different thresholds of the outlier score at where the metric is calculated."},"recall":{"type":"object","additionalProperties":{"type":"number"},"description":"Set the different thresholds of the outlier score at where the metric is calculated."},"confusion_matrix":{"type":"object","additionalProperties":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__ConfusionMatrixThreshold"},"description":"Set the different thresholds of the outlier score at where the metrics (`tp` - true positive, `fp` - false positive, `tn` - true negative, `fn` - false negative) are calculated."}}},"ml.evaluate_data_frame__ConfusionMatrixThreshold":{"type":"object","properties":{"tp":{"type":"number","description":"True Positive","x-codegen-name":"true_positive"},"fp":{"type":"number","description":"False Positive","x-codegen-name":"false_positive"},"tn":{"type":"number","description":"True Negative","x-codegen-name":"true_negative"},"fn":{"type":"number","description":"False Negative","x-codegen-name":"false_negative"}},"required":["tp","fp","tn","fn"]},"ml.evaluate_data_frame__DataframeRegressionSummary":{"type":"object","properties":{"huber":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeEvaluationValue","description":"Pseudo Huber loss function."},"mse":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeEvaluationValue","description":"Average squared difference between the predicted values and the actual (`ground truth`) value."},"msle":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeEvaluationValue","description":"Average squared difference between the logarithm of the predicted values and the logarithm of the actual (`ground truth`) value."},"r_squared":{"$ref":"./ml.evaluate_data_frame.json#/$defs/ml.evaluate_data_frame__DataframeEvaluationValue","description":"Proportion of the variance in the dependent variable that is predictable from the independent variables."}}},"ml.evaluate_data_frame__DataframeEvaluationValue":{"type":"object","properties":{"value":{"type":"number"}},"required":["value"]}}}

package/src/es/json/ml.evaluate_data_frame.request.json

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

package/src/es/json/ml.explain_data_frame_analytics.request.json

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

package/src/es/json/ml.flush_job.request.json

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

package/src/es/json/ml.forecast.request.json

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

package/src/es/json/ml.get_buckets.request.json

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

package/src/es/json/ml.get_calendar_events.request.json

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

package/src/es/json/ml.get_calendars.request.json

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

package/src/es/json/ml.get_categories.request.json

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

package/src/es/json/ml.get_data_frame_analytics.request.json

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

package/src/es/json/ml.get_data_frame_analytics_stats.request.json

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

package/src/es/json/ml.get_datafeed_stats.request.json

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

package/src/es/json/ml.get_datafeeds.request.json

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

package/src/es/json/ml.get_filters.request.json

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

package/src/es/json/ml.get_influencers.request.json

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