@elastic/schemas 0.4.3 → 0.4.4

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.delete_forecast","type":"object","properties":{"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"},"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"}},"required":["job_id"],"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.delete_forecast","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"],"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."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.delete_job","type":"object","properties":{"job_id":{"type":"string","description":"Identifier for the anomaly detection job.","x-found-in":"path"},"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"}},"required":["job_id"],"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.delete_job","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"],"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."}

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","type":"object","properties":{"model_id":{"type":"string","description":"The unique identifier of the trained model.","x-found-in":"path"},"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"}},"required":["model_id"],"description":"Delete an unreferenced trained model.\n\nThe request deletes a trained inference model that is not referenced by an ingest pipeline."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.delete_trained_model","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"],"description":"Delete an unreferenced trained model.\n\nThe request deletes a trained inference model that is not referenced by an ingest pipeline."}

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","type":"object","properties":{"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"},"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"}},"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.explain_data_frame_analytics","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"}},"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."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.flush_job","type":"object","properties":{"job_id":{"type":"string","description":"Identifier for the anomaly detection job.","x-found-in":"path"},"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"}},"required":["job_id"],"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.flush_job","type":"object","properties":{"advance_time":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Specifies to advance to a particular time value. Results are generated\nand the model is updated for data from the specified time interval.","x-found-in":"query"},"calc_interim":{"type":"boolean","description":"If true, calculates the interim results for the most recent bucket or all\nbuckets within the latency period.","x-found-in":"query"},"end":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"When used in conjunction with `calc_interim` and `start`, specifies the\nrange of buckets on which to calculate interim results.","x-found-in":"query"},"skip_time":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Specifies to skip to a particular time value. Results are not generated\nand the model is not updated for data from the specified time interval.","x-found-in":"query"},"start":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"When used in conjunction with `calc_interim`, specifies the range of\nbuckets on which to calculate interim results.","x-found-in":"query"},"job_id":{"type":"string","description":"Identifier for the anomaly detection job.","x-found-in":"path"}},"required":["job_id"],"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."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.forecast","type":"object","properties":{"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"},"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"}},"required":["job_id"],"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.forecast","type":"object","properties":{"duration":{"$ref":"./_types.json#/$defs/_types__Duration","description":"A period of time that indicates how far into the future to forecast. For\nexample, `30d` corresponds to 30 days. The forecast starts at the last\nrecord that was processed.","x-found-in":"query"},"expires_in":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period of time that forecast results are retained. After a forecast\nexpires, the results are deleted. If set to a value of 0, the forecast is\nnever automatically deleted.","x-found-in":"query"},"max_model_memory":{"type":"string","description":"The maximum memory the forecast can use. If the forecast needs to use\nmore than the provided amount, it will spool to disk. Default is 20mb,\nmaximum is 500mb and minimum is 1mb. If set to 40% or more of the job’s\nconfigured memory limit, it is automatically reduced to below that\namount.","x-found-in":"query"},"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"],"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."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_buckets","type":"object","properties":{"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"},"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"}},"required":["job_id"],"description":"Get anomaly detection job results for buckets.\n\nThe API presents a chronological view of the records, grouped by bucket."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_buckets","type":"object","properties":{"anomaly_score":{"type":"number","description":"Returns buckets with anomaly scores greater or equal than this value.","x-found-in":"query"},"desc":{"type":"boolean","description":"If `true`, the buckets are sorted in descending order.","x-found-in":"query"},"end":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Returns buckets with timestamps earlier than this time. `-1` means it is\nunset and results are not limited to specific timestamps.","x-found-in":"query"},"exclude_interim":{"type":"boolean","description":"If `true`, the output excludes interim results.","x-found-in":"query"},"expand":{"type":"boolean","description":"If true, the output includes anomaly records.","x-found-in":"query"},"page":{"$ref":"./ml._types.json#/$defs/ml._types__Page","x-found-in":"body"},"sort":{"type":"string","description":"Specifies the sort field for the requested buckets.","x-found-in":"query"},"start":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Returns buckets with timestamps after this time. `-1` means it is unset\nand results are not limited to specific timestamps.","x-found-in":"query"},"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"},"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"],"description":"Get anomaly detection job results for buckets.\n\nThe API presents a chronological view of the records, grouped by bucket."}

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","type":"object","properties":{"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"},"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"}},"required":["calendar_id"],"description":"Get info about events in calendars."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_calendar_events","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"],"description":"Get info about events in calendars."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_calendars","type":"object","properties":{"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"},"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"}},"description":"Get calendar configuration info."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_calendars","type":"object","properties":{"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"},"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"},"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"}},"description":"Get calendar configuration info."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_categories","type":"object","properties":{"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"},"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"}},"required":["job_id"],"description":"Get anomaly detection job results for categories."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_categories","type":"object","properties":{"page":{"$ref":"./ml._types.json#/$defs/ml._types__Page","description":"Configures pagination.\nThis parameter has the `from` and `size` properties.","x-found-in":"body"},"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"},"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"],"description":"Get anomaly detection job results for categories."}

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","type":"object","properties":{"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"},"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"}},"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_data_frame_analytics","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"}},"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."}

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","type":"object","properties":{"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"},"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"}},"description":"Get data frame analytics job stats."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_data_frame_analytics_stats","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"}},"description":"Get data frame analytics job stats."}

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","type":"object","properties":{"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"},"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"}},"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_datafeed_stats","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"}},"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."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_datafeeds","type":"object","properties":{"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"},"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"}},"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_datafeeds","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"}},"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."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_filters","type":"object","properties":{"filter_id":{"$ref":"./_types.json#/$defs/_types__Ids","description":"A string that uniquely identifies a filter.","x-found-in":"path"},"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"}},"description":"Get filters.\n\nYou can get a single filter or all filters."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_filters","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"}},"description":"Get filters.\n\nYou can get a single filter or all filters."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_influencers","type":"object","properties":{"job_id":{"type":"string","description":"Identifier for the anomaly detection job.","x-found-in":"path"},"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"}},"required":["job_id"],"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_influencers","type":"object","properties":{"page":{"$ref":"./ml._types.json#/$defs/ml._types__Page","description":"Configures pagination.\nThis parameter has the `from` and `size` properties.","x-found-in":"body"},"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"},"job_id":{"type":"string","description":"Identifier for the anomaly detection job.","x-found-in":"path"}},"required":["job_id"],"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."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_job_stats","type":"object","properties":{"job_id":{"type":"string","description":"Identifier for the anomaly detection job. It can be a job identifier, a\ngroup name, a comma-separated list of jobs, or a wildcard expression. If\nyou do not specify one of these options, the API returns information for\nall anomaly detection jobs.","x-found-in":"path"},"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no jobs that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty `jobs` array when\nthere are no matches and the subset of results when there are partial\nmatches. If `false`, the API returns a `404` status\ncode when there are no matches or only partial matches.","x-found-in":"query"}},"description":"Get anomaly detection job stats."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_job_stats","type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no jobs that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty `jobs` array when\nthere are no matches and the subset of results when there are partial\nmatches. If `false`, the API returns a `404` status\ncode when there are no matches or only partial matches.","x-found-in":"query"},"job_id":{"type":"string","description":"Identifier for the anomaly detection job. It can be a job identifier, a\ngroup name, a comma-separated list of jobs, or a wildcard expression. If\nyou do not specify one of these options, the API returns information for\nall anomaly detection jobs.","x-found-in":"path"}},"description":"Get anomaly detection job stats."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_jobs","type":"object","properties":{"job_id":{"$ref":"./_types.json#/$defs/_types__Ids","description":"Identifier for the anomaly detection job. It can be a job identifier, a\ngroup name, or a wildcard expression. If you do not specify one of these\noptions, the API returns information for all anomaly detection jobs.","x-found-in":"path"},"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no jobs that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is `true`, which returns an empty `jobs` array when\nthere are no matches and the subset of results when there are partial\nmatches. If this parameter is `false`, the request returns a `404` status\ncode when there are no matches or only partial matches.","x-found-in":"query"},"exclude_generated":{"type":"boolean","description":"Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.","x-found-in":"query"}},"description":"Get anomaly detection jobs configuration info.\n\nYou can get information for multiple anomaly detection jobs in a single API\nrequest by using a group name, a comma-separated list of jobs, or a wildcard\nexpression. You can get information for all anomaly detection jobs by using\n`_all`, by specifying `*` as the `<job_id>`, or by omitting the `<job_id>`."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_jobs","type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no jobs that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is `true`, which returns an empty `jobs` array when\nthere are no matches and the subset of results when there are partial\nmatches. If this parameter is `false`, the request returns a `404` status\ncode when there are no matches or only partial matches.","x-found-in":"query"},"exclude_generated":{"type":"boolean","description":"Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.","x-found-in":"query"},"job_id":{"$ref":"./_types.json#/$defs/_types__Ids","description":"Identifier for the anomaly detection job. It can be a job identifier, a\ngroup name, or a wildcard expression. If you do not specify one of these\noptions, the API returns information for all anomaly detection jobs.","x-found-in":"path"}},"description":"Get anomaly detection jobs configuration info.\n\nYou can get information for multiple anomaly detection jobs in a single API\nrequest by using a group name, a comma-separated list of jobs, or a wildcard\nexpression. You can get information for all anomaly detection jobs by using\n`_all`, by specifying `*` as the `<job_id>`, or by omitting the `<job_id>`."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_memory_stats","type":"object","properties":{"node_id":{"type":"string","description":"The names of particular nodes in the cluster to target. For example, `nodeId1,nodeId2` or\n`ml:true`","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node. If no response is received before the timeout\nexpires, the request fails and returns an error.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request\nfails and returns an error.","x-found-in":"query"}},"description":"Get machine learning memory usage info.\n\nGet information about how machine learning jobs and trained models are using memory,\non each node, both within the JVM heap, and natively, outside of the JVM."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_memory_stats","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node. If no response is received before the timeout\nexpires, the request fails and returns an error.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request\nfails and returns an error.","x-found-in":"query"},"node_id":{"type":"string","description":"The names of particular nodes in the cluster to target. For example, `nodeId1,nodeId2` or\n`ml:true`","x-found-in":"path"}},"description":"Get machine learning memory usage info.\n\nGet information about how machine learning jobs and trained models are using memory,\non each node, both within the JVM heap, and natively, outside of the JVM."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_model_snapshot_upgrade_stats","type":"object","properties":{"job_id":{"type":"string","description":"Identifier for the anomaly detection job.","x-found-in":"path"},"snapshot_id":{"type":"string","description":"A numerical character string that uniquely identifies the model snapshot. You can get information for multiple\nsnapshots by using a comma-separated list or a wildcard expression. You can get all snapshots by using `_all`,\nby specifying `*` as the snapshot ID, or by omitting the snapshot ID.","x-found-in":"path"},"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n -  Contains wildcard expressions and there are no jobs that match.\n -  Contains the _all string or no identifiers and there are no matches.\n -  Contains wildcard expressions and there are only partial matches.\n\nThe default value is true, which returns an empty jobs array when there are no matches and the subset of results\nwhen there are partial matches. If this parameter is false, the request returns a 404 status code when there are\nno matches or only partial matches.","x-found-in":"query"}},"required":["job_id","snapshot_id"],"description":"Get anomaly detection job model snapshot upgrade usage info."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_model_snapshot_upgrade_stats","type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n -  Contains wildcard expressions and there are no jobs that match.\n -  Contains the _all string or no identifiers and there are no matches.\n -  Contains wildcard expressions and there are only partial matches.\n\nThe default value is true, which returns an empty jobs array when there are no matches and the subset of results\nwhen there are partial matches. If this parameter is false, the request returns a 404 status code when there are\nno matches or only partial matches.","x-found-in":"query"},"job_id":{"type":"string","description":"Identifier for the anomaly detection job.","x-found-in":"path"},"snapshot_id":{"type":"string","description":"A numerical character string that uniquely identifies the model snapshot. You can get information for multiple\nsnapshots by using a comma-separated list or a wildcard expression. You can get all snapshots by using `_all`,\nby specifying `*` as the snapshot ID, or by omitting the snapshot ID.","x-found-in":"path"}},"required":["job_id","snapshot_id"],"description":"Get anomaly detection job model snapshot upgrade usage info."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_model_snapshots","type":"object","properties":{"job_id":{"type":"string","description":"Identifier for the anomaly detection job.","x-found-in":"path"},"snapshot_id":{"type":"string","description":"A numerical character string that uniquely identifies the model snapshot. You can get information for multiple\nsnapshots by using a comma-separated list or a wildcard expression. You can get all snapshots by using `_all`,\nby specifying `*` as the snapshot ID, or by omitting the snapshot ID.","x-found-in":"path"},"desc":{"type":"boolean","description":"Refer to the description for the `desc` query parameter.","x-found-in":"body"},"end":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Refer to the description for the `end` query parameter.","x-found-in":"body"},"from":{"type":"number","description":"Skips the specified number of snapshots.","x-found-in":"query"},"size":{"type":"number","description":"Specifies the maximum number of snapshots to obtain.","x-found-in":"query"},"sort":{"type":"string","description":"Refer to the description for the `sort` query parameter.","x-found-in":"body"},"start":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Refer to the description for the `start` query parameter.","x-found-in":"body"},"page":{"$ref":"./ml._types.json#/$defs/ml._types__Page","x-found-in":"body"}},"required":["job_id"],"description":"Get model snapshots info."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_model_snapshots","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 snapshots with timestamps earlier than this time.","x-found-in":"query"},"page":{"$ref":"./ml._types.json#/$defs/ml._types__Page","x-found-in":"body"},"sort":{"type":"string","description":"Specifies the sort field for the requested snapshots. By default, the\nsnapshots are sorted by their timestamp.","x-found-in":"query"},"start":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Returns snapshots with timestamps after this time.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of snapshots.","x-found-in":"query"},"size":{"type":"number","description":"Specifies the maximum number of snapshots to obtain.","x-found-in":"query"},"job_id":{"type":"string","description":"Identifier for the anomaly detection job.","x-found-in":"path"},"snapshot_id":{"type":"string","description":"A numerical character string that uniquely identifies the model snapshot. You can get information for multiple\nsnapshots by using a comma-separated list or a wildcard expression. You can get all snapshots by using `_all`,\nby specifying `*` as the snapshot ID, or by omitting the snapshot ID.","x-found-in":"path"}},"required":["job_id"],"description":"Get model snapshots info."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_overall_buckets","type":"object","properties":{"job_id":{"type":"string","description":"Identifier for the anomaly detection job. It can be a job identifier, a\ngroup name, a comma-separated list of jobs or groups, or a wildcard\nexpression.\n\nYou can summarize the bucket results for all anomaly detection jobs by\nusing `_all` or by specifying `*` as the `<job_id>`.","x-found-in":"path"},"allow_no_match":{"type":"boolean","description":"Refer to the description for the `allow_no_match` query parameter.","x-found-in":"body"},"bucket_span":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Refer to the description for the `bucket_span` query parameter.","x-found-in":"body"},"end":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Refer to the description for the `end` query parameter.","x-found-in":"body"},"exclude_interim":{"type":"boolean","description":"Refer to the description for the `exclude_interim` query parameter.","x-found-in":"body"},"overall_score":{"type":"number","description":"Refer to the description for the `overall_score` query parameter.","x-found-in":"body"},"start":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Refer to the description for the `start` query parameter.","x-found-in":"body"},"top_n":{"type":"number","description":"Refer to the description for the `top_n` query parameter.","x-found-in":"body"}},"required":["job_id"],"description":"Get overall bucket results.\n\nRetrievs overall bucket results that summarize the bucket results of\nmultiple anomaly detection jobs.\n\nThe `overall_score` is calculated by combining the scores of all the\nbuckets within the overall bucket span. First, the maximum\n`anomaly_score` per anomaly detection job in the overall bucket is\ncalculated. Then the `top_n` of those scores are averaged to result in\nthe `overall_score`. This means that you can fine-tune the\n`overall_score` so that it is more or less sensitive to the number of\njobs that detect an anomaly at the same time. For example, if you set\n`top_n` to `1`, the `overall_score` is the maximum bucket score in the\noverall bucket. Alternatively, if you set `top_n` to the number of jobs,\nthe `overall_score` is high only when all jobs detect anomalies in that\noverall bucket. If you set the `bucket_span` parameter (to a value\ngreater than its default), the `overall_score` is the maximum\n`overall_score` of the overall buckets that have a span equal to the\njobs' largest bucket span."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_overall_buckets","type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no jobs that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the request returns an empty `jobs` array when there are no\nmatches and the subset of results when there are partial matches. If this\nparameter is `false`, the request returns a `404` status code when there\nare no matches or only partial matches.","x-found-in":"query"},"bucket_span":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The span of the overall buckets. Must be greater or equal to the largest\nbucket span of the specified anomaly detection jobs, which is the default\nvalue.\n\nBy default, an overall bucket has a span equal to the largest bucket span\nof the specified anomaly detection jobs. To override that behavior, use\nthe optional `bucket_span` parameter.","x-found-in":"query"},"end":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Returns overall buckets with timestamps earlier than this time.","x-found-in":"query"},"exclude_interim":{"type":"boolean","description":"If `true`, the output excludes interim results.","x-found-in":"query"},"overall_score":{"type":"number","description":"Returns overall buckets with overall scores greater than or equal to this\nvalue.","x-found-in":"query"},"start":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Returns overall buckets with timestamps after this time.","x-found-in":"query"},"top_n":{"type":"number","description":"The number of top anomaly detection job bucket scores to be used in the\n`overall_score` calculation.","x-found-in":"query"},"job_id":{"type":"string","description":"Identifier for the anomaly detection job. It can be a job identifier, a\ngroup name, a comma-separated list of jobs or groups, or a wildcard\nexpression.\n\nYou can summarize the bucket results for all anomaly detection jobs by\nusing `_all` or by specifying `*` as the `<job_id>`.","x-found-in":"path"}},"required":["job_id"],"description":"Get overall bucket results.\n\nRetrievs overall bucket results that summarize the bucket results of\nmultiple anomaly detection jobs.\n\nThe `overall_score` is calculated by combining the scores of all the\nbuckets within the overall bucket span. First, the maximum\n`anomaly_score` per anomaly detection job in the overall bucket is\ncalculated. Then the `top_n` of those scores are averaged to result in\nthe `overall_score`. This means that you can fine-tune the\n`overall_score` so that it is more or less sensitive to the number of\njobs that detect an anomaly at the same time. For example, if you set\n`top_n` to `1`, the `overall_score` is the maximum bucket score in the\noverall bucket. Alternatively, if you set `top_n` to the number of jobs,\nthe `overall_score` is high only when all jobs detect anomalies in that\noverall bucket. If you set the `bucket_span` parameter (to a value\ngreater than its default), the `overall_score` is the maximum\n`overall_score` of the overall buckets that have a span equal to the\njobs' largest bucket span."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_records","type":"object","properties":{"job_id":{"type":"string","description":"Identifier for the anomaly detection job.","x-found-in":"path"},"desc":{"type":"boolean","description":"Refer to the description for the `desc` query parameter.","x-found-in":"body"},"end":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Refer to the description for the `end` query parameter.","x-found-in":"body"},"exclude_interim":{"type":"boolean","description":"Refer to the description for the `exclude_interim` query parameter.","x-found-in":"body"},"from":{"type":"number","description":"Skips the specified number of records.","x-found-in":"query"},"record_score":{"type":"number","description":"Refer to the description for the `record_score` query parameter.","x-found-in":"body"},"size":{"type":"number","description":"Specifies the maximum number of records to obtain.","x-found-in":"query"},"sort":{"type":"string","description":"Refer to the description for the `sort` query parameter.","x-found-in":"body"},"start":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Refer to the description for the `start` query parameter.","x-found-in":"body"},"page":{"$ref":"./ml._types.json#/$defs/ml._types__Page","x-found-in":"body"}},"required":["job_id"],"description":"Get anomaly records for an anomaly detection job.\n\nRecords contain the detailed analytical results. They describe the anomalous\nactivity that has been identified in the input data based on the detector\nconfiguration.\nThere can be many anomaly records depending on the characteristics and size\nof the input data. In practice, there are often too many to be able to\nmanually process them. The machine learning features therefore perform a\nsophisticated aggregation of the anomaly records into buckets.\nThe number of record results depends on the number of anomalies found in each\nbucket, which relates to the number of time series being modeled and the\nnumber of detectors."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_records","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 records with timestamps earlier than this time. The default value\nmeans results are not limited to specific timestamps.","x-found-in":"query"},"exclude_interim":{"type":"boolean","description":"If `true`, the output excludes interim results.","x-found-in":"query"},"page":{"$ref":"./ml._types.json#/$defs/ml._types__Page","x-found-in":"body"},"record_score":{"type":"number","description":"Returns records with anomaly scores greater or equal than this value.","x-found-in":"query"},"sort":{"type":"string","description":"Specifies the sort field for the requested records.","x-found-in":"query"},"start":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Returns records with timestamps after this time. The default value means\nresults are not limited to specific timestamps.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of records.","x-found-in":"query"},"size":{"type":"number","description":"Specifies the maximum number of records to obtain.","x-found-in":"query"},"job_id":{"type":"string","description":"Identifier for the anomaly detection job.","x-found-in":"path"}},"required":["job_id"],"description":"Get anomaly records for an anomaly detection job.\n\nRecords contain the detailed analytical results. They describe the anomalous\nactivity that has been identified in the input data based on the detector\nconfiguration.\nThere can be many anomaly records depending on the characteristics and size\nof the input data. In practice, there are often too many to be able to\nmanually process them. The machine learning features therefore perform a\nsophisticated aggregation of the anomaly records into buckets.\nThe number of record results depends on the number of anomalies found in each\nbucket, which relates to the number of time series being modeled and the\nnumber of detectors."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_trained_models","type":"object","properties":{"model_id":{"$ref":"./_types.json#/$defs/_types__Ids","description":"The unique identifier of the trained model or a model alias.\n\nYou can get information for multiple trained models in a single API\nrequest by using a comma-separated list of model IDs or a wildcard\nexpression.","x-found-in":"path"},"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n- Contains wildcard expressions and there are no models that match.\n- Contains the _all string or no identifiers and there are no matches.\n- Contains wildcard expressions and there are only partial matches.\n\nIf true, it returns an empty array when there are no matches and the\nsubset of results when there are partial matches.","x-found-in":"query"},"decompress_definition":{"type":"boolean","description":"Specifies whether the included model definition should be returned as a\nJSON map (true) or in a custom compressed format (false).","x-found-in":"query"},"exclude_generated":{"type":"boolean","description":"Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of models.","x-found-in":"query"},"include":{"$ref":"./ml._types.json#/$defs/ml._types__Include","description":"A comma delimited string of optional fields to include in the response\nbody.","x-found-in":"query"},"size":{"type":"number","description":"Specifies the maximum number of models to obtain.","x-found-in":"query"},"tags":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A comma delimited string of tags. A trained model can have many tags, or\nnone. When supplied, only trained models that contain all the supplied\ntags are returned.","x-found-in":"query"}},"description":"Get trained model configuration info."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_trained_models","type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n- Contains wildcard expressions and there are no models that match.\n- Contains the _all string or no identifiers and there are no matches.\n- Contains wildcard expressions and there are only partial matches.\n\nIf true, it returns an empty array when there are no matches and the\nsubset of results when there are partial matches.","x-found-in":"query"},"decompress_definition":{"type":"boolean","description":"Specifies whether the included model definition should be returned as a\nJSON map (true) or in a custom compressed format (false).","x-found-in":"query"},"exclude_generated":{"type":"boolean","description":"Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of models.","x-found-in":"query"},"include":{"$ref":"./ml._types.json#/$defs/ml._types__Include","description":"A comma delimited string of optional fields to include in the response\nbody.","x-found-in":"query"},"size":{"type":"number","description":"Specifies the maximum number of models to obtain.","x-found-in":"query"},"tags":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A comma delimited string of tags. A trained model can have many tags, or\nnone. When supplied, only trained models that contain all the supplied\ntags are returned.","x-found-in":"query"},"model_id":{"$ref":"./_types.json#/$defs/_types__Ids","description":"The unique identifier of the trained model or a model alias.\n\nYou can get information for multiple trained models in a single API\nrequest by using a comma-separated list of model IDs or a wildcard\nexpression.","x-found-in":"path"}},"description":"Get trained model configuration info."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_trained_models_stats","type":"object","properties":{"model_id":{"$ref":"./_types.json#/$defs/_types__Ids","description":"The unique identifier of the trained model or a model alias. It can be a\ncomma-separated list or a wildcard expression.","x-found-in":"path"},"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n- Contains wildcard expressions and there are no models that match.\n- Contains the _all string or no identifiers and there are no matches.\n- Contains wildcard expressions and there are only partial matches.\n\nIf true, it returns an empty array when there are no matches and the\nsubset of results when there are partial matches.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of models.","x-found-in":"query"},"size":{"type":"number","description":"Specifies the maximum number of models to obtain.","x-found-in":"query"}},"description":"Get trained models usage info.\n\nYou can get usage information for multiple trained\nmodels in a single API request by using a comma-separated list of model IDs or a wildcard expression."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.get_trained_models_stats","type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n- Contains wildcard expressions and there are no models that match.\n- Contains the _all string or no identifiers and there are no matches.\n- Contains wildcard expressions and there are only partial matches.\n\nIf true, it returns an empty array when there are no matches and the\nsubset of results when there are partial matches.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of models.","x-found-in":"query"},"size":{"type":"number","description":"Specifies the maximum number of models to obtain.","x-found-in":"query"},"model_id":{"$ref":"./_types.json#/$defs/_types__Ids","description":"The unique identifier of the trained model or a model alias. It can be a\ncomma-separated list or a wildcard expression.","x-found-in":"path"}},"description":"Get trained models usage info.\n\nYou can get usage information for multiple trained\nmodels in a single API request by using a comma-separated list of model IDs or a wildcard expression."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.infer_trained_model","type":"object","properties":{"model_id":{"type":"string","description":"The unique identifier of the trained model.","x-found-in":"path"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Controls the amount of time to wait for inference results.","x-found-in":"query"},"docs":{"type":"array","items":{"type":"object","additionalProperties":{}},"description":"An array of objects to pass to the model for inference. The objects should contain a fields matching your\nconfigured trained model input. Typically, for NLP models, the field name is `text_field`.\nCurrently, for NLP models, only a single value is allowed.","x-found-in":"body"},"inference_config":{"$ref":"./ml._types.json#/$defs/ml._types__InferenceConfigUpdateContainer","description":"The inference configuration updates to apply on the API call","x-found-in":"body"}},"required":["model_id","docs"],"description":"Evaluate a trained model."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.infer_trained_model","type":"object","properties":{"docs":{"type":"array","items":{"type":"object","additionalProperties":{}},"description":"An array of objects to pass to the model for inference. The objects should contain a fields matching your\nconfigured trained model input. Typically, for NLP models, the field name is `text_field`.\nCurrently, for NLP models, only a single value is allowed.","x-found-in":"body"},"inference_config":{"$ref":"./ml._types.json#/$defs/ml._types__InferenceConfigUpdateContainer","description":"The inference configuration updates to apply on the API call","x-found-in":"body"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Controls the amount of time to wait for inference results.","x-found-in":"query"},"model_id":{"type":"string","description":"The unique identifier of the trained model.","x-found-in":"path"}},"required":["model_id","docs"],"description":"Evaluate a trained model."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.open_job","type":"object","properties":{"job_id":{"type":"string","description":"Identifier for the anomaly detection job.","x-found-in":"path"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Refer to the description for the `timeout` query parameter.","x-found-in":"body"}},"required":["job_id"],"description":"Open anomaly detection jobs.\n\nAn anomaly detection job must be opened to be ready to receive and analyze\ndata. It can be opened and closed multiple times throughout its lifecycle.\nWhen you open a new job, it starts with an empty model.\nWhen you open an existing job, the most recent model state is automatically\nloaded. The job is ready to resume its analysis from where it left off, once\nnew data is received."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.open_job","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Controls the time to wait until a job has opened.","x-found-in":"query"},"job_id":{"type":"string","description":"Identifier for the anomaly detection job.","x-found-in":"path"}},"required":["job_id"],"description":"Open anomaly detection jobs.\n\nAn anomaly detection job must be opened to be ready to receive and analyze\ndata. It can be opened and closed multiple times throughout its lifecycle.\nWhen you open a new job, it starts with an empty model.\nWhen you open an existing job, the most recent model state is automatically\nloaded. The job is ready to resume its analysis from where it left off, once\nnew data is received."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.post_calendar_events","type":"object","properties":{"calendar_id":{"type":"string","description":"A string that uniquely identifies a calendar.","x-found-in":"path"},"events":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__CalendarEvent"},"description":"A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format.","x-found-in":"body"}},"required":["calendar_id","events"],"description":"Add scheduled events to the calendar."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.post_calendar_events","type":"object","properties":{"events":{"type":"array","items":{"$ref":"./ml._types.json#/$defs/ml._types__CalendarEvent"},"description":"A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format.","x-found-in":"body"},"calendar_id":{"type":"string","description":"A string that uniquely identifies a calendar.","x-found-in":"path"}},"required":["calendar_id","events"],"description":"Add scheduled events to the calendar."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.post_data","type":"object","properties":{"job_id":{"type":"string","description":"Identifier for the anomaly detection job. The job must have a state of open to receive and process the data.","x-found-in":"path"},"reset_end":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Specifies the end of the bucket resetting range.","x-found-in":"query"},"reset_start":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Specifies the start of the bucket resetting range.","x-found-in":"query"}},"required":["job_id"],"description":"Send data to an anomaly detection job for analysis.\n\nIMPORTANT: For each job, data can be accepted from only a single connection at a time.\nIt is not currently possible to post data to multiple jobs using wildcards or a comma-separated list."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.post_data","type":"object","properties":{"reset_end":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Specifies the end of the bucket resetting range.","x-found-in":"query"},"reset_start":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Specifies the start of the bucket resetting range.","x-found-in":"query"},"job_id":{"type":"string","description":"Identifier for the anomaly detection job. The job must have a state of open to receive and process the data.","x-found-in":"path"}},"required":["job_id"],"description":"Send data to an anomaly detection job for analysis.\n\nIMPORTANT: For each job, data can be accepted from only a single connection at a time.\nIt is not currently possible to post data to multiple jobs using wildcards or a comma-separated list."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.preview_data_frame_analytics","type":"object","properties":{"id":{"type":"string","description":"Identifier for the data frame analytics job.","x-found-in":"path"},"config":{"$ref":"./ml.preview_data_frame_analytics.json#/$defs/ml.preview_data_frame_analytics__DataframePreviewConfig","description":"A data frame analytics config as described in create data frame analytics\njobs. Note that `id` and `dest` don’t need to be provided in the context of\nthis API.","x-found-in":"body"}},"description":"Preview features used by data frame analytics.\n\nPreview the extracted features used by a data frame analytics config."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.preview_data_frame_analytics","type":"object","properties":{"config":{"$ref":"./ml.preview_data_frame_analytics.json#/$defs/ml.preview_data_frame_analytics__DataframePreviewConfig","description":"A data frame analytics config as described in create data frame analytics\njobs. Note that `id` and `dest` don’t need to be provided in the context of\nthis API.","x-found-in":"body"},"id":{"type":"string","description":"Identifier for the data frame analytics job.","x-found-in":"path"}},"description":"Preview features used by data frame analytics.\n\nPreview the extracted features used by a data frame analytics config."}

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

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

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.put_calendar","type":"object","properties":{"calendar_id":{"type":"string","description":"A string that uniquely identifies a calendar.","x-found-in":"path"},"job_ids":{"type":"array","items":{"type":"string"},"description":"An array of anomaly detection job identifiers.","x-found-in":"body"},"description":{"type":"string","description":"A description of the calendar.","x-found-in":"body"}},"required":["calendar_id"],"description":"Create a calendar."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.put_calendar","type":"object","properties":{"job_ids":{"type":"array","items":{"type":"string"},"description":"An array of anomaly detection job identifiers.","x-found-in":"body"},"description":{"type":"string","description":"A description of the calendar.","x-found-in":"body"},"calendar_id":{"type":"string","description":"A string that uniquely identifies a calendar.","x-found-in":"path"}},"required":["calendar_id"],"description":"Create a calendar."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.put_data_frame_analytics","type":"object","properties":{"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"},"allow_lazy_start":{"type":"boolean","description":"Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node. If\nset to `false` and a machine learning node with capacity to run the job\ncannot be immediately found, the API returns an error. If set to `true`,\nthe API does not return an error; the job waits in the `starting` state\nuntil sufficient machine learning node capacity is available. This\nbehavior is also affected by the cluster-wide\n`xpack.ml.max_lazy_ml_nodes` setting.","x-found-in":"body"},"analysis":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisContainer","description":"The analysis configuration, which contains the information necessary to\nperform one of the following types of analysis: classification, outlier\ndetection, or regression.","x-found-in":"body"},"analyzed_fields":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisAnalyzedFields","description":"Specifies `includes` and/or `excludes` patterns to select which fields\nwill be included in the analysis. The patterns specified in `excludes`\nare applied last, therefore `excludes` takes precedence. In other words,\nif the same field is specified in both `includes` and `excludes`, then\nthe field will not be included in the analysis. If `analyzed_fields` is\nnot set, only the relevant fields will be included. For example, all the\nnumeric fields for outlier detection.\nThe supported fields vary for each type of analysis. Outlier detection\nrequires numeric or `boolean` data to analyze. The algorithms don’t\nsupport missing values therefore fields that have data types other than\nnumeric or boolean are ignored. Documents where included fields contain\nmissing values, null values, or an array are also ignored. Therefore the\n`dest` index may contain documents that don’t have an outlier score.\nRegression supports fields that are numeric, `boolean`, `text`,\n`keyword`, and `ip` data types. It is also tolerant of missing values.\nFields that are supported are included in the analysis, other fields are\nignored. Documents where included fields contain an array with two or\nmore values are also ignored. Documents in the `dest` index that don’t\ncontain a results field are not included in the regression analysis.\nClassification supports fields that are numeric, `boolean`, `text`,\n`keyword`, and `ip` data types. It is also tolerant of missing values.\nFields that are supported are included in the analysis, other fields are\nignored. Documents where included fields contain an array with two or\nmore values are also ignored. Documents in the `dest` index that don’t\ncontain a results field are not included in the classification analysis.\nClassification analysis can be improved by mapping ordinal variable\nvalues to a single number. For example, in case of age ranges, you can\nmodel the values as `0-14 = 0`, `15-24 = 1`, `25-34 = 2`, and so on.","x-found-in":"body"},"description":{"type":"string","description":"A description of the job.","x-found-in":"body"},"dest":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalyticsDestination","description":"The destination configuration.","x-found-in":"body"},"max_num_threads":{"type":"number","description":"The maximum number of threads to be used by the analysis. Using more\nthreads may decrease the time necessary to complete the analysis at the\ncost of using more CPU. Note that the process may use additional threads\nfor operational functionality other than the analysis itself.","x-found-in":"body"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","x-found-in":"body"},"model_memory_limit":{"type":"string","description":"The approximate maximum amount of memory resources that are permitted for\nanalytical processing. If your `elasticsearch.yml` file contains an\n`xpack.ml.max_model_memory_limit` setting, an error occurs when you try\nto create data frame analytics jobs that have `model_memory_limit` values\ngreater than that setting.","x-found-in":"body"},"source":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalyticsSource","description":"The configuration of how to source the analysis data.","x-found-in":"body"},"headers":{"$ref":"./_types.json#/$defs/_types__HttpHeaders","x-found-in":"body"},"version":{"type":"string","x-found-in":"body"}},"required":["id","analysis","dest","source"],"description":"Create a data frame analytics job.\n\nThis API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.\nBy default, the query used in the source configuration is `{\"match_all\": {}}`.\n\nIf the destination index does not exist, it is created automatically when you start the job.\n\nIf you supply only a subset of the regression or classification parameters, hyperparameter optimization occurs. It determines a value for each of the undefined parameters."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.put_data_frame_analytics","type":"object","properties":{"allow_lazy_start":{"type":"boolean","description":"Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node. If\nset to `false` and a machine learning node with capacity to run the job\ncannot be immediately found, the API returns an error. If set to `true`,\nthe API does not return an error; the job waits in the `starting` state\nuntil sufficient machine learning node capacity is available. This\nbehavior is also affected by the cluster-wide\n`xpack.ml.max_lazy_ml_nodes` setting.","x-found-in":"body"},"analysis":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisContainer","description":"The analysis configuration, which contains the information necessary to\nperform one of the following types of analysis: classification, outlier\ndetection, or regression.","x-found-in":"body"},"analyzed_fields":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalysisAnalyzedFields","description":"Specifies `includes` and/or `excludes` patterns to select which fields\nwill be included in the analysis. The patterns specified in `excludes`\nare applied last, therefore `excludes` takes precedence. In other words,\nif the same field is specified in both `includes` and `excludes`, then\nthe field will not be included in the analysis. If `analyzed_fields` is\nnot set, only the relevant fields will be included. For example, all the\nnumeric fields for outlier detection.\nThe supported fields vary for each type of analysis. Outlier detection\nrequires numeric or `boolean` data to analyze. The algorithms don’t\nsupport missing values therefore fields that have data types other than\nnumeric or boolean are ignored. Documents where included fields contain\nmissing values, null values, or an array are also ignored. Therefore the\n`dest` index may contain documents that don’t have an outlier score.\nRegression supports fields that are numeric, `boolean`, `text`,\n`keyword`, and `ip` data types. It is also tolerant of missing values.\nFields that are supported are included in the analysis, other fields are\nignored. Documents where included fields contain an array with two or\nmore values are also ignored. Documents in the `dest` index that don’t\ncontain a results field are not included in the regression analysis.\nClassification supports fields that are numeric, `boolean`, `text`,\n`keyword`, and `ip` data types. It is also tolerant of missing values.\nFields that are supported are included in the analysis, other fields are\nignored. Documents where included fields contain an array with two or\nmore values are also ignored. Documents in the `dest` index that don’t\ncontain a results field are not included in the classification analysis.\nClassification analysis can be improved by mapping ordinal variable\nvalues to a single number. For example, in case of age ranges, you can\nmodel the values as `0-14 = 0`, `15-24 = 1`, `25-34 = 2`, and so on.","x-found-in":"body"},"description":{"type":"string","description":"A description of the job.","x-found-in":"body"},"dest":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalyticsDestination","description":"The destination configuration.","x-found-in":"body"},"max_num_threads":{"type":"number","description":"The maximum number of threads to be used by the analysis. Using more\nthreads may decrease the time necessary to complete the analysis at the\ncost of using more CPU. Note that the process may use additional threads\nfor operational functionality other than the analysis itself.","x-found-in":"body"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","x-found-in":"body"},"model_memory_limit":{"type":"string","description":"The approximate maximum amount of memory resources that are permitted for\nanalytical processing. If your `elasticsearch.yml` file contains an\n`xpack.ml.max_model_memory_limit` setting, an error occurs when you try\nto create data frame analytics jobs that have `model_memory_limit` values\ngreater than that setting.","x-found-in":"body"},"source":{"$ref":"./ml._types.json#/$defs/ml._types__DataframeAnalyticsSource","description":"The configuration of how to source the analysis data.","x-found-in":"body"},"headers":{"$ref":"./_types.json#/$defs/_types__HttpHeaders","x-found-in":"body"},"version":{"type":"string","x-found-in":"body"},"id":{"type":"string","description":"Identifier for the data frame analytics job. This identifier can contain\nlowercase alphanumeric characters (a-z and 0-9), hyphens, and\nunderscores. It must start and end with alphanumeric characters.","x-found-in":"path"}},"required":["id","analysis","dest","source"],"description":"Create a data frame analytics job.\n\nThis API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.\nBy default, the query used in the source configuration is `{\"match_all\": {}}`.\n\nIf the destination index does not exist, it is created automatically when you start the job.\n\nIf you supply only a subset of the regression or classification parameters, hyperparameter optimization occurs. It determines a value for each of the undefined parameters."}

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

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

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.put_filter","type":"object","properties":{"filter_id":{"type":"string","description":"A string that uniquely identifies a filter.","x-found-in":"path"},"description":{"type":"string","description":"A description of the filter.","x-found-in":"body"},"items":{"type":"array","items":{"type":"string"},"description":"The items of the filter. A wildcard `*` can be used at the beginning or the end of an item.\nUp to 10000 items are allowed in each filter.","x-found-in":"body"}},"required":["filter_id"],"description":"Create a filter.\n\nA filter contains a list of strings. It can be used by one or more anomaly detection jobs.\nSpecifically, filters are referenced in the `custom_rules` property of detector configuration objects."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ml.put_filter","type":"object","properties":{"description":{"type":"string","description":"A description of the filter.","x-found-in":"body"},"items":{"type":"array","items":{"type":"string"},"description":"The items of the filter. A wildcard `*` can be used at the beginning or the end of an item.\nUp to 10000 items are allowed in each filter.","x-found-in":"body"},"filter_id":{"type":"string","description":"A string that uniquely identifies a filter.","x-found-in":"path"}},"required":["filter_id"],"description":"Create a filter.\n\nA filter contains a list of strings. It can be used by one or more anomaly detection jobs.\nSpecifically, filters are referenced in the `custom_rules` property of detector configuration objects."}

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

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