From dd6131cda973c5fec3cce15d0b0358c6969e0547 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Fri, 2 Aug 2024 16:45:10 +0200 Subject: [PATCH 1/5] Reviews summaries of ML APIs (F-Z). --- specification/ml/flush_job/MlFlushJobRequest.ts | 2 +- specification/ml/forecast/MlForecastJobRequest.ts | 6 +++--- specification/ml/get_buckets/MlGetBucketsRequest.ts | 2 +- .../ml/get_calendar_events/MlGetCalendarEventsRequest.ts | 2 +- specification/ml/get_calendars/MlGetCalendarsRequest.ts | 2 +- specification/ml/get_categories/MlGetCategoriesRequest.ts | 2 +- .../MlGetDataFrameAnalyticsRequest.ts | 2 +- .../MlGetDataFrameAnalyticsStatsRequest.ts | 2 +- .../ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts | 2 +- specification/ml/get_datafeeds/MlGetDatafeedsRequest.ts | 2 +- specification/ml/get_filters/MlGetFiltersRequest.ts | 2 +- specification/ml/get_influencers/MlGetInfluencersRequest.ts | 2 +- specification/ml/get_job_stats/MlGetJobStatsRequest.ts | 2 +- specification/ml/get_jobs/MlGetJobsRequest.ts | 2 +- .../ml/get_memory_stats/MlGetMemoryStatsRequest.ts | 1 + .../MlGetModelSnapshotUpgradeStatsRequest.ts | 2 +- .../ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts | 2 +- .../ml/get_overall_buckets/MlGetOverallBucketsRequest.ts | 4 +++- specification/ml/get_records/MlGetAnomalyRecordsRequest.ts | 2 +- .../ml/get_trained_models/MlGetTrainedModelRequest.ts | 2 +- .../MlGetTrainedModelStatsRequest.ts | 3 ++- .../ml/infer_trained_model/MlInferTrainedModelRequest.ts | 2 +- specification/ml/info/MlInfoRequest.ts | 1 + specification/ml/open_job/MlOpenJobRequest.ts | 5 ++--- .../ml/post_calendar_events/MlPostCalendarEventsRequest.ts | 2 +- specification/ml/post_data/MlPostJobDataRequest.ts | 2 +- .../MlPreviewDataFrameAnalyticsRequest.ts | 2 +- .../ml/preview_datafeed/MlPreviewDatafeedRequest.ts | 2 +- specification/ml/put_calendar/MlPutCalendarRequest.ts | 2 +- .../ml/put_calendar_job/MlPutCalendarJobRequest.ts | 2 +- .../MlPutDataFrameAnalyticsRequest.ts | 2 +- specification/ml/put_datafeed/MlPutDatafeedRequest.ts | 2 +- specification/ml/put_filter/MlPutFilterRequest.ts | 2 +- .../ml/put_trained_model/MlPutTrainedModelRequest.ts | 2 +- .../MlPutTrainedModelAliasRequest.ts | 5 +++-- .../MlPutTrainedModelDefinitionPartRequest.ts | 2 +- .../MlPutTrainedModelVocabularyRequest.ts | 2 +- specification/ml/reset_job/MlResetJobRequest.ts | 2 +- .../revert_model_snapshot/MlRevertModelSnapshotRequest.ts | 2 +- .../ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts | 1 + .../MlStartDataFrameAnalyticsRequest.ts | 2 +- specification/ml/start_datafeed/MlStartDatafeedRequest.ts | 2 +- .../MlStartTrainedModelDeploymentRequest.ts | 3 ++- .../MlStopDataFrameAnalyticsRequest.ts | 2 +- specification/ml/stop_datafeed/MlStopDatafeedRequest.ts | 2 +- .../MlStopTrainedModelDeploymentRequest.ts | 2 +- .../MlUpdateDataFrameAnalyticsRequest.ts | 2 +- specification/ml/update_datafeed/MlUpdateDatafeedRequest.ts | 2 +- specification/ml/update_filter/MlUpdateFilterRequest.ts | 1 + specification/ml/update_job/MlUpdateJobRequest.ts | 1 + .../update_model_snapshot/MlUpdateModelSnapshotRequest.ts | 1 + .../MlUpdateTrainedModelDeploymentRequest.ts | 2 +- .../ml/upgrade_job_snapshot/MlUpgradeJobSnapshotRequest.ts | 1 + 53 files changed, 62 insertions(+), 51 deletions(-) diff --git a/specification/ml/flush_job/MlFlushJobRequest.ts b/specification/ml/flush_job/MlFlushJobRequest.ts index 89d2b2c247..f4dc0f88fb 100644 --- a/specification/ml/flush_job/MlFlushJobRequest.ts +++ b/specification/ml/flush_job/MlFlushJobRequest.ts @@ -22,7 +22,7 @@ import { Id } from '@_types/common' import { DateTime } from '@_types/Time' /** - * Forces any buffered data to be processed by the job. + * Force buffered data to be processed. * The flush jobs API is only applicable when sending data for analysis using * the post data API. Depending on the content of the buffer, then it might * additionally calculate new results. Both flush and close operations are diff --git a/specification/ml/forecast/MlForecastJobRequest.ts b/specification/ml/forecast/MlForecastJobRequest.ts index 85eb1e31c3..ee702ffa1e 100644 --- a/specification/ml/forecast/MlForecastJobRequest.ts +++ b/specification/ml/forecast/MlForecastJobRequest.ts @@ -22,12 +22,12 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** - * Predicts the future behavior of a time series by using its historical - * behavior. + * Predict future behavior of a time series. * * Forecasts are not supported for jobs that perform population analysis; an * error occurs if you try to create a forecast for a job that has an - * `over_field_name` in its configuration. + * `over_field_name` in its configuration. Forcasts predict future behavior + * based on historical data. * * @rest_spec_name ml.forecast * @availability stack since=6.1.0 stability=stable diff --git a/specification/ml/get_buckets/MlGetBucketsRequest.ts b/specification/ml/get_buckets/MlGetBucketsRequest.ts index dc838a9387..e088eaf540 100644 --- a/specification/ml/get_buckets/MlGetBucketsRequest.ts +++ b/specification/ml/get_buckets/MlGetBucketsRequest.ts @@ -24,7 +24,7 @@ import { double, integer } from '@_types/Numeric' import { DateTime } from '@_types/Time' /** - * Retrieves anomaly detection job results for one or more buckets. + * Get anomaly detection job results. * The API presents a chronological view of the records, grouped by bucket. * @rest_spec_name ml.get_buckets * @availability stack since=5.4.0 stability=stable diff --git a/specification/ml/get_calendar_events/MlGetCalendarEventsRequest.ts b/specification/ml/get_calendar_events/MlGetCalendarEventsRequest.ts index 8c360937a0..6d3582f0da 100644 --- a/specification/ml/get_calendar_events/MlGetCalendarEventsRequest.ts +++ b/specification/ml/get_calendar_events/MlGetCalendarEventsRequest.ts @@ -23,7 +23,7 @@ import { integer } from '@_types/Numeric' import { DateTime } from '@_types/Time' /** - * Retrieves information about the scheduled events in calendars. + * Get info about events in calendars. * @rest_spec_name ml.get_calendar_events * @availability stack since=6.2.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/get_calendars/MlGetCalendarsRequest.ts b/specification/ml/get_calendars/MlGetCalendarsRequest.ts index 9a733fdd8d..15188181c4 100644 --- a/specification/ml/get_calendars/MlGetCalendarsRequest.ts +++ b/specification/ml/get_calendars/MlGetCalendarsRequest.ts @@ -23,7 +23,7 @@ import { Id } from '@_types/common' import { integer } from '@_types/Numeric' /** - * Retrieves configuration information for calendars. + * Get config info for calendars. * @rest_spec_name ml.get_calendars * @availability stack since=6.2.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/get_categories/MlGetCategoriesRequest.ts b/specification/ml/get_categories/MlGetCategoriesRequest.ts index bd0b4fea02..a721d0879e 100644 --- a/specification/ml/get_categories/MlGetCategoriesRequest.ts +++ b/specification/ml/get_categories/MlGetCategoriesRequest.ts @@ -23,7 +23,7 @@ import { CategoryId, Id } from '@_types/common' import { integer } from '@_types/Numeric' /** - * Retrieves anomaly detection job results for one or more categories. + * Get anomaly detection job results for categories. * @rest_spec_name ml.get_categories * @availability stack since=5.4.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts b/specification/ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts index 65e1be95a9..76b4ab00b5 100644 --- a/specification/ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts +++ b/specification/ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts @@ -22,7 +22,7 @@ import { Id } from '@_types/common' import { integer } from '@_types/Numeric' /** - * Retrieves configuration information for data frame analytics jobs. + * Get config info for data frame analytics jobs. * You can get information for multiple data frame analytics jobs in a single * API request by using a comma-separated list of data frame analytics jobs or a * wildcard expression. diff --git a/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts b/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts index ba721848bd..2726767eb3 100644 --- a/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts +++ b/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts @@ -22,7 +22,7 @@ import { Id } from '@_types/common' import { integer } from '@_types/Numeric' /** - * Retrieves usage information for data frame analytics jobs. + * Get usage info for data frame analytics jobs. * @rest_spec_name ml.get_data_frame_analytics_stats * @availability stack since=7.3.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts b/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts index 89f488c86d..feae26df31 100644 --- a/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts +++ b/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Ids } from '@_types/common' /** - * Retrieves usage information for datafeeds. + * Get usage info for datafeeds. * You can get statistics for multiple datafeeds in a single API request by * using a comma-separated list of datafeeds or a wildcard expression. You can * get statistics for all datafeeds by using `_all`, by specifying `*` as the diff --git a/specification/ml/get_datafeeds/MlGetDatafeedsRequest.ts b/specification/ml/get_datafeeds/MlGetDatafeedsRequest.ts index 0d325812f2..6770056a7a 100644 --- a/specification/ml/get_datafeeds/MlGetDatafeedsRequest.ts +++ b/specification/ml/get_datafeeds/MlGetDatafeedsRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Ids } from '@_types/common' /** - * Retrieves configuration information for datafeeds. + * Get config info for datafeeds. * You can get information for multiple datafeeds in a single API request by * using a comma-separated list of datafeeds or a wildcard expression. You can * get information for all datafeeds by using `_all`, by specifying `*` as the diff --git a/specification/ml/get_filters/MlGetFiltersRequest.ts b/specification/ml/get_filters/MlGetFiltersRequest.ts index 23f6729edb..65c78dc4f7 100644 --- a/specification/ml/get_filters/MlGetFiltersRequest.ts +++ b/specification/ml/get_filters/MlGetFiltersRequest.ts @@ -22,7 +22,7 @@ import { Ids } from '@_types/common' import { integer } from '@_types/Numeric' /** - * Retrieves filters. + * Get filters. * You can get a single filter or all filters. * @rest_spec_name ml.get_filters * @availability stack since=5.5.0 stability=stable diff --git a/specification/ml/get_influencers/MlGetInfluencersRequest.ts b/specification/ml/get_influencers/MlGetInfluencersRequest.ts index e8a431d3ec..c2bd06f2fb 100644 --- a/specification/ml/get_influencers/MlGetInfluencersRequest.ts +++ b/specification/ml/get_influencers/MlGetInfluencersRequest.ts @@ -24,7 +24,7 @@ import { double, integer } from '@_types/Numeric' import { DateTime } from '@_types/Time' /** - * Retrieves anomaly detection job results for one or more influencers. + * Get anomaly detection job results for influencers. * Influencers are the entities that have contributed to, or are to blame for, * the anomalies. Influencer results are available only if an * `influencer_field_name` is specified in the job configuration. diff --git a/specification/ml/get_job_stats/MlGetJobStatsRequest.ts b/specification/ml/get_job_stats/MlGetJobStatsRequest.ts index ee2570628d..d1f09d96c6 100644 --- a/specification/ml/get_job_stats/MlGetJobStatsRequest.ts +++ b/specification/ml/get_job_stats/MlGetJobStatsRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Retrieves usage information for anomaly detection jobs. + * Get usage info for anomaly detection jobs. * @rest_spec_name ml.get_job_stats * @availability stack since=5.5.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/get_jobs/MlGetJobsRequest.ts b/specification/ml/get_jobs/MlGetJobsRequest.ts index 00d3108bd8..3a425dd875 100644 --- a/specification/ml/get_jobs/MlGetJobsRequest.ts +++ b/specification/ml/get_jobs/MlGetJobsRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Ids } from '@_types/common' /** - * Retrieves configuration information for anomaly detection jobs. + * Get config info for anomaly detection jobs. * You can get information for multiple anomaly detection jobs in a single API * request by using a group name, a comma-separated list of jobs, or a wildcard * expression. You can get information for all anomaly detection jobs by using diff --git a/specification/ml/get_memory_stats/MlGetMemoryStatsRequest.ts b/specification/ml/get_memory_stats/MlGetMemoryStatsRequest.ts index c9f470bcc0..338d6c081d 100644 --- a/specification/ml/get_memory_stats/MlGetMemoryStatsRequest.ts +++ b/specification/ml/get_memory_stats/MlGetMemoryStatsRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** + * Get info on machine learning memory usage. * Get information about how machine learning jobs and trained models are using memory, * on each node, both within the JVM heap, and natively, outside of the JVM. * @rest_spec_name ml.get_memory_stats diff --git a/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts b/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts index 74e101b714..bf8f3ba2d1 100644 --- a/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts +++ b/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Retrieves usage information for anomaly detection job model snapshot upgrades. + * Get usage info for anomaly detection job model snapshot upgrades. * @rest_spec_name ml.get_model_snapshot_upgrade_stats * @availability stack since=7.16.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts b/specification/ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts index 582afce371..b1aa2d5287 100644 --- a/specification/ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts +++ b/specification/ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts @@ -24,7 +24,7 @@ import { integer } from '@_types/Numeric' import { Duration, DateTime } from '@_types/Time' /** - * Retrieves information about model snapshots. + * Get info about model snapshots. * @rest_spec_name ml.get_model_snapshots * @availability stack since=5.4.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/ml/get_overall_buckets/MlGetOverallBucketsRequest.ts b/specification/ml/get_overall_buckets/MlGetOverallBucketsRequest.ts index e5ad71713e..b32da76bee 100644 --- a/specification/ml/get_overall_buckets/MlGetOverallBucketsRequest.ts +++ b/specification/ml/get_overall_buckets/MlGetOverallBucketsRequest.ts @@ -23,7 +23,9 @@ import { double, integer } from '@_types/Numeric' import { Duration, DateTime } from '@_types/Time' /** - * Retrieves overall bucket results that summarize the bucket results of + * Get overall bucket results. + * + * Retrievs overall bucket results that summarize the bucket results of * multiple anomaly detection jobs. * * The `overall_score` is calculated by combining the scores of all the diff --git a/specification/ml/get_records/MlGetAnomalyRecordsRequest.ts b/specification/ml/get_records/MlGetAnomalyRecordsRequest.ts index d64d83937b..277a562a8d 100644 --- a/specification/ml/get_records/MlGetAnomalyRecordsRequest.ts +++ b/specification/ml/get_records/MlGetAnomalyRecordsRequest.ts @@ -24,7 +24,7 @@ import { double, integer } from '@_types/Numeric' import { DateTime } from '@_types/Time' /** - * Retrieves anomaly records for an anomaly detection job. + * Get anomaly records for an anomaly detection job. * Records contain the detailed analytical results. They describe the anomalous * activity that has been identified in the input data based on the detector * configuration. diff --git a/specification/ml/get_trained_models/MlGetTrainedModelRequest.ts b/specification/ml/get_trained_models/MlGetTrainedModelRequest.ts index 633c4e6a7e..caeefc52bc 100644 --- a/specification/ml/get_trained_models/MlGetTrainedModelRequest.ts +++ b/specification/ml/get_trained_models/MlGetTrainedModelRequest.ts @@ -23,7 +23,7 @@ import { integer } from '@_types/Numeric' import { Include } from '@ml/_types/Include' /** - * Retrieves configuration information for a trained model. + * Get config info for a trained model. * @rest_spec_name ml.get_trained_models * @availability stack since=7.10.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts b/specification/ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts index 07edb981c3..dc3dc36263 100644 --- a/specification/ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts +++ b/specification/ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts @@ -22,7 +22,8 @@ import { Ids } from '@_types/common' import { integer } from '@_types/Numeric' /** - * Retrieves usage information for trained models. You can get usage information for multiple trained + * get usage info for trained models. + * You can get usage information for multiple trained * models in a single API request by using a comma-separated list of model IDs or a wildcard expression. * @rest_spec_name ml.get_trained_models_stats * @availability stack since=7.10.0 stability=stable diff --git a/specification/ml/infer_trained_model/MlInferTrainedModelRequest.ts b/specification/ml/infer_trained_model/MlInferTrainedModelRequest.ts index 01d02298f5..1d56a85148 100644 --- a/specification/ml/infer_trained_model/MlInferTrainedModelRequest.ts +++ b/specification/ml/infer_trained_model/MlInferTrainedModelRequest.ts @@ -25,7 +25,7 @@ import { InferenceConfigUpdateContainer } from '@ml/_types/inference' import { UserDefinedValue } from '@spec_utils/UserDefinedValue' /** - * Evaluates a trained model. + * Evaluate a trained model. * @rest_spec_name ml.infer_trained_model * @availability stack since=8.3.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/info/MlInfoRequest.ts b/specification/ml/info/MlInfoRequest.ts index fee95bfc07..17ba0702d3 100644 --- a/specification/ml/info/MlInfoRequest.ts +++ b/specification/ml/info/MlInfoRequest.ts @@ -20,6 +20,7 @@ import { RequestBase } from '@_types/Base' /** + * Return ML defaults and limits. * Returns defaults and limits used by machine learning. * This endpoint is designed to be used by a user interface that needs to fully * understand machine learning configurations where some options are not diff --git a/specification/ml/open_job/MlOpenJobRequest.ts b/specification/ml/open_job/MlOpenJobRequest.ts index 9813f14700..b2cfa93aaf 100644 --- a/specification/ml/open_job/MlOpenJobRequest.ts +++ b/specification/ml/open_job/MlOpenJobRequest.ts @@ -23,9 +23,8 @@ import { Duration } from '@_types/Time' /** * Open anomaly detection jobs. - * An anomaly detection job must be opened in order for it to be ready to - * receive and analyze data. It can be opened and closed multiple times - * throughout its lifecycle. + * An anomaly detection job must be opened to be ready to receive and analyze + * data. It can be opened and closed multiple times throughout its lifecycle. * When you open a new job, it starts with an empty model. * When you open an existing job, the most recent model state is automatically * loaded. The job is ready to resume its analysis from where it left off, once diff --git a/specification/ml/post_calendar_events/MlPostCalendarEventsRequest.ts b/specification/ml/post_calendar_events/MlPostCalendarEventsRequest.ts index da39ad5e77..8808457422 100644 --- a/specification/ml/post_calendar_events/MlPostCalendarEventsRequest.ts +++ b/specification/ml/post_calendar_events/MlPostCalendarEventsRequest.ts @@ -22,7 +22,7 @@ import { Id } from '@_types/common' import { CalendarEvent } from '../_types/CalendarEvent' /** - * Adds scheduled events to a calendar. + * Add scheduled events to calendar. * @rest_spec_name ml.post_calendar_events * @availability stack since=6.2.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/post_data/MlPostJobDataRequest.ts b/specification/ml/post_data/MlPostJobDataRequest.ts index 386bccef1a..fe6bdc1c8d 100644 --- a/specification/ml/post_data/MlPostJobDataRequest.ts +++ b/specification/ml/post_data/MlPostJobDataRequest.ts @@ -22,7 +22,7 @@ import { Id } from '@_types/common' import { DateTime } from '@_types/Time' /** - * Sends data to an anomaly detection job for analysis. + * Send data to an anomaly detection job for analysis. * * IMPORTANT: For each job, data can be accepted from only a single connection at a time. * It is not currently possible to post data to multiple jobs using wildcards or a comma-separated list. diff --git a/specification/ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts b/specification/ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts index f33f791c98..3c5515e50d 100644 --- a/specification/ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts +++ b/specification/ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts @@ -22,7 +22,7 @@ import { Id } from '@_types/common' import { DataframePreviewConfig } from './types' /** - * Previews the extracted features used by a data frame analytics config. + * Preview the extracted features used by a data frame analytics config. * @rest_spec_name ml.preview_data_frame_analytics * @availability stack since=7.13.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/preview_datafeed/MlPreviewDatafeedRequest.ts b/specification/ml/preview_datafeed/MlPreviewDatafeedRequest.ts index 95eeab1458..a1934d58df 100644 --- a/specification/ml/preview_datafeed/MlPreviewDatafeedRequest.ts +++ b/specification/ml/preview_datafeed/MlPreviewDatafeedRequest.ts @@ -24,7 +24,7 @@ import { JobConfig } from '@ml/_types/Job' import { DateTime } from '@_types/Time' /** - * Previews a datafeed. + * Preview a datafeed. * This API returns the first "page" of search results from a datafeed. * You can preview an existing datafeed or provide configuration details for a datafeed * and anomaly detection job in the API. The preview shows the structure of the data diff --git a/specification/ml/put_calendar/MlPutCalendarRequest.ts b/specification/ml/put_calendar/MlPutCalendarRequest.ts index 0846c4b622..41879b6bc1 100644 --- a/specification/ml/put_calendar/MlPutCalendarRequest.ts +++ b/specification/ml/put_calendar/MlPutCalendarRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Creates a calendar. + * Create a calendar. * @rest_spec_name ml.put_calendar * @availability stack since=6.2.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/put_calendar_job/MlPutCalendarJobRequest.ts b/specification/ml/put_calendar_job/MlPutCalendarJobRequest.ts index d02679327d..6b9a713c24 100644 --- a/specification/ml/put_calendar_job/MlPutCalendarJobRequest.ts +++ b/specification/ml/put_calendar_job/MlPutCalendarJobRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Id, Ids } from '@_types/common' /** - * Adds an anomaly detection job to a calendar. + * Add anomaly detection job to calendar. * @rest_spec_name ml.put_calendar_job * @availability stack since=6.2.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/put_data_frame_analytics/MlPutDataFrameAnalyticsRequest.ts b/specification/ml/put_data_frame_analytics/MlPutDataFrameAnalyticsRequest.ts index 0627e16a20..dc9cf21434 100644 --- a/specification/ml/put_data_frame_analytics/MlPutDataFrameAnalyticsRequest.ts +++ b/specification/ml/put_data_frame_analytics/MlPutDataFrameAnalyticsRequest.ts @@ -28,7 +28,7 @@ import { HttpHeaders, Id, VersionString } from '@_types/common' import { integer } from '@_types/Numeric' /** - * Instantiates a data frame analytics job. + * Create a data frame analytics job. * This API creates a data frame analytics job that performs an analysis on the * source indices and stores the outcome in a destination index. * @rest_spec_name ml.put_data_frame_analytics diff --git a/specification/ml/put_datafeed/MlPutDatafeedRequest.ts b/specification/ml/put_datafeed/MlPutDatafeedRequest.ts index f4233d3e10..c3e656d966 100644 --- a/specification/ml/put_datafeed/MlPutDatafeedRequest.ts +++ b/specification/ml/put_datafeed/MlPutDatafeedRequest.ts @@ -35,7 +35,7 @@ import { ScriptField } from '@_types/Scripting' import { Duration } from '@_types/Time' /** - * Instantiates a datafeed. + * Create a datafeed. * Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. * You can associate only one datafeed with each anomaly detection job. * The datafeed contains a query that runs at a defined interval (`frequency`). diff --git a/specification/ml/put_filter/MlPutFilterRequest.ts b/specification/ml/put_filter/MlPutFilterRequest.ts index 6dfccd62ab..3bf02fd54c 100644 --- a/specification/ml/put_filter/MlPutFilterRequest.ts +++ b/specification/ml/put_filter/MlPutFilterRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Instantiates a filter. + * Create a filter. * A filter contains a list of strings. It can be used by one or more anomaly detection jobs. * Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. * @rest_spec_name ml.put_filter diff --git a/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts b/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts index e655d56111..58b4a30b21 100644 --- a/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts +++ b/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts @@ -27,7 +27,7 @@ import { TrainedModelType } from '../_types/TrainedModel' import { InferenceConfigCreateContainer } from '@ml/_types/inference' /** - * Enables you to supply a trained model that is not created by data frame analytics. + * Enable you to supply a trained model that is not created by data frame analytics. * @rest_spec_name ml.put_trained_model * @availability stack since=7.10.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts b/specification/ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts index 920b62f40b..bff6f1d490 100644 --- a/specification/ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts +++ b/specification/ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts @@ -21,8 +21,9 @@ import { RequestBase } from '@_types/Base' import { Id, Name } from '@_types/common' /** - * Creates or updates a trained model alias. A trained model alias is a logical - * name used to reference a single trained model. + * Create or update a trained model alias. + * A trained model alias is a logical name used to reference a single trained + * model. * You can use aliases instead of trained model identifiers to make it easier to * reference your models. For example, you can use aliases in inference * aggregations and processors. diff --git a/specification/ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartRequest.ts b/specification/ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartRequest.ts index ec98c6cf65..c99622bbed 100644 --- a/specification/ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartRequest.ts +++ b/specification/ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartRequest.ts @@ -22,7 +22,7 @@ import { integer, long } from '@_types/Numeric' import { Id } from '@_types/common' /** - * Creates part of a trained model definition. + * Create part of a trained model definition. * @rest_spec_name ml.put_trained_model_definition_part * @availability stack since=8.0.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyRequest.ts b/specification/ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyRequest.ts index c202fb7a3a..3c77f1149e 100644 --- a/specification/ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyRequest.ts +++ b/specification/ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyRequest.ts @@ -22,7 +22,7 @@ import { Id } from '@_types/common' import { double } from '@_types/Numeric' /** - * Creates a trained model vocabulary. + * Create a trained model vocabulary. * This API is supported only for natural language processing (NLP) models. * The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. * @rest_spec_name ml.put_trained_model_vocabulary diff --git a/specification/ml/reset_job/MlResetJobRequest.ts b/specification/ml/reset_job/MlResetJobRequest.ts index 7d736a173a..3e5379aa4a 100644 --- a/specification/ml/reset_job/MlResetJobRequest.ts +++ b/specification/ml/reset_job/MlResetJobRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Resets an anomaly detection job. + * Reset an anomaly detection job. * All model state and results are deleted. The job is ready to start over as if * it had just been created. * It is not currently possible to reset multiple jobs using wildcards or a diff --git a/specification/ml/revert_model_snapshot/MlRevertModelSnapshotRequest.ts b/specification/ml/revert_model_snapshot/MlRevertModelSnapshotRequest.ts index 62a97dee0c..7295273451 100644 --- a/specification/ml/revert_model_snapshot/MlRevertModelSnapshotRequest.ts +++ b/specification/ml/revert_model_snapshot/MlRevertModelSnapshotRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Reverts to a specific snapshot. + * Revert to a snapshot. * The machine learning features react quickly to anomalous input, learning new * behaviors in data. Highly anomalous input increases the variance in the * models whilst the system learns whether this is a new step-change in behavior diff --git a/specification/ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts b/specification/ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts index 73dc9c8655..a27ac244d2 100644 --- a/specification/ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts +++ b/specification/ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' import { Duration } from '@_types/Time' /** + * Set upgrade_mode that prepares ML indices for upgrade. * Sets a cluster wide upgrade_mode setting that prepares machine learning * indices for an upgrade. * When upgrading your cluster, in some circumstances you must restart your diff --git a/specification/ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts b/specification/ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts index e958fabd52..a8dbcac412 100644 --- a/specification/ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts +++ b/specification/ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts @@ -22,7 +22,7 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** - * Starts a data frame analytics job. + * Start a data frame analytics job. * A data frame analytics job can be started and stopped multiple times * throughout its lifecycle. * If the destination index does not exist, it is created automatically the diff --git a/specification/ml/start_datafeed/MlStartDatafeedRequest.ts b/specification/ml/start_datafeed/MlStartDatafeedRequest.ts index a91d742101..d608d396e9 100644 --- a/specification/ml/start_datafeed/MlStartDatafeedRequest.ts +++ b/specification/ml/start_datafeed/MlStartDatafeedRequest.ts @@ -22,7 +22,7 @@ import { Id } from '@_types/common' import { Duration, DateTime } from '@_types/Time' /** - * Starts one or more datafeeds. + * Start one or more datafeeds. * * A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped * multiple times throughout its lifecycle. diff --git a/specification/ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts b/specification/ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts index c1fa2bba77..6956247d56 100644 --- a/specification/ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts +++ b/specification/ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts @@ -27,7 +27,8 @@ import { } from '../_types/TrainedModel' /** - * Starts a trained model deployment, which allocates the model to every machine learning node. + * Start a trained model deployment. + * It allocates the model to every machine learning node. * @rest_spec_name ml.start_trained_model_deployment * @availability stack since=8.0.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts b/specification/ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts index 774b783999..776eb44f9a 100644 --- a/specification/ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts +++ b/specification/ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts @@ -22,7 +22,7 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** - * Stops one or more data frame analytics jobs. + * Stop one or more data frame analytics jobs. * A data frame analytics job can be started and stopped multiple times * throughout its lifecycle. * @rest_spec_name ml.stop_data_frame_analytics diff --git a/specification/ml/stop_datafeed/MlStopDatafeedRequest.ts b/specification/ml/stop_datafeed/MlStopDatafeedRequest.ts index 4965fa789e..ff8964d5e5 100644 --- a/specification/ml/stop_datafeed/MlStopDatafeedRequest.ts +++ b/specification/ml/stop_datafeed/MlStopDatafeedRequest.ts @@ -22,7 +22,7 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** - * Stops one or more datafeeds. + * Stop one or more datafeeds. * A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped * multiple times throughout its lifecycle. * @rest_spec_name ml.stop_datafeed diff --git a/specification/ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts b/specification/ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts index 4339760a5e..7e4abf90a2 100644 --- a/specification/ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts +++ b/specification/ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Stops a trained model deployment. + * Stop a trained model deployment. * @rest_spec_name ml.stop_trained_model_deployment * @availability stack since=8.0.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts b/specification/ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts index c72c6f8043..cd0a53c19d 100644 --- a/specification/ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts +++ b/specification/ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts @@ -22,7 +22,7 @@ import { Id } from '@_types/common' import { integer } from '@_types/Numeric' /** - * Updates an existing data frame analytics job. + * Update a data frame analytics job. * @rest_spec_name ml.update_data_frame_analytics * @availability stack since=7.3.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/update_datafeed/MlUpdateDatafeedRequest.ts b/specification/ml/update_datafeed/MlUpdateDatafeedRequest.ts index 8fd8bad554..c1f55f7994 100644 --- a/specification/ml/update_datafeed/MlUpdateDatafeedRequest.ts +++ b/specification/ml/update_datafeed/MlUpdateDatafeedRequest.ts @@ -29,7 +29,7 @@ import { RuntimeFields } from '@_types/mapping/RuntimeFields' import { ScriptField } from '@_types/Scripting' /** - * Updates the properties of a datafeed. + * Update a datafeed. * You must stop and start the datafeed for the changes to be applied. * When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at * the time of the update and runs the query using those same roles. If you provide secondary authorization headers, diff --git a/specification/ml/update_filter/MlUpdateFilterRequest.ts b/specification/ml/update_filter/MlUpdateFilterRequest.ts index d972a25139..af5d3951ac 100644 --- a/specification/ml/update_filter/MlUpdateFilterRequest.ts +++ b/specification/ml/update_filter/MlUpdateFilterRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** + * Update a filter. * Updates the description of a filter, adds items, or removes items from the list. * @rest_spec_name ml.update_filter * @availability stack since=6.4.0 stability=stable diff --git a/specification/ml/update_job/MlUpdateJobRequest.ts b/specification/ml/update_job/MlUpdateJobRequest.ts index 508e177f34..0579eca84e 100644 --- a/specification/ml/update_job/MlUpdateJobRequest.ts +++ b/specification/ml/update_job/MlUpdateJobRequest.ts @@ -31,6 +31,7 @@ import { long } from '@_types/Numeric' import { Duration } from '@_types/Time' /** + * Update an anomaly detection job. * Updates certain properties of an anomaly detection job. * @rest_spec_name ml.update_job * @availability stack since=5.5.0 stability=stable diff --git a/specification/ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts b/specification/ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts index b6d3ced1b1..75f8facf9a 100644 --- a/specification/ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts +++ b/specification/ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** + * Update a snapshot. * Updates certain properties of a snapshot. * @rest_spec_name ml.update_model_snapshot * @availability stack since=5.4.0 stability=stable diff --git a/specification/ml/update_trained_model_deployment/MlUpdateTrainedModelDeploymentRequest.ts b/specification/ml/update_trained_model_deployment/MlUpdateTrainedModelDeploymentRequest.ts index bdd68b11d1..5e2407f350 100644 --- a/specification/ml/update_trained_model_deployment/MlUpdateTrainedModelDeploymentRequest.ts +++ b/specification/ml/update_trained_model_deployment/MlUpdateTrainedModelDeploymentRequest.ts @@ -22,7 +22,7 @@ import { Id } from '@_types/common' import { integer } from '@_types/Numeric' /** - * Starts a trained model deployment, which allocates the model to every machine learning node. + * Update a trained model deployment. * @rest_spec_name ml.update_trained_model_deployment * @availability stack since=8.6.0 stability=stable * @availability serverless stability=beta visibility=public diff --git a/specification/ml/upgrade_job_snapshot/MlUpgradeJobSnapshotRequest.ts b/specification/ml/upgrade_job_snapshot/MlUpgradeJobSnapshotRequest.ts index 7962acd332..d3ad1666d9 100644 --- a/specification/ml/upgrade_job_snapshot/MlUpgradeJobSnapshotRequest.ts +++ b/specification/ml/upgrade_job_snapshot/MlUpgradeJobSnapshotRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** + * Upgrade a snapshot. * Upgrades an anomaly detection model snapshot to the latest major version. * Over time, older snapshot formats are deprecated and removed. Anomaly * detection jobs support only snapshots that are from the current or previous From d3af569a8e37434a337d13896dbaf851370ab795 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Fri, 2 Aug 2024 16:49:36 +0200 Subject: [PATCH 2/5] Fixes format. --- package-lock.json | 1 + .../ml/get_overall_buckets/MlGetOverallBucketsRequest.ts | 2 +- .../MlStartTrainedModelDeploymentRequest.ts | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/package-lock.json b/package-lock.json index 743374922d..e903a7cd98 100644 --- a/package-lock.json +++ b/package-lock.json @@ -199,6 +199,7 @@ "version": "6.11.1", "resolved": "https://registry.npmjs.org/@stoplight/spectral-cli/-/spectral-cli-6.11.1.tgz", "integrity": "sha512-1zqsQ0TOuVSnxxZ9mHBfC0IygV6ex7nAY6Mp59mLmw5fW103U9yPVK5ZcX9ZngCmr3PdteAnMDUIIaoDGso6nA==", + "license": "Apache-2.0", "dependencies": { "@stoplight/json": "~3.21.0", "@stoplight/path": "1.3.2", diff --git a/specification/ml/get_overall_buckets/MlGetOverallBucketsRequest.ts b/specification/ml/get_overall_buckets/MlGetOverallBucketsRequest.ts index b32da76bee..65535c3f51 100644 --- a/specification/ml/get_overall_buckets/MlGetOverallBucketsRequest.ts +++ b/specification/ml/get_overall_buckets/MlGetOverallBucketsRequest.ts @@ -24,7 +24,7 @@ import { Duration, DateTime } from '@_types/Time' /** * Get overall bucket results. - * + * * Retrievs overall bucket results that summarize the bucket results of * multiple anomaly detection jobs. * diff --git a/specification/ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts b/specification/ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts index 6956247d56..0ea1d7f3ce 100644 --- a/specification/ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts +++ b/specification/ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts @@ -27,7 +27,7 @@ import { } from '../_types/TrainedModel' /** - * Start a trained model deployment. + * Start a trained model deployment. * It allocates the model to every machine learning node. * @rest_spec_name ml.start_trained_model_deployment * @availability stack since=8.0.0 stability=stable From bdd5b5cf1266ed83bdc2a18fbb3636ed84b3ee74 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Sat, 3 Aug 2024 12:21:12 +0200 Subject: [PATCH 3/5] Fine-tunes summaries. --- output/openapi/elasticsearch-openapi.json | 197 +++++++------- .../elasticsearch-serverless-openapi.json | 132 +++++----- output/schema/schema.json | 240 +++++++++--------- .../ml/get_calendars/MlGetCalendarsRequest.ts | 2 +- .../MlGetDataFrameAnalyticsRequest.ts | 2 +- .../MlGetDataFrameAnalyticsStatsRequest.ts | 2 +- .../MlGetDatafeedStatsRequest.ts | 2 +- .../ml/get_datafeeds/MlGetDatafeedsRequest.ts | 2 +- .../ml/get_job_stats/MlGetJobStatsRequest.ts | 2 +- specification/ml/get_jobs/MlGetJobsRequest.ts | 2 +- .../MlGetMemoryStatsRequest.ts | 2 +- .../MlGetModelSnapshotUpgradeStatsRequest.ts | 2 +- .../MlGetModelSnapshotsRequest.ts | 2 +- .../MlGetTrainedModelRequest.ts | 2 +- .../MlGetTrainedModelStatsRequest.ts | 2 +- .../MlPreviewDataFrameAnalyticsRequest.ts | 3 +- .../MlPutTrainedModelRequest.ts | 1 + .../MlSetUpgradeModeRequest.ts | 2 +- 18 files changed, 309 insertions(+), 290 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 2989481da3..a45a0622ec 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -17121,7 +17121,7 @@ "tags": [ "ml.get_calendars" ], - "summary": "Retrieves configuration information for calendars", + "summary": "Get calendar configuration info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html" }, @@ -17151,7 +17151,7 @@ "tags": [ "ml.put_calendar" ], - "summary": "Creates a calendar", + "summary": "Create a calendar", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html" }, @@ -17225,7 +17225,7 @@ "tags": [ "ml.get_calendars" ], - "summary": "Retrieves configuration information for calendars", + "summary": "Get calendar configuration info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html" }, @@ -17343,7 +17343,7 @@ "tags": [ "ml.put_calendar_job" ], - "summary": "Adds an anomaly detection job to a calendar", + "summary": "Add anomaly detection job to calendar", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html" }, @@ -17471,7 +17471,7 @@ "tags": [ "ml.get_data_frame_analytics" ], - "summary": "Retrieves configuration information for data frame analytics jobs", + "summary": "Get data frame analytics job configuration info", "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html" @@ -17505,7 +17505,7 @@ "tags": [ "ml.put_data_frame_analytics" ], - "summary": "Instantiates a data frame analytics job", + "summary": "Create a data frame analytics job", "description": "This API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html" @@ -17703,7 +17703,7 @@ "tags": [ "ml.get_datafeeds" ], - "summary": "Retrieves configuration information for datafeeds", + "summary": "Get datafeeds configuration info", "description": "You 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``, or by omitting the ``.\nThis API returns a maximum of 10,000 datafeeds.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html" @@ -17731,7 +17731,7 @@ "tags": [ "ml.put_datafeed" ], - "summary": "Instantiates a datafeed", + "summary": "Create a datafeed", "description": "Datafeeds 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.\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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html" @@ -18048,7 +18048,7 @@ "tags": [ "ml.get_filters" ], - "summary": "Retrieves filters", + "summary": "Get filters", "description": "You can get a single filter or all filters.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html" @@ -18076,7 +18076,7 @@ "tags": [ "ml.put_filter" ], - "summary": "Instantiates a filter", + "summary": "Create a filter", "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html" @@ -18194,8 +18194,8 @@ "tags": [ "ml.forecast" ], - "summary": "Predicts the future behavior of a time series by using its historical\n", - "description": "behavior.\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.", + "summary": "Predict future behavior of a time series", + "description": "Forecasts 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html" }, @@ -18357,7 +18357,7 @@ "tags": [ "ml.get_jobs" ], - "summary": "Retrieves configuration information for anomaly detection jobs", + "summary": "Get anomaly detection jobs configuration info", "description": "You 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 ``, or by omitting the ``.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html" @@ -18640,7 +18640,7 @@ "tags": [ "ml.get_model_snapshots" ], - "summary": "Retrieves information about model snapshots", + "summary": "Get model snapshots info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html" }, @@ -18685,7 +18685,7 @@ "tags": [ "ml.get_model_snapshots" ], - "summary": "Retrieves information about model snapshots", + "summary": "Get model snapshots info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html" }, @@ -18780,7 +18780,7 @@ "tags": [ "ml.get_trained_models" ], - "summary": "Retrieves configuration information for a trained model", + "summary": "Get trained model configuration info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html" }, @@ -18822,7 +18822,8 @@ "tags": [ "ml.put_trained_model" ], - "summary": "Enables you to supply a trained model that is not created by data frame analytics", + "summary": "Supply external trained model", + "description": "Enable you to supply a trained model that is not created by data frame analytics.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html" }, @@ -18981,8 +18982,8 @@ "tags": [ "ml.put_trained_model_alias" ], - "summary": "Creates or updates a trained model alias", - "description": "A trained model alias is a logical\nname used to reference a single trained model.\nYou can use aliases instead of trained model identifiers to make it easier to\nreference your models. For example, you can use aliases in inference\naggregations and processors.\nAn alias must be unique and refer to only a single trained model. However,\nyou can have multiple aliases for each trained model.\nIf you use this API to update an alias such that it references a different\ntrained model ID and the model uses a different type of data frame analytics,\nan error occurs. For example, this situation occurs if you have a trained\nmodel for regression analysis and a trained model for classification\nanalysis; you cannot reassign an alias from one type of trained model to\nanother.\nIf you use this API to update an alias and there are very few input fields in\ncommon between the old and new trained models for the model alias, the API\nreturns a warning.", + "summary": "Create or update a trained model alias", + "description": "A trained model alias is a logical name used to reference a single trained\nmodel.\nYou can use aliases instead of trained model identifiers to make it easier to\nreference your models. For example, you can use aliases in inference\naggregations and processors.\nAn alias must be unique and refer to only a single trained model. However,\nyou can have multiple aliases for each trained model.\nIf you use this API to update an alias such that it references a different\ntrained model ID and the model uses a different type of data frame analytics,\nan error occurs. For example, this situation occurs if you have a trained\nmodel for regression analysis and a trained model for classification\nanalysis; you cannot reassign an alias from one type of trained model to\nanother.\nIf you use this API to update an alias and there are very few input fields in\ncommon between the old and new trained models for the model alias, the API\nreturns a warning.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html" }, @@ -19308,7 +19309,7 @@ "tags": [ "ml.flush_job" ], - "summary": "Forces any buffered data to be processed by the job", + "summary": "Force buffered data to be processed", "description": "The 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html" @@ -19436,7 +19437,7 @@ "tags": [ "ml.get_buckets" ], - "summary": "Retrieves anomaly detection job results for one or more buckets", + "summary": "Get anomaly detection job results", "description": "The API presents a chronological view of the records, grouped by bucket.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html" @@ -19491,7 +19492,7 @@ "tags": [ "ml.get_buckets" ], - "summary": "Retrieves anomaly detection job results for one or more buckets", + "summary": "Get anomaly detection job results", "description": "The API presents a chronological view of the records, grouped by bucket.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html" @@ -19548,7 +19549,7 @@ "tags": [ "ml.get_buckets" ], - "summary": "Retrieves anomaly detection job results for one or more buckets", + "summary": "Get anomaly detection job results", "description": "The API presents a chronological view of the records, grouped by bucket.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html" @@ -19600,7 +19601,7 @@ "tags": [ "ml.get_buckets" ], - "summary": "Retrieves anomaly detection job results for one or more buckets", + "summary": "Get anomaly detection job results", "description": "The API presents a chronological view of the records, grouped by bucket.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html" @@ -19654,7 +19655,7 @@ "tags": [ "ml.get_calendar_events" ], - "summary": "Retrieves information about the scheduled events in calendars", + "summary": "Get info about events in calendars", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html" }, @@ -19755,7 +19756,7 @@ "tags": [ "ml.post_calendar_events" ], - "summary": "Adds scheduled events to a calendar", + "summary": "Add scheduled events to calendar", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html" }, @@ -19826,7 +19827,7 @@ "tags": [ "ml.get_calendars" ], - "summary": "Retrieves configuration information for calendars", + "summary": "Get calendar configuration info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html" }, @@ -19853,7 +19854,7 @@ "tags": [ "ml.get_calendars" ], - "summary": "Retrieves configuration information for calendars", + "summary": "Get calendar configuration info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html" }, @@ -19882,7 +19883,7 @@ "tags": [ "ml.get_categories" ], - "summary": "Retrieves anomaly detection job results for one or more categories", + "summary": "Get anomaly detection job results for categories", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html" }, @@ -19918,7 +19919,7 @@ "tags": [ "ml.get_categories" ], - "summary": "Retrieves anomaly detection job results for one or more categories", + "summary": "Get anomaly detection job results for categories", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html" }, @@ -19956,7 +19957,7 @@ "tags": [ "ml.get_categories" ], - "summary": "Retrieves anomaly detection job results for one or more categories", + "summary": "Get anomaly detection job results for categories", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html" }, @@ -19989,7 +19990,7 @@ "tags": [ "ml.get_categories" ], - "summary": "Retrieves anomaly detection job results for one or more categories", + "summary": "Get anomaly detection job results for categories", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html" }, @@ -20024,7 +20025,7 @@ "tags": [ "ml.get_data_frame_analytics" ], - "summary": "Retrieves configuration information for data frame analytics jobs", + "summary": "Get data frame analytics job configuration info", "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html" @@ -20057,7 +20058,7 @@ "tags": [ "ml.get_data_frame_analytics_stats" ], - "summary": "Retrieves usage information for data frame analytics jobs", + "summary": "Get data frame analytics jobs usage info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html" }, @@ -20089,7 +20090,7 @@ "tags": [ "ml.get_data_frame_analytics_stats" ], - "summary": "Retrieves usage information for data frame analytics jobs", + "summary": "Get data frame analytics jobs usage info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html" }, @@ -20124,7 +20125,7 @@ "tags": [ "ml.get_datafeed_stats" ], - "summary": "Retrieves usage information for datafeeds", + "summary": "Get datafeeds usage info", "description": "You 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``, or by omitting the ``. 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html" @@ -20151,7 +20152,7 @@ "tags": [ "ml.get_datafeed_stats" ], - "summary": "Retrieves usage information for datafeeds", + "summary": "Get datafeeds usage info", "description": "You 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``, or by omitting the ``. 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html" @@ -20175,7 +20176,7 @@ "tags": [ "ml.get_datafeeds" ], - "summary": "Retrieves configuration information for datafeeds", + "summary": "Get datafeeds configuration info", "description": "You 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``, or by omitting the ``.\nThis API returns a maximum of 10,000 datafeeds.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html" @@ -20202,7 +20203,7 @@ "tags": [ "ml.get_filters" ], - "summary": "Retrieves filters", + "summary": "Get filters", "description": "You can get a single filter or all filters.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html" @@ -20229,7 +20230,7 @@ "tags": [ "ml.get_influencers" ], - "summary": "Retrieves anomaly detection job results for one or more influencers", + "summary": "Get anomaly detection job results for influencers", "description": "Influencers 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html" @@ -20278,7 +20279,7 @@ "tags": [ "ml.get_influencers" ], - "summary": "Retrieves anomaly detection job results for one or more influencers", + "summary": "Get anomaly detection job results for influencers", "description": "Influencers 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html" @@ -20329,7 +20330,7 @@ "tags": [ "ml.get_job_stats" ], - "summary": "Retrieves usage information for anomaly detection jobs", + "summary": "Get anomaly detection jobs usage info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html" }, @@ -20352,7 +20353,7 @@ "tags": [ "ml.get_job_stats" ], - "summary": "Retrieves usage information for anomaly detection jobs", + "summary": "Get anomaly detection jobs usage info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html" }, @@ -20378,7 +20379,7 @@ "tags": [ "ml.get_jobs" ], - "summary": "Retrieves configuration information for anomaly detection jobs", + "summary": "Get anomaly detection jobs configuration info", "description": "You 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 ``, or by omitting the ``.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html" @@ -20405,8 +20406,8 @@ "tags": [ "ml.get_memory_stats" ], - "summary": "Get information about how machine learning jobs and trained models are using memory,\n", - "description": "on each node, both within the JVM heap, and natively, outside of the JVM.", + "summary": "Get machine learning memory usage info", + "description": "Get 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-memory.html" }, @@ -20435,8 +20436,8 @@ "tags": [ "ml.get_memory_stats" ], - "summary": "Get information about how machine learning jobs and trained models are using memory,\n", - "description": "on each node, both within the JVM heap, and natively, outside of the JVM.", + "summary": "Get machine learning memory usage info", + "description": "Get 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-memory.html" }, @@ -20468,7 +20469,7 @@ "tags": [ "ml.get_model_snapshot_upgrade_stats" ], - "summary": "Retrieves usage information for anomaly detection job model snapshot upgrades", + "summary": "Get anomaly detection job model snapshot upgrade usage info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-model-snapshot-upgrade-stats.html" }, @@ -20542,7 +20543,7 @@ "tags": [ "ml.get_model_snapshots" ], - "summary": "Retrieves information about model snapshots", + "summary": "Get model snapshots info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html" }, @@ -20584,7 +20585,7 @@ "tags": [ "ml.get_model_snapshots" ], - "summary": "Retrieves information about model snapshots", + "summary": "Get model snapshots info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html" }, @@ -20628,8 +20629,8 @@ "tags": [ "ml.get_overall_buckets" ], - "summary": "Retrieves overall bucket results that summarize the bucket results of\n", - "description": "multiple 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.", + "summary": "Get overall bucket results", + "description": "Retrievs 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html" }, @@ -20674,8 +20675,8 @@ "tags": [ "ml.get_overall_buckets" ], - "summary": "Retrieves overall bucket results that summarize the bucket results of\n", - "description": "multiple 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.", + "summary": "Get overall bucket results", + "description": "Retrievs 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html" }, @@ -20722,7 +20723,7 @@ "tags": [ "ml.get_records" ], - "summary": "Retrieves anomaly records for an anomaly detection job", + "summary": "Get anomaly records for an anomaly detection job", "description": "Records 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html" @@ -20771,7 +20772,7 @@ "tags": [ "ml.get_records" ], - "summary": "Retrieves anomaly records for an anomaly detection job", + "summary": "Get anomaly records for an anomaly detection job", "description": "Records 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html" @@ -20822,7 +20823,7 @@ "tags": [ "ml.get_trained_models" ], - "summary": "Retrieves configuration information for a trained model", + "summary": "Get trained model configuration info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html" }, @@ -20863,7 +20864,7 @@ "tags": [ "ml.get_trained_models_stats" ], - "summary": "Retrieves usage information for trained models", + "summary": "Get trained models usage info", "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html" @@ -20896,7 +20897,7 @@ "tags": [ "ml.get_trained_models_stats" ], - "summary": "Retrieves usage information for trained models", + "summary": "Get trained models usage info", "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html" @@ -20926,7 +20927,7 @@ "tags": [ "ml.infer_trained_model" ], - "summary": "Evaluates a trained model", + "summary": "Evaluate a trained model", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html" }, @@ -20955,7 +20956,7 @@ "tags": [ "ml.infer_trained_model" ], - "summary": "Evaluates a trained model", + "summary": "Evaluate a trained model", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html" }, @@ -20984,8 +20985,8 @@ "tags": [ "ml.info" ], - "summary": "Returns defaults and limits used by machine learning", - "description": "This endpoint is designed to be used by a user interface that needs to fully\nunderstand machine learning configurations where some options are not\nspecified, meaning that the defaults should be used. This endpoint may be\nused to find out what those defaults are. It also provides information about\nthe maximum size of machine learning jobs that could run in the current\ncluster configuration.", + "summary": "Return ML defaults and limits", + "description": "Returns defaults and limits used by machine learning.\nThis endpoint is designed to be used by a user interface that needs to fully\nunderstand machine learning configurations where some options are not\nspecified, meaning that the defaults should be used. This endpoint may be\nused to find out what those defaults are. It also provides information about\nthe maximum size of machine learning jobs that could run in the current\ncluster configuration.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-info.html" }, @@ -21031,7 +21032,7 @@ "ml.open_job" ], "summary": "Open anomaly detection jobs", - "description": "An anomaly detection job must be opened in order for it to be ready to\nreceive and analyze data. It can be opened and closed multiple times\nthroughout 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.", + "description": "An 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html" }, @@ -21105,7 +21106,7 @@ "tags": [ "ml.post_data" ], - "summary": "Sends data to an anomaly detection job for analysis", + "summary": "Send data to an anomaly detection job for analysis", "description": "IMPORTANT: 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html" @@ -21242,7 +21243,8 @@ "tags": [ "ml.preview_data_frame_analytics" ], - "summary": "Previews the extracted features used by a data frame analytics config", + "summary": "Preview features used by data frame analytics", + "description": "Previews the extracted features used by a data frame analytics config.", "externalDocs": { "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html" }, @@ -21261,7 +21263,8 @@ "tags": [ "ml.preview_data_frame_analytics" ], - "summary": "Previews the extracted features used by a data frame analytics config", + "summary": "Preview features used by data frame analytics", + "description": "Previews the extracted features used by a data frame analytics config.", "externalDocs": { "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html" }, @@ -21282,7 +21285,8 @@ "tags": [ "ml.preview_data_frame_analytics" ], - "summary": "Previews the extracted features used by a data frame analytics config", + "summary": "Preview features used by data frame analytics", + "description": "Previews the extracted features used by a data frame analytics config.", "externalDocs": { "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html" }, @@ -21306,7 +21310,8 @@ "tags": [ "ml.preview_data_frame_analytics" ], - "summary": "Previews the extracted features used by a data frame analytics config", + "summary": "Preview features used by data frame analytics", + "description": "Previews the extracted features used by a data frame analytics config.", "externalDocs": { "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html" }, @@ -21332,7 +21337,7 @@ "tags": [ "ml.preview_datafeed" ], - "summary": "Previews a datafeed", + "summary": "Preview a datafeed", "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" @@ -21363,7 +21368,7 @@ "tags": [ "ml.preview_datafeed" ], - "summary": "Previews a datafeed", + "summary": "Preview a datafeed", "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" @@ -21396,7 +21401,7 @@ "tags": [ "ml.preview_datafeed" ], - "summary": "Previews a datafeed", + "summary": "Preview a datafeed", "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" @@ -21424,7 +21429,7 @@ "tags": [ "ml.preview_datafeed" ], - "summary": "Previews a datafeed", + "summary": "Preview a datafeed", "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" @@ -21454,7 +21459,7 @@ "tags": [ "ml.put_trained_model_definition_part" ], - "summary": "Creates part of a trained model definition", + "summary": "Create part of a trained model definition", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-definition-part.html" }, @@ -21532,7 +21537,7 @@ "tags": [ "ml.put_trained_model_vocabulary" ], - "summary": "Creates a trained model vocabulary", + "summary": "Create a trained model vocabulary", "description": "This API is supported only for natural language processing (NLP) models.\nThe vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-vocabulary.html" @@ -21609,7 +21614,7 @@ "tags": [ "ml.reset_job" ], - "summary": "Resets an anomaly detection job", + "summary": "Reset an anomaly detection job", "description": "All model state and results are deleted. The job is ready to start over as if\nit had just been created.\nIt is not currently possible to reset multiple jobs using wildcards or a\ncomma separated list.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html" @@ -21668,7 +21673,7 @@ "tags": [ "ml.revert_model_snapshot" ], - "summary": "Reverts to a specific snapshot", + "summary": "Revert to a snapshot", "description": "The machine learning features react quickly to anomalous input, learning new\nbehaviors in data. Highly anomalous input increases the variance in the\nmodels whilst the system learns whether this is a new step-change in behavior\nor a one-off event. In the case where this anomalous input is known to be a\none-off, then it might be appropriate to reset the model state to a time\nbefore this event. For example, you might consider reverting to a saved\nsnapshot after Black Friday or a critical system failure.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html" @@ -21751,8 +21756,8 @@ "tags": [ "ml.set_upgrade_mode" ], - "summary": "Sets a cluster wide upgrade_mode setting that prepares machine learning\n", - "description": "indices for an upgrade.\nWhen upgrading your cluster, in some circumstances you must restart your\nnodes and reindex your machine learning indices. In those circumstances,\nthere must be no machine learning jobs running. You can close the machine\nlearning jobs, do the upgrade, then open all the jobs again. Alternatively,\nyou can use this API to temporarily halt tasks associated with the jobs and\ndatafeeds and prevent new jobs from opening. You can also use this API\nduring upgrades that do not require you to reindex your machine learning\nindices, though stopping jobs is not a requirement in that case.\nYou can see the current value for the upgrade_mode setting by using the get\nmachine learning info API.", + "summary": "Set upgrade_mode for ML indices", + "description": "Sets a cluster wide upgrade_mode setting that prepares machine learning\nindices for an upgrade.\nWhen upgrading your cluster, in some circumstances you must restart your\nnodes and reindex your machine learning indices. In those circumstances,\nthere must be no machine learning jobs running. You can close the machine\nlearning jobs, do the upgrade, then open all the jobs again. Alternatively,\nyou can use this API to temporarily halt tasks associated with the jobs and\ndatafeeds and prevent new jobs from opening. You can also use this API\nduring upgrades that do not require you to reindex your machine learning\nindices, though stopping jobs is not a requirement in that case.\nYou can see the current value for the upgrade_mode setting by using the get\nmachine learning info API.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html" }, @@ -21799,7 +21804,7 @@ "tags": [ "ml.start_data_frame_analytics" ], - "summary": "Starts a data frame analytics job", + "summary": "Start a data frame analytics job", "description": "A data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.\nIf the destination index does not exist, it is created automatically the\nfirst time you start the data frame analytics job. The\n`index.number_of_shards` and `index.number_of_replicas` settings for the\ndestination index are copied from the source index. If there are multiple\nsource indices, the destination index copies the highest setting values. The\nmappings for the destination index are also copied from the source indices.\nIf there are any mapping conflicts, the job fails to start.\nIf the destination index exists, it is used as is. You can therefore set up\nthe destination index in advance with custom settings and mappings.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html" @@ -21860,7 +21865,7 @@ "tags": [ "ml.start_datafeed" ], - "summary": "Starts one or more datafeeds", + "summary": "Start one or more datafeeds", "description": "A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.\n\nBefore you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.\n\nIf you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.\nIf new data was indexed for that exact millisecond between stopping and starting, it will be ignored.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or\nupdate it had at the time of creation or update and runs the query using those same roles. If you provided secondary\nauthorization headers when you created or updated the datafeed, those credentials are used instead.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html" @@ -21962,7 +21967,8 @@ "tags": [ "ml.start_trained_model_deployment" ], - "summary": "Starts a trained model deployment, which allocates the model to every machine learning node", + "summary": "Start a trained model deployment", + "description": "It allocates the model to every machine learning node.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trained-model-deployment.html" }, @@ -22088,7 +22094,7 @@ "tags": [ "ml.stop_data_frame_analytics" ], - "summary": "Stops one or more data frame analytics jobs", + "summary": "Stop one or more data frame analytics jobs", "description": "A data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html" @@ -22165,7 +22171,7 @@ "tags": [ "ml.stop_datafeed" ], - "summary": "Stops one or more datafeeds", + "summary": "Stop one or more datafeeds", "description": "A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html" @@ -22264,7 +22270,7 @@ "tags": [ "ml.stop_trained_model_deployment" ], - "summary": "Stops a trained model deployment", + "summary": "Stop a trained model deployment", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/stop-trained-model-deployment.html" }, @@ -22330,7 +22336,7 @@ "tags": [ "ml.update_data_frame_analytics" ], - "summary": "Updates an existing data frame analytics job", + "summary": "Update a data frame analytics job", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html" }, @@ -22451,7 +22457,7 @@ "tags": [ "ml.update_datafeed" ], - "summary": "Updates the properties of a datafeed", + "summary": "Update a datafeed", "description": "You must stop and start the datafeed for the changes to be applied.\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at\nthe time of the update and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html" @@ -22660,7 +22666,8 @@ "tags": [ "ml.update_filter" ], - "summary": "Updates the description of a filter, adds items, or removes items from the list", + "summary": "Update a filter", + "description": "Updates the description of a filter, adds items, or removes items from the list.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html" }, @@ -22747,7 +22754,8 @@ "tags": [ "ml.update_job" ], - "summary": "Updates certain properties of an anomaly detection job", + "summary": "Update an anomaly detection job", + "description": "Updates certain properties of an anomaly detection job.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html" }, @@ -22956,7 +22964,8 @@ "tags": [ "ml.update_model_snapshot" ], - "summary": "Updates certain properties of a snapshot", + "summary": "Update a snapshot", + "description": "Updates certain properties of a snapshot.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html" }, @@ -23037,7 +23046,7 @@ "tags": [ "ml.update_trained_model_deployment" ], - "summary": "Starts a trained model deployment, which allocates the model to every machine learning node", + "summary": "Update a trained model deployment", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-trained-model-deployment.html" }, @@ -23109,8 +23118,8 @@ "tags": [ "ml.upgrade_job_snapshot" ], - "summary": "Upgrades an anomaly detection model snapshot to the latest major version", - "description": "Over time, older snapshot formats are deprecated and removed. Anomaly\ndetection jobs support only snapshots that are from the current or previous\nmajor version.\nThis API provides a means to upgrade a snapshot to the current major version.\nThis aids in preparing the cluster for an upgrade to the next major version.\nOnly one snapshot per anomaly detection job can be upgraded at a time and the\nupgraded snapshot cannot be the current snapshot of the anomaly detection\njob.", + "summary": "Upgrade a snapshot", + "description": "Upgrades an anomaly detection model snapshot to the latest major version.\nOver time, older snapshot formats are deprecated and removed. Anomaly\ndetection jobs support only snapshots that are from the current or previous\nmajor version.\nThis API provides a means to upgrade a snapshot to the current major version.\nThis aids in preparing the cluster for an upgrade to the next major version.\nOnly one snapshot per anomaly detection job can be upgraded at a time and the\nupgraded snapshot cannot be the current snapshot of the anomaly detection\njob.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-upgrade-job-model-snapshot.html" }, diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 80f5156929..c2fb6f15f0 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -10289,7 +10289,7 @@ "tags": [ "ml.get_calendars" ], - "summary": "Retrieves configuration information for calendars", + "summary": "Get calendar configuration info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html" }, @@ -10319,7 +10319,7 @@ "tags": [ "ml.put_calendar" ], - "summary": "Creates a calendar", + "summary": "Create a calendar", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html" }, @@ -10393,7 +10393,7 @@ "tags": [ "ml.get_calendars" ], - "summary": "Retrieves configuration information for calendars", + "summary": "Get calendar configuration info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html" }, @@ -10511,7 +10511,7 @@ "tags": [ "ml.put_calendar_job" ], - "summary": "Adds an anomaly detection job to a calendar", + "summary": "Add anomaly detection job to calendar", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html" }, @@ -10639,7 +10639,7 @@ "tags": [ "ml.get_data_frame_analytics" ], - "summary": "Retrieves configuration information for data frame analytics jobs", + "summary": "Get data frame analytics job configuration info", "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html" @@ -10673,7 +10673,7 @@ "tags": [ "ml.put_data_frame_analytics" ], - "summary": "Instantiates a data frame analytics job", + "summary": "Create a data frame analytics job", "description": "This API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html" @@ -10871,7 +10871,7 @@ "tags": [ "ml.get_datafeeds" ], - "summary": "Retrieves configuration information for datafeeds", + "summary": "Get datafeeds configuration info", "description": "You 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``, or by omitting the ``.\nThis API returns a maximum of 10,000 datafeeds.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html" @@ -10899,7 +10899,7 @@ "tags": [ "ml.put_datafeed" ], - "summary": "Instantiates a datafeed", + "summary": "Create a datafeed", "description": "Datafeeds 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.\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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html" @@ -11153,7 +11153,7 @@ "tags": [ "ml.get_filters" ], - "summary": "Retrieves filters", + "summary": "Get filters", "description": "You can get a single filter or all filters.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html" @@ -11181,7 +11181,7 @@ "tags": [ "ml.put_filter" ], - "summary": "Instantiates a filter", + "summary": "Create a filter", "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html" @@ -11299,7 +11299,7 @@ "tags": [ "ml.get_jobs" ], - "summary": "Retrieves configuration information for anomaly detection jobs", + "summary": "Get anomaly detection jobs configuration info", "description": "You 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 ``, or by omitting the ``.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html" @@ -11582,7 +11582,7 @@ "tags": [ "ml.get_trained_models" ], - "summary": "Retrieves configuration information for a trained model", + "summary": "Get trained model configuration info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html" }, @@ -11624,7 +11624,8 @@ "tags": [ "ml.put_trained_model" ], - "summary": "Enables you to supply a trained model that is not created by data frame analytics", + "summary": "Supply external trained model", + "description": "Enable you to supply a trained model that is not created by data frame analytics.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html" }, @@ -11783,8 +11784,8 @@ "tags": [ "ml.put_trained_model_alias" ], - "summary": "Creates or updates a trained model alias", - "description": "A trained model alias is a logical\nname used to reference a single trained model.\nYou can use aliases instead of trained model identifiers to make it easier to\nreference your models. For example, you can use aliases in inference\naggregations and processors.\nAn alias must be unique and refer to only a single trained model. However,\nyou can have multiple aliases for each trained model.\nIf you use this API to update an alias such that it references a different\ntrained model ID and the model uses a different type of data frame analytics,\nan error occurs. For example, this situation occurs if you have a trained\nmodel for regression analysis and a trained model for classification\nanalysis; you cannot reassign an alias from one type of trained model to\nanother.\nIf you use this API to update an alias and there are very few input fields in\ncommon between the old and new trained models for the model alias, the API\nreturns a warning.", + "summary": "Create or update a trained model alias", + "description": "A trained model alias is a logical name used to reference a single trained\nmodel.\nYou can use aliases instead of trained model identifiers to make it easier to\nreference your models. For example, you can use aliases in inference\naggregations and processors.\nAn alias must be unique and refer to only a single trained model. However,\nyou can have multiple aliases for each trained model.\nIf you use this API to update an alias such that it references a different\ntrained model ID and the model uses a different type of data frame analytics,\nan error occurs. For example, this situation occurs if you have a trained\nmodel for regression analysis and a trained model for classification\nanalysis; you cannot reassign an alias from one type of trained model to\nanother.\nIf you use this API to update an alias and there are very few input fields in\ncommon between the old and new trained models for the model alias, the API\nreturns a warning.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html" }, @@ -12016,7 +12017,7 @@ "tags": [ "ml.flush_job" ], - "summary": "Forces any buffered data to be processed by the job", + "summary": "Force buffered data to be processed", "description": "The 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html" @@ -12144,7 +12145,7 @@ "tags": [ "ml.get_calendar_events" ], - "summary": "Retrieves information about the scheduled events in calendars", + "summary": "Get info about events in calendars", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html" }, @@ -12245,7 +12246,7 @@ "tags": [ "ml.post_calendar_events" ], - "summary": "Adds scheduled events to a calendar", + "summary": "Add scheduled events to calendar", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html" }, @@ -12316,7 +12317,7 @@ "tags": [ "ml.get_calendars" ], - "summary": "Retrieves configuration information for calendars", + "summary": "Get calendar configuration info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html" }, @@ -12343,7 +12344,7 @@ "tags": [ "ml.get_calendars" ], - "summary": "Retrieves configuration information for calendars", + "summary": "Get calendar configuration info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html" }, @@ -12372,7 +12373,7 @@ "tags": [ "ml.get_data_frame_analytics" ], - "summary": "Retrieves configuration information for data frame analytics jobs", + "summary": "Get data frame analytics job configuration info", "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html" @@ -12405,7 +12406,7 @@ "tags": [ "ml.get_data_frame_analytics_stats" ], - "summary": "Retrieves usage information for data frame analytics jobs", + "summary": "Get data frame analytics jobs usage info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html" }, @@ -12437,7 +12438,7 @@ "tags": [ "ml.get_data_frame_analytics_stats" ], - "summary": "Retrieves usage information for data frame analytics jobs", + "summary": "Get data frame analytics jobs usage info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html" }, @@ -12472,7 +12473,7 @@ "tags": [ "ml.get_datafeed_stats" ], - "summary": "Retrieves usage information for datafeeds", + "summary": "Get datafeeds usage info", "description": "You 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``, or by omitting the ``. 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html" @@ -12499,7 +12500,7 @@ "tags": [ "ml.get_datafeed_stats" ], - "summary": "Retrieves usage information for datafeeds", + "summary": "Get datafeeds usage info", "description": "You 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``, or by omitting the ``. 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html" @@ -12523,7 +12524,7 @@ "tags": [ "ml.get_datafeeds" ], - "summary": "Retrieves configuration information for datafeeds", + "summary": "Get datafeeds configuration info", "description": "You 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``, or by omitting the ``.\nThis API returns a maximum of 10,000 datafeeds.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html" @@ -12550,7 +12551,7 @@ "tags": [ "ml.get_filters" ], - "summary": "Retrieves filters", + "summary": "Get filters", "description": "You can get a single filter or all filters.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html" @@ -12577,7 +12578,7 @@ "tags": [ "ml.get_job_stats" ], - "summary": "Retrieves usage information for anomaly detection jobs", + "summary": "Get anomaly detection jobs usage info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html" }, @@ -12600,7 +12601,7 @@ "tags": [ "ml.get_job_stats" ], - "summary": "Retrieves usage information for anomaly detection jobs", + "summary": "Get anomaly detection jobs usage info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html" }, @@ -12626,7 +12627,7 @@ "tags": [ "ml.get_jobs" ], - "summary": "Retrieves configuration information for anomaly detection jobs", + "summary": "Get anomaly detection jobs configuration info", "description": "You 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 ``, or by omitting the ``.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html" @@ -12653,8 +12654,8 @@ "tags": [ "ml.get_overall_buckets" ], - "summary": "Retrieves overall bucket results that summarize the bucket results of\n", - "description": "multiple 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.", + "summary": "Get overall bucket results", + "description": "Retrievs 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html" }, @@ -12699,8 +12700,8 @@ "tags": [ "ml.get_overall_buckets" ], - "summary": "Retrieves overall bucket results that summarize the bucket results of\n", - "description": "multiple 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.", + "summary": "Get overall bucket results", + "description": "Retrievs 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html" }, @@ -12747,7 +12748,7 @@ "tags": [ "ml.get_trained_models" ], - "summary": "Retrieves configuration information for a trained model", + "summary": "Get trained model configuration info", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html" }, @@ -12788,7 +12789,7 @@ "tags": [ "ml.get_trained_models_stats" ], - "summary": "Retrieves usage information for trained models", + "summary": "Get trained models usage info", "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html" @@ -12821,7 +12822,7 @@ "tags": [ "ml.get_trained_models_stats" ], - "summary": "Retrieves usage information for trained models", + "summary": "Get trained models usage info", "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html" @@ -12851,7 +12852,7 @@ "tags": [ "ml.infer_trained_model" ], - "summary": "Evaluates a trained model", + "summary": "Evaluate a trained model", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html" }, @@ -12880,7 +12881,7 @@ "tags": [ "ml.infer_trained_model" ], - "summary": "Evaluates a trained model", + "summary": "Evaluate a trained model", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html" }, @@ -12910,7 +12911,7 @@ "ml.open_job" ], "summary": "Open anomaly detection jobs", - "description": "An anomaly detection job must be opened in order for it to be ready to\nreceive and analyze data. It can be opened and closed multiple times\nthroughout 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.", + "description": "An 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html" }, @@ -12984,7 +12985,8 @@ "tags": [ "ml.preview_data_frame_analytics" ], - "summary": "Previews the extracted features used by a data frame analytics config", + "summary": "Preview features used by data frame analytics", + "description": "Previews the extracted features used by a data frame analytics config.", "externalDocs": { "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html" }, @@ -13003,7 +13005,8 @@ "tags": [ "ml.preview_data_frame_analytics" ], - "summary": "Previews the extracted features used by a data frame analytics config", + "summary": "Preview features used by data frame analytics", + "description": "Previews the extracted features used by a data frame analytics config.", "externalDocs": { "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html" }, @@ -13024,7 +13027,8 @@ "tags": [ "ml.preview_data_frame_analytics" ], - "summary": "Previews the extracted features used by a data frame analytics config", + "summary": "Preview features used by data frame analytics", + "description": "Previews the extracted features used by a data frame analytics config.", "externalDocs": { "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html" }, @@ -13048,7 +13052,8 @@ "tags": [ "ml.preview_data_frame_analytics" ], - "summary": "Previews the extracted features used by a data frame analytics config", + "summary": "Preview features used by data frame analytics", + "description": "Previews the extracted features used by a data frame analytics config.", "externalDocs": { "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html" }, @@ -13074,7 +13079,7 @@ "tags": [ "ml.preview_datafeed" ], - "summary": "Previews a datafeed", + "summary": "Preview a datafeed", "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" @@ -13105,7 +13110,7 @@ "tags": [ "ml.preview_datafeed" ], - "summary": "Previews a datafeed", + "summary": "Preview a datafeed", "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" @@ -13138,7 +13143,7 @@ "tags": [ "ml.preview_datafeed" ], - "summary": "Previews a datafeed", + "summary": "Preview a datafeed", "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" @@ -13166,7 +13171,7 @@ "tags": [ "ml.preview_datafeed" ], - "summary": "Previews a datafeed", + "summary": "Preview a datafeed", "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" @@ -13196,7 +13201,7 @@ "tags": [ "ml.put_trained_model_definition_part" ], - "summary": "Creates part of a trained model definition", + "summary": "Create part of a trained model definition", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-definition-part.html" }, @@ -13274,7 +13279,7 @@ "tags": [ "ml.put_trained_model_vocabulary" ], - "summary": "Creates a trained model vocabulary", + "summary": "Create a trained model vocabulary", "description": "This API is supported only for natural language processing (NLP) models.\nThe vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-vocabulary.html" @@ -13351,7 +13356,7 @@ "tags": [ "ml.reset_job" ], - "summary": "Resets an anomaly detection job", + "summary": "Reset an anomaly detection job", "description": "All model state and results are deleted. The job is ready to start over as if\nit had just been created.\nIt is not currently possible to reset multiple jobs using wildcards or a\ncomma separated list.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html" @@ -13410,7 +13415,7 @@ "tags": [ "ml.start_data_frame_analytics" ], - "summary": "Starts a data frame analytics job", + "summary": "Start a data frame analytics job", "description": "A data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.\nIf the destination index does not exist, it is created automatically the\nfirst time you start the data frame analytics job. The\n`index.number_of_shards` and `index.number_of_replicas` settings for the\ndestination index are copied from the source index. If there are multiple\nsource indices, the destination index copies the highest setting values. The\nmappings for the destination index are also copied from the source indices.\nIf there are any mapping conflicts, the job fails to start.\nIf the destination index exists, it is used as is. You can therefore set up\nthe destination index in advance with custom settings and mappings.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html" @@ -13471,7 +13476,7 @@ "tags": [ "ml.start_datafeed" ], - "summary": "Starts one or more datafeeds", + "summary": "Start one or more datafeeds", "description": "A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.\n\nBefore you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.\n\nIf you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.\nIf new data was indexed for that exact millisecond between stopping and starting, it will be ignored.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or\nupdate it had at the time of creation or update and runs the query using those same roles. If you provided secondary\nauthorization headers when you created or updated the datafeed, those credentials are used instead.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html" @@ -13573,7 +13578,8 @@ "tags": [ "ml.start_trained_model_deployment" ], - "summary": "Starts a trained model deployment, which allocates the model to every machine learning node", + "summary": "Start a trained model deployment", + "description": "It allocates the model to every machine learning node.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trained-model-deployment.html" }, @@ -13689,7 +13695,7 @@ "tags": [ "ml.stop_data_frame_analytics" ], - "summary": "Stops one or more data frame analytics jobs", + "summary": "Stop one or more data frame analytics jobs", "description": "A data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html" @@ -13766,7 +13772,7 @@ "tags": [ "ml.stop_datafeed" ], - "summary": "Stops one or more datafeeds", + "summary": "Stop one or more datafeeds", "description": "A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html" @@ -13865,7 +13871,7 @@ "tags": [ "ml.stop_trained_model_deployment" ], - "summary": "Stops a trained model deployment", + "summary": "Stop a trained model deployment", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/stop-trained-model-deployment.html" }, @@ -13931,7 +13937,7 @@ "tags": [ "ml.update_data_frame_analytics" ], - "summary": "Updates an existing data frame analytics job", + "summary": "Update a data frame analytics job", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html" }, @@ -14052,7 +14058,7 @@ "tags": [ "ml.update_datafeed" ], - "summary": "Updates the properties of a datafeed", + "summary": "Update a datafeed", "description": "You must stop and start the datafeed for the changes to be applied.\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at\nthe time of the update and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html" @@ -14261,7 +14267,8 @@ "tags": [ "ml.update_filter" ], - "summary": "Updates the description of a filter, adds items, or removes items from the list", + "summary": "Update a filter", + "description": "Updates the description of a filter, adds items, or removes items from the list.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html" }, @@ -14348,7 +14355,8 @@ "tags": [ "ml.update_job" ], - "summary": "Updates certain properties of an anomaly detection job", + "summary": "Update an anomaly detection job", + "description": "Updates certain properties of an anomaly detection job.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html" }, @@ -14557,7 +14565,7 @@ "tags": [ "ml.update_trained_model_deployment" ], - "summary": "Starts a trained model deployment, which allocates the model to every machine learning node", + "summary": "Update a trained model deployment", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-trained-model-deployment.html" }, diff --git a/output/schema/schema.json b/output/schema/schema.json index e05a21c5d3..ef2889885a 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -10056,7 +10056,7 @@ "stability": "stable" } }, - "description": "Forces any buffered data to be processed by the job.\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.", + "description": "Force buffered data to be processed.\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.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html", "name": "ml.flush_job", "privileges": { @@ -10099,7 +10099,7 @@ "stability": "stable" } }, - "description": "Predicts the future behavior of a time series by using its historical\nbehavior.\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.", + "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.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html", "name": "ml.forecast", "privileges": { @@ -10142,7 +10142,7 @@ "stability": "stable" } }, - "description": "Retrieves anomaly detection job results for one or more buckets.\nThe API presents a chronological view of the records, grouped by bucket.", + "description": "Get anomaly detection job results.\nThe API presents a chronological view of the records, grouped by bucket.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html", "name": "ml.get_buckets", "privileges": { @@ -10193,7 +10193,7 @@ "stability": "stable" } }, - "description": "Retrieves information about the scheduled events in calendars.", + "description": "Get info about events in calendars.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html", "name": "ml.get_calendar_events", "privileges": { @@ -10233,7 +10233,7 @@ "stability": "stable" } }, - "description": "Retrieves configuration information for calendars.", + "description": "Get calendar configuration info.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html", "name": "ml.get_calendars", "privileges": { @@ -10284,7 +10284,7 @@ "stability": "stable" } }, - "description": "Retrieves anomaly detection job results for one or more categories.", + "description": "Get anomaly detection job results for categories.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html", "name": "ml.get_categories", "privileges": { @@ -10335,7 +10335,7 @@ "stability": "stable" } }, - "description": "Retrieves configuration information for data frame analytics jobs.\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.", + "description": "Get data frame analytics job configuration info.\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.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html", "name": "ml.get_data_frame_analytics", "privileges": { @@ -10381,7 +10381,7 @@ "stability": "stable" } }, - "description": "Retrieves usage information for data frame analytics jobs.", + "description": "Get data frame analytics jobs usage info.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html", "name": "ml.get_data_frame_analytics_stats", "privileges": { @@ -10427,7 +10427,7 @@ "stability": "stable" } }, - "description": "Retrieves usage information for datafeeds.\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``, or by omitting the ``. 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.", + "description": "Get datafeeds usage info.\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``, or by omitting the ``. 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.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html", "name": "ml.get_datafeed_stats", "privileges": { @@ -10473,7 +10473,7 @@ "stability": "stable" } }, - "description": "Retrieves configuration information for datafeeds.\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``, or by omitting the ``.\nThis API returns a maximum of 10,000 datafeeds.", + "description": "Get datafeeds configuration info.\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``, or by omitting the ``.\nThis API returns a maximum of 10,000 datafeeds.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html", "name": "ml.get_datafeeds", "privileges": { @@ -10519,7 +10519,7 @@ "stability": "stable" } }, - "description": "Retrieves filters.\nYou can get a single filter or all filters.", + "description": "Get filters.\nYou can get a single filter or all filters.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html", "name": "ml.get_filters", "privileges": { @@ -10565,7 +10565,7 @@ "stability": "stable" } }, - "description": "Retrieves anomaly detection job results for one or more influencers.\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.", + "description": "Get anomaly detection job results for influencers.\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.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html", "name": "ml.get_influencers", "privileges": { @@ -10609,7 +10609,7 @@ "stability": "stable" } }, - "description": "Retrieves usage information for anomaly detection jobs.", + "description": "Get anomaly detection jobs usage info.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html", "name": "ml.get_job_stats", "privileges": { @@ -10655,7 +10655,7 @@ "stability": "stable" } }, - "description": "Retrieves configuration information for anomaly detection jobs.\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 ``, or by omitting the ``.", + "description": "Get anomaly detection jobs configuration info.\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 ``, or by omitting the ``.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html", "name": "ml.get_jobs", "privileges": { @@ -10701,7 +10701,7 @@ "stability": "stable" } }, - "description": "Get 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.", + "description": "Get machine learning memory usage info.\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.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-memory.html", "name": "ml.get_memory_stats", "privileges": { @@ -10747,7 +10747,7 @@ "stability": "stable" } }, - "description": "Retrieves usage information for anomaly detection job model snapshot upgrades.", + "description": "Get anomaly detection job model snapshot upgrade usage info.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-model-snapshot-upgrade-stats.html", "name": "ml.get_model_snapshot_upgrade_stats", "privileges": { @@ -10787,7 +10787,7 @@ "stability": "stable" } }, - "description": "Retrieves information about model snapshots.", + "description": "Get model snapshots info.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html", "name": "ml.get_model_snapshots", "privileges": { @@ -10838,7 +10838,7 @@ "stability": "stable" } }, - "description": "Retrieves 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.", + "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.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html", "name": "ml.get_overall_buckets", "privileges": { @@ -10882,7 +10882,7 @@ "stability": "stable" } }, - "description": "Retrieves anomaly records for an anomaly detection job.\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.", + "description": "Get anomaly records for an anomaly detection job.\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.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html", "name": "ml.get_records", "privileges": { @@ -10926,7 +10926,7 @@ "stability": "stable" } }, - "description": "Retrieves configuration information for a trained model.", + "description": "Get trained model configuration info.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html", "name": "ml.get_trained_models", "privileges": { @@ -10972,7 +10972,7 @@ "stability": "stable" } }, - "description": "Retrieves usage information for trained models. You 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.", + "description": "Get trained models usage info.\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.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html", "name": "ml.get_trained_models_stats", "privileges": { @@ -11018,7 +11018,7 @@ "stability": "stable" } }, - "description": "Evaluates a trained model.", + "description": "Evaluate a trained model.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html", "name": "ml.infer_trained_model", "request": { @@ -11066,7 +11066,7 @@ "stability": "stable" } }, - "description": "Returns defaults and limits used by machine learning.\nThis endpoint is designed to be used by a user interface that needs to fully\nunderstand machine learning configurations where some options are not\nspecified, meaning that the defaults should be used. This endpoint may be\nused to find out what those defaults are. It also provides information about\nthe maximum size of machine learning jobs that could run in the current\ncluster configuration.", + "description": "Return ML defaults and limits.\nReturns defaults and limits used by machine learning.\nThis endpoint is designed to be used by a user interface that needs to fully\nunderstand machine learning configurations where some options are not\nspecified, meaning that the defaults should be used. This endpoint may be\nused to find out what those defaults are. It also provides information about\nthe maximum size of machine learning jobs that could run in the current\ncluster configuration.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-info.html", "name": "ml.info", "privileges": { @@ -11106,7 +11106,7 @@ "stability": "stable" } }, - "description": "Open anomaly detection jobs.\nAn anomaly detection job must be opened in order for it to be ready to\nreceive and analyze data. It can be opened and closed multiple times\nthroughout 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.", + "description": "Open anomaly detection jobs.\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.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html", "name": "ml.open_job", "privileges": { @@ -11149,7 +11149,7 @@ "stability": "stable" } }, - "description": "Adds scheduled events to a calendar.", + "description": "Add scheduled events to calendar.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html", "name": "ml.post_calendar_events", "privileges": { @@ -11192,7 +11192,7 @@ "description": "Posting data directly to anomaly detection jobs is deprecated, in a future major version a datafeed will be required.", "version": "7.11.0" }, - "description": "Sends 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.", + "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.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html", "name": "ml.post_data", "privileges": { @@ -11236,7 +11236,7 @@ "stability": "stable" } }, - "description": "Previews the extracted features used by a data frame analytics config.", + "description": "Preview features used by data frame analytics.\nPreviews the extracted features used by a data frame analytics config.", "docUrl": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html", "name": "ml.preview_data_frame_analytics", "privileges": { @@ -11287,7 +11287,7 @@ "stability": "stable" } }, - "description": "Previews a datafeed.\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.", + "description": "Preview a datafeed.\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.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html", "name": "ml.preview_datafeed", "privileges": { @@ -11341,7 +11341,7 @@ "stability": "stable" } }, - "description": "Creates a calendar.", + "description": "Create a calendar.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html", "name": "ml.put_calendar", "privileges": { @@ -11384,7 +11384,7 @@ "stability": "stable" } }, - "description": "Adds an anomaly detection job to a calendar.", + "description": "Add anomaly detection job to calendar.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html", "name": "ml.put_calendar_job", "privileges": { @@ -11424,7 +11424,7 @@ "stability": "stable" } }, - "description": "Instantiates a data frame analytics job.\nThis API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.", + "description": "Create a data frame analytics job.\nThis API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.", "docId": "put-dfanalytics", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-dfanalytics.html", "name": "ml.put_data_frame_analytics", @@ -11475,7 +11475,7 @@ "stability": "stable" } }, - "description": "Instantiates a datafeed.\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.\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.", + "description": "Create a datafeed.\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.\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.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html", "name": "ml.put_datafeed", "privileges": { @@ -11521,7 +11521,7 @@ "stability": "stable" } }, - "description": "Instantiates a filter.\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.", + "description": "Create a filter.\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.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html", "name": "ml.put_filter", "privileges": { @@ -11610,7 +11610,7 @@ "stability": "stable" } }, - "description": "Enables you to supply a trained model that is not created by data frame analytics.", + "description": "Supply external trained model.\nEnable you to supply a trained model that is not created by data frame analytics.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html", "name": "ml.put_trained_model", "privileges": { @@ -11653,7 +11653,7 @@ "stability": "stable" } }, - "description": "Creates or updates a trained model alias. A trained model alias is a logical\nname used to reference a single trained model.\nYou can use aliases instead of trained model identifiers to make it easier to\nreference your models. For example, you can use aliases in inference\naggregations and processors.\nAn alias must be unique and refer to only a single trained model. However,\nyou can have multiple aliases for each trained model.\nIf you use this API to update an alias such that it references a different\ntrained model ID and the model uses a different type of data frame analytics,\nan error occurs. For example, this situation occurs if you have a trained\nmodel for regression analysis and a trained model for classification\nanalysis; you cannot reassign an alias from one type of trained model to\nanother.\nIf you use this API to update an alias and there are very few input fields in\ncommon between the old and new trained models for the model alias, the API\nreturns a warning.", + "description": "Create or update a trained model alias.\nA trained model alias is a logical name used to reference a single trained\nmodel.\nYou can use aliases instead of trained model identifiers to make it easier to\nreference your models. For example, you can use aliases in inference\naggregations and processors.\nAn alias must be unique and refer to only a single trained model. However,\nyou can have multiple aliases for each trained model.\nIf you use this API to update an alias such that it references a different\ntrained model ID and the model uses a different type of data frame analytics,\nan error occurs. For example, this situation occurs if you have a trained\nmodel for regression analysis and a trained model for classification\nanalysis; you cannot reassign an alias from one type of trained model to\nanother.\nIf you use this API to update an alias and there are very few input fields in\ncommon between the old and new trained models for the model alias, the API\nreturns a warning.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html", "name": "ml.put_trained_model_alias", "privileges": { @@ -11696,7 +11696,7 @@ "stability": "stable" } }, - "description": "Creates part of a trained model definition.", + "description": "Create part of a trained model definition.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-definition-part.html", "name": "ml.put_trained_model_definition_part", "privileges": { @@ -11739,7 +11739,7 @@ "stability": "stable" } }, - "description": "Creates a trained model vocabulary.\nThis API is supported only for natural language processing (NLP) models.\nThe vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.", + "description": "Create a trained model vocabulary.\nThis API is supported only for natural language processing (NLP) models.\nThe vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-vocabulary.html", "name": "ml.put_trained_model_vocabulary", "privileges": { @@ -11782,7 +11782,7 @@ "stability": "stable" } }, - "description": "Resets an anomaly detection job.\nAll model state and results are deleted. The job is ready to start over as if\nit had just been created.\nIt is not currently possible to reset multiple jobs using wildcards or a\ncomma separated list.", + "description": "Reset an anomaly detection job.\nAll model state and results are deleted. The job is ready to start over as if\nit had just been created.\nIt is not currently possible to reset multiple jobs using wildcards or a\ncomma separated list.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html", "name": "ml.reset_job", "privileges": { @@ -11822,7 +11822,7 @@ "stability": "stable" } }, - "description": "Reverts to a specific snapshot.\nThe machine learning features react quickly to anomalous input, learning new\nbehaviors in data. Highly anomalous input increases the variance in the\nmodels whilst the system learns whether this is a new step-change in behavior\nor a one-off event. In the case where this anomalous input is known to be a\none-off, then it might be appropriate to reset the model state to a time\nbefore this event. For example, you might consider reverting to a saved\nsnapshot after Black Friday or a critical system failure.", + "description": "Revert to a snapshot.\nThe machine learning features react quickly to anomalous input, learning new\nbehaviors in data. Highly anomalous input increases the variance in the\nmodels whilst the system learns whether this is a new step-change in behavior\nor a one-off event. In the case where this anomalous input is known to be a\none-off, then it might be appropriate to reset the model state to a time\nbefore this event. For example, you might consider reverting to a saved\nsnapshot after Black Friday or a critical system failure.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html", "name": "ml.revert_model_snapshot", "privileges": { @@ -11865,7 +11865,7 @@ "stability": "stable" } }, - "description": "Sets a cluster wide upgrade_mode setting that prepares machine learning\nindices for an upgrade.\nWhen upgrading your cluster, in some circumstances you must restart your\nnodes and reindex your machine learning indices. In those circumstances,\nthere must be no machine learning jobs running. You can close the machine\nlearning jobs, do the upgrade, then open all the jobs again. Alternatively,\nyou can use this API to temporarily halt tasks associated with the jobs and\ndatafeeds and prevent new jobs from opening. You can also use this API\nduring upgrades that do not require you to reindex your machine learning\nindices, though stopping jobs is not a requirement in that case.\nYou can see the current value for the upgrade_mode setting by using the get\nmachine learning info API.", + "description": "Set upgrade_mode for ML indices.\nSets a cluster wide upgrade_mode setting that prepares machine learning\nindices for an upgrade.\nWhen upgrading your cluster, in some circumstances you must restart your\nnodes and reindex your machine learning indices. In those circumstances,\nthere must be no machine learning jobs running. You can close the machine\nlearning jobs, do the upgrade, then open all the jobs again. Alternatively,\nyou can use this API to temporarily halt tasks associated with the jobs and\ndatafeeds and prevent new jobs from opening. You can also use this API\nduring upgrades that do not require you to reindex your machine learning\nindices, though stopping jobs is not a requirement in that case.\nYou can see the current value for the upgrade_mode setting by using the get\nmachine learning info API.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html", "name": "ml.set_upgrade_mode", "privileges": { @@ -11905,7 +11905,7 @@ "stability": "stable" } }, - "description": "Starts a data frame analytics job.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.\nIf the destination index does not exist, it is created automatically the\nfirst time you start the data frame analytics job. The\n`index.number_of_shards` and `index.number_of_replicas` settings for the\ndestination index are copied from the source index. If there are multiple\nsource indices, the destination index copies the highest setting values. The\nmappings for the destination index are also copied from the source indices.\nIf there are any mapping conflicts, the job fails to start.\nIf the destination index exists, it is used as is. You can therefore set up\nthe destination index in advance with custom settings and mappings.", + "description": "Start a data frame analytics job.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.\nIf the destination index does not exist, it is created automatically the\nfirst time you start the data frame analytics job. The\n`index.number_of_shards` and `index.number_of_replicas` settings for the\ndestination index are copied from the source index. If there are multiple\nsource indices, the destination index copies the highest setting values. The\nmappings for the destination index are also copied from the source indices.\nIf there are any mapping conflicts, the job fails to start.\nIf the destination index exists, it is used as is. You can therefore set up\nthe destination index in advance with custom settings and mappings.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html", "name": "ml.start_data_frame_analytics", "privileges": { @@ -11955,7 +11955,7 @@ "stability": "stable" } }, - "description": "Starts one or more datafeeds.\n\nA datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.\n\nBefore you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.\n\nIf you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.\nIf new data was indexed for that exact millisecond between stopping and starting, it will be ignored.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or\nupdate it had at the time of creation or update and runs the query using those same roles. If you provided secondary\nauthorization headers when you created or updated the datafeed, those credentials are used instead.", + "description": "Start one or more datafeeds.\n\nA datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.\n\nBefore you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.\n\nIf you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.\nIf new data was indexed for that exact millisecond between stopping and starting, it will be ignored.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or\nupdate it had at the time of creation or update and runs the query using those same roles. If you provided secondary\nauthorization headers when you created or updated the datafeed, those credentials are used instead.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html", "name": "ml.start_datafeed", "privileges": { @@ -11998,7 +11998,7 @@ "stability": "stable" } }, - "description": "Starts a trained model deployment, which allocates the model to every machine learning node.", + "description": "Start a trained model deployment.\nIt allocates the model to every machine learning node.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trained-model-deployment.html", "name": "ml.start_trained_model_deployment", "privileges": { @@ -12041,7 +12041,7 @@ "stability": "stable" } }, - "description": "Stops one or more data frame analytics jobs.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.", + "description": "Stop one or more data frame analytics jobs.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html", "name": "ml.stop_data_frame_analytics", "privileges": { @@ -12084,7 +12084,7 @@ "stability": "stable" } }, - "description": "Stops one or more datafeeds.\nA datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.", + "description": "Stop one or more datafeeds.\nA datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html", "name": "ml.stop_datafeed", "privileges": { @@ -12127,7 +12127,7 @@ "stability": "stable" } }, - "description": "Stops a trained model deployment.", + "description": "Stop a trained model deployment.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/stop-trained-model-deployment.html", "name": "ml.stop_trained_model_deployment", "privileges": { @@ -12170,7 +12170,7 @@ "stability": "stable" } }, - "description": "Updates an existing data frame analytics job.", + "description": "Update a data frame analytics job.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html", "name": "ml.update_data_frame_analytics", "privileges": { @@ -12220,7 +12220,7 @@ "stability": "stable" } }, - "description": "Updates the properties of a datafeed.\nYou must stop and start the datafeed for the changes to be applied.\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at\nthe time of the update and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.", + "description": "Update a datafeed.\nYou must stop and start the datafeed for the changes to be applied.\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at\nthe time of the update and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html", "name": "ml.update_datafeed", "privileges": { @@ -12263,7 +12263,7 @@ "stability": "stable" } }, - "description": "Updates the description of a filter, adds items, or removes items from the list.", + "description": "Update a filter.\nUpdates the description of a filter, adds items, or removes items from the list.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html", "name": "ml.update_filter", "privileges": { @@ -12306,7 +12306,7 @@ "stability": "stable" } }, - "description": "Updates certain properties of an anomaly detection job.", + "description": "Update an anomaly detection job.\nUpdates certain properties of an anomaly detection job.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html", "name": "ml.update_job", "privileges": { @@ -12349,7 +12349,7 @@ "stability": "stable" } }, - "description": "Updates certain properties of a snapshot.", + "description": "Update a snapshot.\nUpdates certain properties of a snapshot.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html", "name": "ml.update_model_snapshot", "privileges": { @@ -12392,7 +12392,7 @@ "stability": "stable" } }, - "description": "Starts a trained model deployment, which allocates the model to every machine learning node.", + "description": "Update a trained model deployment.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-trained-model-deployment.html", "name": "ml.update_trained_model_deployment", "privileges": { @@ -12435,7 +12435,7 @@ "stability": "stable" } }, - "description": "Upgrades an anomaly detection model snapshot to the latest major version.\nOver time, older snapshot formats are deprecated and removed. Anomaly\ndetection jobs support only snapshots that are from the current or previous\nmajor version.\nThis API provides a means to upgrade a snapshot to the current major version.\nThis aids in preparing the cluster for an upgrade to the next major version.\nOnly one snapshot per anomaly detection job can be upgraded at a time and the\nupgraded snapshot cannot be the current snapshot of the anomaly detection\njob.", + "description": "Upgrade a snapshot.\nUpgrades an anomaly detection model snapshot to the latest major version.\nOver time, older snapshot formats are deprecated and removed. Anomaly\ndetection jobs support only snapshots that are from the current or previous\nmajor version.\nThis API provides a means to upgrade a snapshot to the current major version.\nThis aids in preparing the cluster for an upgrade to the next major version.\nOnly one snapshot per anomaly detection job can be upgraded at a time and the\nupgraded snapshot cannot be the current snapshot of the anomaly detection\njob.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-upgrade-job-model-snapshot.html", "name": "ml.upgrade_job_snapshot", "privileges": { @@ -156282,7 +156282,7 @@ } ] }, - "description": "Forces any buffered data to be processed by the job.\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.", + "description": "Force buffered data to be processed.\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.", "inherits": { "type": { "name": "RequestBase", @@ -156456,7 +156456,7 @@ } ] }, - "description": "Predicts the future behavior of a time series by using its historical\nbehavior.\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.", + "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.", "inherits": { "type": { "name": "RequestBase", @@ -156671,7 +156671,7 @@ } ] }, - "description": "Retrieves anomaly detection job results for one or more buckets.\nThe API presents a chronological view of the records, grouped by bucket.", + "description": "Get anomaly detection job results.\nThe API presents a chronological view of the records, grouped by bucket.", "inherits": { "type": { "name": "RequestBase", @@ -156875,7 +156875,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves information about the scheduled events in calendars.", + "description": "Get info about events in calendars.", "inherits": { "type": { "name": "RequestBase", @@ -157075,7 +157075,7 @@ } ] }, - "description": "Retrieves configuration information for calendars.", + "description": "Get calendar configuration info.", "inherits": { "type": { "name": "RequestBase", @@ -157190,7 +157190,7 @@ } ] }, - "description": "Retrieves anomaly detection job results for one or more categories.", + "description": "Get anomaly detection job results for categories.", "inherits": { "type": { "name": "RequestBase", @@ -157315,7 +157315,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves configuration information for data frame analytics jobs.\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.", + "description": "Get data frame analytics job configuration info.\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.", "inherits": { "type": { "name": "RequestBase", @@ -157443,7 +157443,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves usage information for data frame analytics jobs.", + "description": "Get data frame analytics jobs usage info.", "inherits": { "type": { "name": "RequestBase", @@ -157571,7 +157571,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves usage information for datafeeds.\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``, or by omitting the ``. 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.", + "description": "Get datafeeds usage info.\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``, or by omitting the ``. 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.", "inherits": { "type": { "name": "RequestBase", @@ -157658,7 +157658,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves configuration information for datafeeds.\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``, or by omitting the ``.\nThis API returns a maximum of 10,000 datafeeds.", + "description": "Get datafeeds configuration info.\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``, or by omitting the ``.\nThis API returns a maximum of 10,000 datafeeds.", "inherits": { "type": { "name": "RequestBase", @@ -157758,7 +157758,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves filters.\nYou can get a single filter or all filters.", + "description": "Get filters.\nYou can get a single filter or all filters.", "inherits": { "type": { "name": "RequestBase", @@ -157873,7 +157873,7 @@ } ] }, - "description": "Retrieves anomaly detection job results for one or more influencers.\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.", + "description": "Get anomaly detection job results for influencers.\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.", "inherits": { "type": { "name": "RequestBase", @@ -158052,7 +158052,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves usage information for anomaly detection jobs.", + "description": "Get anomaly detection jobs usage info.", "inherits": { "type": { "name": "RequestBase", @@ -158140,7 +158140,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves configuration information for anomaly detection jobs.\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 ``, or by omitting the ``.", + "description": "Get anomaly detection jobs configuration info.\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 ``, or by omitting the ``.", "inherits": { "type": { "name": "RequestBase", @@ -158629,7 +158629,7 @@ "body": { "kind": "no_body" }, - "description": "Get 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.", + "description": "Get machine learning memory usage info.\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.", "inherits": { "type": { "name": "RequestBase", @@ -158695,7 +158695,7 @@ } } ], - "specLocation": "ml/get_memory_stats/MlGetMemoryStatsRequest.ts#L24-L59" + "specLocation": "ml/get_memory_stats/MlGetMemoryStatsRequest.ts#L24-L60" }, { "body": { @@ -158761,7 +158761,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves usage information for anomaly detection job model snapshot upgrades.", + "description": "Get anomaly detection job model snapshot upgrade usage info.", "inherits": { "type": { "name": "RequestBase", @@ -158922,7 +158922,7 @@ } ] }, - "description": "Retrieves information about model snapshots.", + "description": "Get model snapshots info.", "inherits": { "type": { "name": "RequestBase", @@ -159185,7 +159185,7 @@ } ] }, - "description": "Retrieves 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.", + "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.", "inherits": { "type": { "name": "RequestBase", @@ -159312,7 +159312,7 @@ } } ], - "specLocation": "ml/get_overall_buckets/MlGetOverallBucketsRequest.ts#L25-L143" + "specLocation": "ml/get_overall_buckets/MlGetOverallBucketsRequest.ts#L25-L145" }, { "body": { @@ -159451,7 +159451,7 @@ } ] }, - "description": "Retrieves anomaly records for an anomaly detection job.\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.", + "description": "Get anomaly records for an anomaly detection job.\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.", "inherits": { "type": { "name": "RequestBase", @@ -159630,7 +159630,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves configuration information for a trained model.", + "description": "Get trained model configuration info.", "inherits": { "type": { "name": "RequestBase", @@ -159810,7 +159810,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves usage information for trained models. You 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.", + "description": "Get trained models usage info.\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.", "inherits": { "type": { "name": "RequestBase", @@ -159877,7 +159877,7 @@ } } ], - "specLocation": "ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts#L24-L64" + "specLocation": "ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts#L24-L65" }, { "body": { @@ -159962,7 +159962,7 @@ } ] }, - "description": "Evaluates a trained model.", + "description": "Evaluate a trained model.", "inherits": { "type": { "name": "RequestBase", @@ -160232,7 +160232,7 @@ "body": { "kind": "no_body" }, - "description": "Returns defaults and limits used by machine learning.\nThis endpoint is designed to be used by a user interface that needs to fully\nunderstand machine learning configurations where some options are not\nspecified, meaning that the defaults should be used. This endpoint may be\nused to find out what those defaults are. It also provides information about\nthe maximum size of machine learning jobs that could run in the current\ncluster configuration.", + "description": "Return ML defaults and limits.\nReturns defaults and limits used by machine learning.\nThis endpoint is designed to be used by a user interface that needs to fully\nunderstand machine learning configurations where some options are not\nspecified, meaning that the defaults should be used. This endpoint may be\nused to find out what those defaults are. It also provides information about\nthe maximum size of machine learning jobs that could run in the current\ncluster configuration.", "inherits": { "type": { "name": "RequestBase", @@ -160246,7 +160246,7 @@ }, "path": [], "query": [], - "specLocation": "ml/info/MlInfoRequest.ts#L22-L35" + "specLocation": "ml/info/MlInfoRequest.ts#L22-L36" }, { "body": { @@ -160327,7 +160327,7 @@ } ] }, - "description": "Open anomaly detection jobs.\nAn anomaly detection job must be opened in order for it to be ready to\nreceive and analyze data. It can be opened and closed multiple times\nthroughout 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.", + "description": "Open anomaly detection jobs.\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.", "inherits": { "type": { "name": "RequestBase", @@ -160368,7 +160368,7 @@ } } ], - "specLocation": "ml/open_job/MlOpenJobRequest.ts#L24-L59" + "specLocation": "ml/open_job/MlOpenJobRequest.ts#L24-L58" }, { "body": { @@ -160430,7 +160430,7 @@ } ] }, - "description": "Adds scheduled events to a calendar.", + "description": "Add scheduled events to calendar.", "inherits": { "type": { "name": "RequestBase", @@ -160508,7 +160508,7 @@ "description": "Posting data directly to anomaly detection jobs is deprecated, in a future major version a datafeed will be required.", "version": "7.11.0" }, - "description": "Sends 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.", + "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.", "generics": [ { "name": "TData", @@ -160834,7 +160834,7 @@ } ] }, - "description": "Previews the extracted features used by a data frame analytics config.", + "description": "Preview features used by data frame analytics.\nPreviews the extracted features used by a data frame analytics config.", "inherits": { "type": { "name": "RequestBase", @@ -160861,7 +160861,7 @@ } ], "query": [], - "specLocation": "ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts#L24-L47" + "specLocation": "ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts#L24-L48" }, { "body": { @@ -160935,7 +160935,7 @@ } ] }, - "description": "Previews a datafeed.\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.", + "description": "Preview a datafeed.\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.", "inherits": { "type": { "name": "RequestBase", @@ -161052,7 +161052,7 @@ } ] }, - "description": "Creates a calendar.", + "description": "Create a calendar.", "inherits": { "type": { "name": "RequestBase", @@ -161137,7 +161137,7 @@ "body": { "kind": "no_body" }, - "description": "Adds an anomaly detection job to a calendar.", + "description": "Add anomaly detection job to calendar.", "inherits": { "type": { "name": "RequestBase", @@ -161371,7 +161371,7 @@ } ] }, - "description": "Instantiates a data frame analytics job.\nThis API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.", + "description": "Create a data frame analytics job.\nThis API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.", "inherits": { "type": { "name": "RequestBase", @@ -161763,7 +161763,7 @@ } ] }, - "description": "Instantiates a datafeed.\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.\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.", + "description": "Create a datafeed.\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.\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.", "inherits": { "type": { "name": "RequestBase", @@ -162088,7 +162088,7 @@ } ] }, - "description": "Instantiates a filter.\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.", + "description": "Create a filter.\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.", "inherits": { "type": { "name": "RequestBase", @@ -163103,7 +163103,7 @@ } ] }, - "description": "Enables you to supply a trained model that is not created by data frame analytics.", + "description": "Supply external trained model.\nEnable you to supply a trained model that is not created by data frame analytics.", "inherits": { "type": { "name": "RequestBase", @@ -163167,7 +163167,7 @@ } } ], - "specLocation": "ml/put_trained_model/MlPutTrainedModelRequest.ts#L29-L124" + "specLocation": "ml/put_trained_model/MlPutTrainedModelRequest.ts#L29-L125" }, { "body": { @@ -163498,7 +163498,7 @@ "body": { "kind": "no_body" }, - "description": "Creates or updates a trained model alias. A trained model alias is a logical\nname used to reference a single trained model.\nYou can use aliases instead of trained model identifiers to make it easier to\nreference your models. For example, you can use aliases in inference\naggregations and processors.\nAn alias must be unique and refer to only a single trained model. However,\nyou can have multiple aliases for each trained model.\nIf you use this API to update an alias such that it references a different\ntrained model ID and the model uses a different type of data frame analytics,\nan error occurs. For example, this situation occurs if you have a trained\nmodel for regression analysis and a trained model for classification\nanalysis; you cannot reassign an alias from one type of trained model to\nanother.\nIf you use this API to update an alias and there are very few input fields in\ncommon between the old and new trained models for the model alias, the API\nreturns a warning.", + "description": "Create or update a trained model alias.\nA trained model alias is a logical name used to reference a single trained\nmodel.\nYou can use aliases instead of trained model identifiers to make it easier to\nreference your models. For example, you can use aliases in inference\naggregations and processors.\nAn alias must be unique and refer to only a single trained model. However,\nyou can have multiple aliases for each trained model.\nIf you use this API to update an alias such that it references a different\ntrained model ID and the model uses a different type of data frame analytics,\nan error occurs. For example, this situation occurs if you have a trained\nmodel for regression analysis and a trained model for classification\nanalysis; you cannot reassign an alias from one type of trained model to\nanother.\nIf you use this API to update an alias and there are very few input fields in\ncommon between the old and new trained models for the model alias, the API\nreturns a warning.", "inherits": { "type": { "name": "RequestBase", @@ -163551,7 +163551,7 @@ } } ], - "specLocation": "ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts#L23-L65" + "specLocation": "ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts#L23-L66" }, { "body": { @@ -163616,7 +163616,7 @@ } ] }, - "description": "Creates part of a trained model definition.", + "description": "Create part of a trained model definition.", "inherits": { "type": { "name": "RequestBase", @@ -163741,7 +163741,7 @@ } ] }, - "description": "Creates a trained model vocabulary.\nThis API is supported only for natural language processing (NLP) models.\nThe vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.", + "description": "Create a trained model vocabulary.\nThis API is supported only for natural language processing (NLP) models.\nThe vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.", "inherits": { "type": { "name": "RequestBase", @@ -163795,7 +163795,7 @@ "body": { "kind": "no_body" }, - "description": "Resets an anomaly detection job.\nAll model state and results are deleted. The job is ready to start over as if\nit had just been created.\nIt is not currently possible to reset multiple jobs using wildcards or a\ncomma separated list.", + "description": "Reset an anomaly detection job.\nAll model state and results are deleted. The job is ready to start over as if\nit had just been created.\nIt is not currently possible to reset multiple jobs using wildcards or a\ncomma separated list.", "inherits": { "type": { "name": "RequestBase", @@ -163891,7 +163891,7 @@ } ] }, - "description": "Reverts to a specific snapshot.\nThe machine learning features react quickly to anomalous input, learning new\nbehaviors in data. Highly anomalous input increases the variance in the\nmodels whilst the system learns whether this is a new step-change in behavior\nor a one-off event. In the case where this anomalous input is known to be a\none-off, then it might be appropriate to reset the model state to a time\nbefore this event. For example, you might consider reverting to a saved\nsnapshot after Black Friday or a critical system failure.", + "description": "Revert to a snapshot.\nThe machine learning features react quickly to anomalous input, learning new\nbehaviors in data. Highly anomalous input increases the variance in the\nmodels whilst the system learns whether this is a new step-change in behavior\nor a one-off event. In the case where this anomalous input is known to be a\none-off, then it might be appropriate to reset the model state to a time\nbefore this event. For example, you might consider reverting to a saved\nsnapshot after Black Friday or a critical system failure.", "inherits": { "type": { "name": "RequestBase", @@ -163977,7 +163977,7 @@ "body": { "kind": "no_body" }, - "description": "Sets a cluster wide upgrade_mode setting that prepares machine learning\nindices for an upgrade.\nWhen upgrading your cluster, in some circumstances you must restart your\nnodes and reindex your machine learning indices. In those circumstances,\nthere must be no machine learning jobs running. You can close the machine\nlearning jobs, do the upgrade, then open all the jobs again. Alternatively,\nyou can use this API to temporarily halt tasks associated with the jobs and\ndatafeeds and prevent new jobs from opening. You can also use this API\nduring upgrades that do not require you to reindex your machine learning\nindices, though stopping jobs is not a requirement in that case.\nYou can see the current value for the upgrade_mode setting by using the get\nmachine learning info API.", + "description": "Set upgrade_mode for ML indices.\nSets a cluster wide upgrade_mode setting that prepares machine learning\nindices for an upgrade.\nWhen upgrading your cluster, in some circumstances you must restart your\nnodes and reindex your machine learning indices. In those circumstances,\nthere must be no machine learning jobs running. You can close the machine\nlearning jobs, do the upgrade, then open all the jobs again. Alternatively,\nyou can use this API to temporarily halt tasks associated with the jobs and\ndatafeeds and prevent new jobs from opening. You can also use this API\nduring upgrades that do not require you to reindex your machine learning\nindices, though stopping jobs is not a requirement in that case.\nYou can see the current value for the upgrade_mode setting by using the get\nmachine learning info API.", "inherits": { "type": { "name": "RequestBase", @@ -164018,7 +164018,7 @@ } } ], - "specLocation": "ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts#L23-L56" + "specLocation": "ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts#L23-L57" }, { "body": { @@ -164045,7 +164045,7 @@ "body": { "kind": "no_body" }, - "description": "Starts a data frame analytics job.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.\nIf the destination index does not exist, it is created automatically the\nfirst time you start the data frame analytics job. The\n`index.number_of_shards` and `index.number_of_replicas` settings for the\ndestination index are copied from the source index. If there are multiple\nsource indices, the destination index copies the highest setting values. The\nmappings for the destination index are also copied from the source indices.\nIf there are any mapping conflicts, the job fails to start.\nIf the destination index exists, it is used as is. You can therefore set up\nthe destination index in advance with custom settings and mappings.", + "description": "Start a data frame analytics job.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.\nIf the destination index does not exist, it is created automatically the\nfirst time you start the data frame analytics job. The\n`index.number_of_shards` and `index.number_of_replicas` settings for the\ndestination index are copied from the source index. If there are multiple\nsource indices, the destination index copies the highest setting values. The\nmappings for the destination index are also copied from the source indices.\nIf there are any mapping conflicts, the job fails to start.\nIf the destination index exists, it is used as is. You can therefore set up\nthe destination index in advance with custom settings and mappings.", "inherits": { "type": { "name": "RequestBase", @@ -164170,7 +164170,7 @@ } ] }, - "description": "Starts one or more datafeeds.\n\nA datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.\n\nBefore you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.\n\nIf you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.\nIf new data was indexed for that exact millisecond between stopping and starting, it will be ignored.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or\nupdate it had at the time of creation or update and runs the query using those same roles. If you provided secondary\nauthorization headers when you created or updated the datafeed, those credentials are used instead.", + "description": "Start one or more datafeeds.\n\nA datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.\n\nBefore you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.\n\nIf you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.\nIf new data was indexed for that exact millisecond between stopping and starting, it will be ignored.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or\nupdate it had at the time of creation or update and runs the query using those same roles. If you provided secondary\nauthorization headers when you created or updated the datafeed, those credentials are used instead.", "inherits": { "type": { "name": "RequestBase", @@ -164281,7 +164281,7 @@ "body": { "kind": "no_body" }, - "description": "Starts a trained model deployment, which allocates the model to every machine learning node.", + "description": "Start a trained model deployment.\nIt allocates the model to every machine learning node.", "inherits": { "type": { "name": "RequestBase", @@ -164415,7 +164415,7 @@ } } ], - "specLocation": "ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts#L29-L92" + "specLocation": "ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts#L29-L93" }, { "body": { @@ -164448,7 +164448,7 @@ "body": { "kind": "no_body" }, - "description": "Stops one or more data frame analytics jobs.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.", + "description": "Stop one or more data frame analytics jobs.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.", "inherits": { "type": { "name": "RequestBase", @@ -164589,7 +164589,7 @@ } ] }, - "description": "Stops one or more datafeeds.\nA datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.", + "description": "Stop one or more datafeeds.\nA datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.", "inherits": { "type": { "name": "RequestBase", @@ -164689,7 +164689,7 @@ "body": { "kind": "no_body" }, - "description": "Stops a trained model deployment.", + "description": "Stop a trained model deployment.", "inherits": { "type": { "name": "RequestBase", @@ -164833,7 +164833,7 @@ } ] }, - "description": "Updates an existing data frame analytics job.", + "description": "Update a data frame analytics job.", "inherits": { "type": { "name": "RequestBase", @@ -165201,7 +165201,7 @@ } ] }, - "description": "Updates the properties of a datafeed.\nYou must stop and start the datafeed for the changes to be applied.\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at\nthe time of the update and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.", + "description": "Update a datafeed.\nYou must stop and start the datafeed for the changes to be applied.\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at\nthe time of the update and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.", "inherits": { "type": { "name": "RequestBase", @@ -165541,7 +165541,7 @@ } ] }, - "description": "Updates the description of a filter, adds items, or removes items from the list.", + "description": "Update a filter.\nUpdates the description of a filter, adds items, or removes items from the list.", "inherits": { "type": { "name": "RequestBase", @@ -165568,7 +165568,7 @@ } ], "query": [], - "specLocation": "ml/update_filter/MlUpdateFilterRequest.ts#L23-L51" + "specLocation": "ml/update_filter/MlUpdateFilterRequest.ts#L23-L52" }, { "body": { @@ -165830,7 +165830,7 @@ } ] }, - "description": "Updates certain properties of an anomaly detection job.", + "description": "Update an anomaly detection job.\nUpdates certain properties of an anomaly detection job.", "inherits": { "type": { "name": "RequestBase", @@ -165857,7 +165857,7 @@ } ], "query": [], - "specLocation": "ml/update_job/MlUpdateJobRequest.ts#L33-L138" + "specLocation": "ml/update_job/MlUpdateJobRequest.ts#L33-L139" }, { "body": { @@ -166169,7 +166169,7 @@ } ] }, - "description": "Updates certain properties of a snapshot.", + "description": "Update a snapshot.\nUpdates certain properties of a snapshot.", "inherits": { "type": { "name": "RequestBase", @@ -166208,7 +166208,7 @@ } ], "query": [], - "specLocation": "ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts#L23-L54" + "specLocation": "ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts#L23-L55" }, { "body": { @@ -166267,7 +166267,7 @@ } ] }, - "description": "Starts a trained model deployment, which allocates the model to every machine learning node.", + "description": "Update a trained model deployment.", "inherits": { "type": { "name": "RequestBase", @@ -166341,7 +166341,7 @@ "body": { "kind": "no_body" }, - "description": "Upgrades an anomaly detection model snapshot to the latest major version.\nOver time, older snapshot formats are deprecated and removed. Anomaly\ndetection jobs support only snapshots that are from the current or previous\nmajor version.\nThis API provides a means to upgrade a snapshot to the current major version.\nThis aids in preparing the cluster for an upgrade to the next major version.\nOnly one snapshot per anomaly detection job can be upgraded at a time and the\nupgraded snapshot cannot be the current snapshot of the anomaly detection\njob.", + "description": "Upgrade a snapshot.\nUpgrades an anomaly detection model snapshot to the latest major version.\nOver time, older snapshot formats are deprecated and removed. Anomaly\ndetection jobs support only snapshots that are from the current or previous\nmajor version.\nThis API provides a means to upgrade a snapshot to the current major version.\nThis aids in preparing the cluster for an upgrade to the next major version.\nOnly one snapshot per anomaly detection job can be upgraded at a time and the\nupgraded snapshot cannot be the current snapshot of the anomaly detection\njob.", "inherits": { "type": { "name": "RequestBase", @@ -166407,7 +166407,7 @@ } } ], - "specLocation": "ml/upgrade_job_snapshot/MlUpgradeJobSnapshotRequest.ts#L24-L63" + "specLocation": "ml/upgrade_job_snapshot/MlUpgradeJobSnapshotRequest.ts#L24-L64" }, { "body": { diff --git a/specification/ml/get_calendars/MlGetCalendarsRequest.ts b/specification/ml/get_calendars/MlGetCalendarsRequest.ts index 15188181c4..e50affc81f 100644 --- a/specification/ml/get_calendars/MlGetCalendarsRequest.ts +++ b/specification/ml/get_calendars/MlGetCalendarsRequest.ts @@ -23,7 +23,7 @@ import { Id } from '@_types/common' import { integer } from '@_types/Numeric' /** - * Get config info for calendars. + * Get calendar configuration info. * @rest_spec_name ml.get_calendars * @availability stack since=6.2.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts b/specification/ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts index 76b4ab00b5..8329aefe9c 100644 --- a/specification/ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts +++ b/specification/ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts @@ -22,7 +22,7 @@ import { Id } from '@_types/common' import { integer } from '@_types/Numeric' /** - * Get config info for data frame analytics jobs. + * Get data frame analytics job configuration info. * You can get information for multiple data frame analytics jobs in a single * API request by using a comma-separated list of data frame analytics jobs or a * wildcard expression. diff --git a/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts b/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts index 2726767eb3..1ed18fd7a4 100644 --- a/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts +++ b/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts @@ -22,7 +22,7 @@ import { Id } from '@_types/common' import { integer } from '@_types/Numeric' /** - * Get usage info for data frame analytics jobs. + * Get data frame analytics jobs usage info. * @rest_spec_name ml.get_data_frame_analytics_stats * @availability stack since=7.3.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts b/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts index feae26df31..0e41438549 100644 --- a/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts +++ b/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Ids } from '@_types/common' /** - * Get usage info for datafeeds. + * Get datafeeds usage info. * You can get statistics for multiple datafeeds in a single API request by * using a comma-separated list of datafeeds or a wildcard expression. You can * get statistics for all datafeeds by using `_all`, by specifying `*` as the diff --git a/specification/ml/get_datafeeds/MlGetDatafeedsRequest.ts b/specification/ml/get_datafeeds/MlGetDatafeedsRequest.ts index 6770056a7a..f4204ae14e 100644 --- a/specification/ml/get_datafeeds/MlGetDatafeedsRequest.ts +++ b/specification/ml/get_datafeeds/MlGetDatafeedsRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Ids } from '@_types/common' /** - * Get config info for datafeeds. + * Get datafeeds configuration info. * You can get information for multiple datafeeds in a single API request by * using a comma-separated list of datafeeds or a wildcard expression. You can * get information for all datafeeds by using `_all`, by specifying `*` as the diff --git a/specification/ml/get_job_stats/MlGetJobStatsRequest.ts b/specification/ml/get_job_stats/MlGetJobStatsRequest.ts index d1f09d96c6..52d1c71628 100644 --- a/specification/ml/get_job_stats/MlGetJobStatsRequest.ts +++ b/specification/ml/get_job_stats/MlGetJobStatsRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Get usage info for anomaly detection jobs. + * Get anomaly detection jobs usage info. * @rest_spec_name ml.get_job_stats * @availability stack since=5.5.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/get_jobs/MlGetJobsRequest.ts b/specification/ml/get_jobs/MlGetJobsRequest.ts index 3a425dd875..98761ac0ec 100644 --- a/specification/ml/get_jobs/MlGetJobsRequest.ts +++ b/specification/ml/get_jobs/MlGetJobsRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Ids } from '@_types/common' /** - * Get config info for anomaly detection jobs. + * Get anomaly detection jobs configuration info. * You can get information for multiple anomaly detection jobs in a single API * request by using a group name, a comma-separated list of jobs, or a wildcard * expression. You can get information for all anomaly detection jobs by using diff --git a/specification/ml/get_memory_stats/MlGetMemoryStatsRequest.ts b/specification/ml/get_memory_stats/MlGetMemoryStatsRequest.ts index 338d6c081d..100cba2f87 100644 --- a/specification/ml/get_memory_stats/MlGetMemoryStatsRequest.ts +++ b/specification/ml/get_memory_stats/MlGetMemoryStatsRequest.ts @@ -22,7 +22,7 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** - * Get info on machine learning memory usage. + * Get machine learning memory usage info. * Get information about how machine learning jobs and trained models are using memory, * on each node, both within the JVM heap, and natively, outside of the JVM. * @rest_spec_name ml.get_memory_stats diff --git a/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts b/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts index bf8f3ba2d1..b535ae4254 100644 --- a/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts +++ b/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Get usage info for anomaly detection job model snapshot upgrades. + * Get anomaly detection job model snapshot upgrade usage info. * @rest_spec_name ml.get_model_snapshot_upgrade_stats * @availability stack since=7.16.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts b/specification/ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts index b1aa2d5287..bfc849a1b1 100644 --- a/specification/ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts +++ b/specification/ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts @@ -24,7 +24,7 @@ import { integer } from '@_types/Numeric' import { Duration, DateTime } from '@_types/Time' /** - * Get info about model snapshots. + * Get model snapshots info. * @rest_spec_name ml.get_model_snapshots * @availability stack since=5.4.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/ml/get_trained_models/MlGetTrainedModelRequest.ts b/specification/ml/get_trained_models/MlGetTrainedModelRequest.ts index caeefc52bc..821c2083b9 100644 --- a/specification/ml/get_trained_models/MlGetTrainedModelRequest.ts +++ b/specification/ml/get_trained_models/MlGetTrainedModelRequest.ts @@ -23,7 +23,7 @@ import { integer } from '@_types/Numeric' import { Include } from '@ml/_types/Include' /** - * Get config info for a trained model. + * Get trained model configuration info. * @rest_spec_name ml.get_trained_models * @availability stack since=7.10.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts b/specification/ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts index dc3dc36263..ad11fedff7 100644 --- a/specification/ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts +++ b/specification/ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts @@ -22,7 +22,7 @@ import { Ids } from '@_types/common' import { integer } from '@_types/Numeric' /** - * get usage info for trained models. + * Get trained models usage info. * You can get usage information for multiple trained * models in a single API request by using a comma-separated list of model IDs or a wildcard expression. * @rest_spec_name ml.get_trained_models_stats diff --git a/specification/ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts b/specification/ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts index 3c5515e50d..8ba0c0ca15 100644 --- a/specification/ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts +++ b/specification/ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts @@ -22,7 +22,8 @@ import { Id } from '@_types/common' import { DataframePreviewConfig } from './types' /** - * Preview the extracted features used by a data frame analytics config. + * Preview features used by data frame analytics. + * Previews the extracted features used by a data frame analytics config. * @rest_spec_name ml.preview_data_frame_analytics * @availability stack since=7.13.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts b/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts index 58b4a30b21..808ccb519b 100644 --- a/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts +++ b/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts @@ -27,6 +27,7 @@ import { TrainedModelType } from '../_types/TrainedModel' import { InferenceConfigCreateContainer } from '@ml/_types/inference' /** + * Supply external trained model. * Enable you to supply a trained model that is not created by data frame analytics. * @rest_spec_name ml.put_trained_model * @availability stack since=7.10.0 stability=stable diff --git a/specification/ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts b/specification/ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts index a27ac244d2..cb7487379e 100644 --- a/specification/ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts +++ b/specification/ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Duration } from '@_types/Time' /** - * Set upgrade_mode that prepares ML indices for upgrade. + * Set upgrade_mode for ML indices. * Sets a cluster wide upgrade_mode setting that prepares machine learning * indices for an upgrade. * When upgrading your cluster, in some circumstances you must restart your From ee27f0a1e86e09db9836da519237978a4aeeb7f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Fri, 9 Aug 2024 11:15:09 +0200 Subject: [PATCH 4/5] Apply suggestions from code review Co-authored-by: Lisa Cawley --- specification/ml/start_datafeed/MlStartDatafeedRequest.ts | 2 +- .../MlStopDataFrameAnalyticsRequest.ts | 2 +- specification/ml/stop_datafeed/MlStopDatafeedRequest.ts | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/ml/start_datafeed/MlStartDatafeedRequest.ts b/specification/ml/start_datafeed/MlStartDatafeedRequest.ts index d608d396e9..7ec6501727 100644 --- a/specification/ml/start_datafeed/MlStartDatafeedRequest.ts +++ b/specification/ml/start_datafeed/MlStartDatafeedRequest.ts @@ -22,7 +22,7 @@ import { Id } from '@_types/common' import { Duration, DateTime } from '@_types/Time' /** - * Start one or more datafeeds. + * Start datafeeds. * * A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped * multiple times throughout its lifecycle. diff --git a/specification/ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts b/specification/ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts index 776eb44f9a..82655335e8 100644 --- a/specification/ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts +++ b/specification/ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts @@ -22,7 +22,7 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** - * Stop one or more data frame analytics jobs. + * Stop data frame analytics jobs. * A data frame analytics job can be started and stopped multiple times * throughout its lifecycle. * @rest_spec_name ml.stop_data_frame_analytics diff --git a/specification/ml/stop_datafeed/MlStopDatafeedRequest.ts b/specification/ml/stop_datafeed/MlStopDatafeedRequest.ts index ff8964d5e5..d73da165f4 100644 --- a/specification/ml/stop_datafeed/MlStopDatafeedRequest.ts +++ b/specification/ml/stop_datafeed/MlStopDatafeedRequest.ts @@ -22,7 +22,7 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** - * Stop one or more datafeeds. + * Stop datafeeds. * A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped * multiple times throughout its lifecycle. * @rest_spec_name ml.stop_datafeed From 2ab152293554d45d094cc0d0121dd799b13b1a40 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Fri, 9 Aug 2024 14:18:51 +0200 Subject: [PATCH 5/5] Apply suggestions from code review Co-authored-by: David Kyle --- specification/ml/get_buckets/MlGetBucketsRequest.ts | 2 +- .../ml/post_calendar_events/MlPostCalendarEventsRequest.ts | 2 +- specification/ml/put_trained_model/MlPutTrainedModelRequest.ts | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/ml/get_buckets/MlGetBucketsRequest.ts b/specification/ml/get_buckets/MlGetBucketsRequest.ts index e088eaf540..ab7cd973e1 100644 --- a/specification/ml/get_buckets/MlGetBucketsRequest.ts +++ b/specification/ml/get_buckets/MlGetBucketsRequest.ts @@ -24,7 +24,7 @@ import { double, integer } from '@_types/Numeric' import { DateTime } from '@_types/Time' /** - * Get anomaly detection job results. + * Get anomaly detection job results for buckets. * The API presents a chronological view of the records, grouped by bucket. * @rest_spec_name ml.get_buckets * @availability stack since=5.4.0 stability=stable diff --git a/specification/ml/post_calendar_events/MlPostCalendarEventsRequest.ts b/specification/ml/post_calendar_events/MlPostCalendarEventsRequest.ts index 8808457422..7fdcb4d63a 100644 --- a/specification/ml/post_calendar_events/MlPostCalendarEventsRequest.ts +++ b/specification/ml/post_calendar_events/MlPostCalendarEventsRequest.ts @@ -22,7 +22,7 @@ import { Id } from '@_types/common' import { CalendarEvent } from '../_types/CalendarEvent' /** - * Add scheduled events to calendar. + * Add scheduled events to the calendar. * @rest_spec_name ml.post_calendar_events * @availability stack since=6.2.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts b/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts index 808ccb519b..f1cef840e6 100644 --- a/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts +++ b/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts @@ -27,7 +27,7 @@ import { TrainedModelType } from '../_types/TrainedModel' import { InferenceConfigCreateContainer } from '@ml/_types/inference' /** - * Supply external trained model. + * Create a trained model. * Enable you to supply a trained model that is not created by data frame analytics. * @rest_spec_name ml.put_trained_model * @availability stack since=7.10.0 stability=stable