From d54f2e35a9f5d5133eb40ae2e76e3ab7e6087d89 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Tue, 30 Jul 2024 10:53:02 +0200 Subject: [PATCH 1/2] Reviews summaries of ML APIs (A-E). --- output/openapi/elasticsearch-openapi.json | 45 +++++++------- .../elasticsearch-serverless-openapi.json | 23 +++---- output/schema/schema.json | 62 +++++++++---------- ...ClearTrainedModelDeploymentCacheRequest.ts | 3 +- .../MlDeleteCalendarRequest.ts | 1 + .../MlDeleteCalendarEventRequest.ts | 2 +- .../MlDeleteCalendarJobRequest.ts | 2 +- .../MlDeleteDataFrameAnalyticsRequest.ts | 2 +- .../MlDeleteDatafeedRequest.ts | 2 +- .../MlDeleteExpiredDataRequest.ts | 2 +- .../ml/delete_filter/MlDeleteFilterRequest.ts | 2 +- .../MlDeleteForecastRequest.ts | 2 +- .../MlDeleteModelSnapshotRequest.ts | 2 +- .../MlDeleteTrainedModelRequest.ts | 4 +- .../MlDeleteTrainedModelAliasRequest.ts | 2 +- .../MlEstimateModelMemoryRequest.ts | 1 + .../MlExplainDataFrameAnalyticsRequest.ts | 2 +- 17 files changed, 82 insertions(+), 77 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 867bf076d1..e7bed32cf4 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -16975,8 +16975,8 @@ "tags": [ "ml.clear_trained_model_deployment_cache" ], - "summary": "Clears a trained model deployment cache on all nodes where the trained model is assigned", - "description": "A trained model deployment may have an inference cache enabled.\nAs requests are handled by each allocated node, their responses may be cached on that individual node.\nCalling this API clears the caches without restarting the deployment.", + "summary": "Clear trained model deployment cache", + "description": "Cache will be cleared on all nodes where the trained model is assigned.\nA trained model deployment may have an inference cache enabled.\nAs requests are handled by each allocated node, their responses may be cached on that individual node.\nCalling this API clears the caches without restarting the deployment.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/clear-trained-model-deployment-cache.html" }, @@ -17255,7 +17255,8 @@ "tags": [ "ml.delete_calendar" ], - "summary": "Removes all scheduled events from a calendar, then deletes it", + "summary": "Delete a calendar", + "description": "Removes all scheduled events from a calendar, then deletes it.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar.html" }, @@ -17293,7 +17294,7 @@ "tags": [ "ml.delete_calendar_event" ], - "summary": "Deletes scheduled events from a calendar", + "summary": "Delete events from a calendar", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-event.html" }, @@ -17405,7 +17406,7 @@ "tags": [ "ml.delete_calendar_job" ], - "summary": "Deletes anomaly detection jobs from a calendar", + "summary": "Delete anomaly jobs from a calendar", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-job.html" }, @@ -17644,7 +17645,7 @@ "tags": [ "ml.delete_data_frame_analytics" ], - "summary": "Deletes a data frame analytics job", + "summary": "Delete a data frame analytics job", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html" }, @@ -17936,7 +17937,7 @@ "tags": [ "ml.delete_datafeed" ], - "summary": "Deletes an existing datafeed", + "summary": "Delete a datafeed", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html" }, @@ -17984,7 +17985,7 @@ "tags": [ "ml.delete_expired_data" ], - "summary": "Deletes expired and unused machine learning data", + "summary": "Delete expired ML data", "description": "Deletes all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using _all, by specifying * as the , or by omitting the\n.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html" @@ -18017,7 +18018,7 @@ "tags": [ "ml.delete_expired_data" ], - "summary": "Deletes expired and unused machine learning data", + "summary": "Delete expired ML data", "description": "Deletes all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using _all, by specifying * as the , or by omitting the\n.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html" @@ -18154,7 +18155,7 @@ "tags": [ "ml.delete_filter" ], - "summary": "Deletes a filter", + "summary": "Delete a filter", "description": "If an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html" @@ -18293,7 +18294,7 @@ "tags": [ "ml.delete_forecast" ], - "summary": "Deletes forecasts from a machine learning job", + "summary": "Delete forecasts from a job", "description": "By default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html" @@ -18323,7 +18324,7 @@ "tags": [ "ml.delete_forecast" ], - "summary": "Deletes forecasts from a machine learning job", + "summary": "Delete forecasts from a job", "description": "By default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html" @@ -18729,7 +18730,7 @@ "tags": [ "ml.delete_model_snapshot" ], - "summary": "Deletes an existing model snapshot", + "summary": "Delete a model snapshot", "description": "You cannot delete the active model snapshot. To delete that snapshot, first\nrevert to a different one. To identify the active model snapshot, refer to\nthe `model_snapshot_id` in the results from the get jobs API.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html" @@ -18931,8 +18932,8 @@ "tags": [ "ml.delete_trained_model" ], - "summary": "Deletes an existing trained inference model that is currently not referenced\n", - "description": "by an ingest pipeline.", + "summary": "Delete an unreferenced trained model", + "description": "The request deletes a trained inference model that is not referenced by an ingest pipeline.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html" }, @@ -19038,7 +19039,7 @@ "tags": [ "ml.delete_trained_model_alias" ], - "summary": "Deletes a trained model alias", + "summary": "Delete a trained model alias", "description": "This API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html" @@ -19088,8 +19089,8 @@ "tags": [ "ml.estimate_model_memory" ], - "summary": "Makes an estimation of the memory usage for an anomaly detection job model", - "description": "It is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", + "summary": "Estimate job model memory usage", + "description": "Makes an estimation of the memory usage for an anomaly detection job model.\nIt is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html" }, @@ -19213,7 +19214,7 @@ "tags": [ "ml.explain_data_frame_analytics" ], - "summary": "Explains a data frame analytics config", + "summary": "Explain data frame analytics config", "description": "This API provides explanations for a data frame analytics config that either\nexists already or one that has not been created yet. The following\nexplanations are provided:\n* which fields are included or not in the analysis and why,\n* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.\nIf you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", "externalDocs": { "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html" @@ -19233,7 +19234,7 @@ "tags": [ "ml.explain_data_frame_analytics" ], - "summary": "Explains a data frame analytics config", + "summary": "Explain data frame analytics config", "description": "This API provides explanations for a data frame analytics config that either\nexists already or one that has not been created yet. The following\nexplanations are provided:\n* which fields are included or not in the analysis and why,\n* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.\nIf you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", "externalDocs": { "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html" @@ -19255,7 +19256,7 @@ "tags": [ "ml.explain_data_frame_analytics" ], - "summary": "Explains a data frame analytics config", + "summary": "Explain data frame analytics config", "description": "This API provides explanations for a data frame analytics config that either\nexists already or one that has not been created yet. The following\nexplanations are provided:\n* which fields are included or not in the analysis and why,\n* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.\nIf you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", "externalDocs": { "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html" @@ -19280,7 +19281,7 @@ "tags": [ "ml.explain_data_frame_analytics" ], - "summary": "Explains a data frame analytics config", + "summary": "Explain data frame analytics config", "description": "This API provides explanations for a data frame analytics config that either\nexists already or one that has not been created yet. The following\nexplanations are provided:\n* which fields are included or not in the analysis and why,\n* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.\nIf you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", "externalDocs": { "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html" diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 4e998207fa..7df6e103b0 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -10423,7 +10423,8 @@ "tags": [ "ml.delete_calendar" ], - "summary": "Removes all scheduled events from a calendar, then deletes it", + "summary": "Delete a calendar", + "description": "Removes all scheduled events from a calendar, then deletes it.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar.html" }, @@ -10461,7 +10462,7 @@ "tags": [ "ml.delete_calendar_event" ], - "summary": "Deletes scheduled events from a calendar", + "summary": "Delete events from a calendar", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-event.html" }, @@ -10573,7 +10574,7 @@ "tags": [ "ml.delete_calendar_job" ], - "summary": "Deletes anomaly detection jobs from a calendar", + "summary": "Delete anomaly jobs from a calendar", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-job.html" }, @@ -10812,7 +10813,7 @@ "tags": [ "ml.delete_data_frame_analytics" ], - "summary": "Deletes a data frame analytics job", + "summary": "Delete a data frame analytics job", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html" }, @@ -11104,7 +11105,7 @@ "tags": [ "ml.delete_datafeed" ], - "summary": "Deletes an existing datafeed", + "summary": "Delete a datafeed", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html" }, @@ -11259,7 +11260,7 @@ "tags": [ "ml.delete_filter" ], - "summary": "Deletes a filter", + "summary": "Delete a filter", "description": "If an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html" @@ -11733,8 +11734,8 @@ "tags": [ "ml.delete_trained_model" ], - "summary": "Deletes an existing trained inference model that is currently not referenced\n", - "description": "by an ingest pipeline.", + "summary": "Delete an unreferenced trained model", + "description": "The request deletes a trained inference model that is not referenced by an ingest pipeline.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html" }, @@ -11840,7 +11841,7 @@ "tags": [ "ml.delete_trained_model_alias" ], - "summary": "Deletes a trained model alias", + "summary": "Delete a trained model alias", "description": "This API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html" @@ -11890,8 +11891,8 @@ "tags": [ "ml.estimate_model_memory" ], - "summary": "Makes an estimation of the memory usage for an anomaly detection job model", - "description": "It is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", + "summary": "Estimate job model memory usage", + "description": "Makes an estimation of the memory usage for an anomaly detection job model.\nIt is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html" }, diff --git a/output/schema/schema.json b/output/schema/schema.json index 6434c9d49d..ec8cc22268 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -9333,7 +9333,7 @@ "stability": "stable" } }, - "description": "Clears a trained model deployment cache on all nodes where the trained model is assigned.\nA trained model deployment may have an inference cache enabled.\nAs requests are handled by each allocated node, their responses may be cached on that individual node.\nCalling this API clears the caches without restarting the deployment.", + "description": "Clear trained model deployment cache.\nCache will be cleared on all nodes where the trained model is assigned.\nA trained model deployment may have an inference cache enabled.\nAs requests are handled by each allocated node, their responses may be cached on that individual node.\nCalling this API clears the caches without restarting the deployment.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/clear-trained-model-deployment-cache.html", "name": "ml.clear_trained_model_deployment_cache", "privileges": { @@ -9420,7 +9420,7 @@ "stability": "stable" } }, - "description": "Removes all scheduled events from a calendar, then deletes it.", + "description": "Delete a calendar.\nRemoves all scheduled events from a calendar, then deletes it.", "docId": "ml-delete-calendar", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-calendar.html", "name": "ml.delete_calendar", @@ -9461,7 +9461,7 @@ "stability": "stable" } }, - "description": "Deletes scheduled events from a calendar.", + "description": "Delete events from a calendar.", "docId": "ml-delete-calendar-event", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-calendar-event.html", "name": "ml.delete_calendar_event", @@ -9497,7 +9497,7 @@ "stability": "stable" } }, - "description": "Deletes anomaly detection jobs from a calendar.", + "description": "Delete anomaly jobs from a calendar.", "docId": "ml-delete-calendar-job", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-calendar-job.html", "name": "ml.delete_calendar_job", @@ -9538,7 +9538,7 @@ "stability": "stable" } }, - "description": "Deletes a data frame analytics job.", + "description": "Delete a data frame analytics job.", "docId": "ml-delete-dfanalytics", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-dfanalytics.html", "name": "ml.delete_data_frame_analytics", @@ -9579,7 +9579,7 @@ "stability": "stable" } }, - "description": "Deletes an existing datafeed.", + "description": "Delete a datafeed.", "docId": "ml-delete-datafeed", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-datafeed.html", "name": "ml.delete_datafeed", @@ -9620,7 +9620,7 @@ "stability": "stable" } }, - "description": "Deletes expired and unused machine learning data.\nDeletes all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using _all, by specifying * as the , or by omitting the\n.", + "description": "Delete expired ML data.\nDeletes all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using _all, by specifying * as the , or by omitting the\n.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html", "name": "ml.delete_expired_data", "privileges": { @@ -9669,7 +9669,7 @@ "stability": "stable" } }, - "description": "Deletes a filter.\nIf an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", + "description": "Delete a filter.\nIf an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html", "name": "ml.delete_filter", "privileges": { @@ -9709,7 +9709,7 @@ "stability": "stable" } }, - "description": "Deletes forecasts from a machine learning job.\nBy default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire.", + "description": "Delete forecasts from a job.\nBy default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html", "name": "ml.delete_forecast", "privileges": { @@ -9795,7 +9795,7 @@ "stability": "stable" } }, - "description": "Deletes an existing model snapshot.\nYou cannot delete the active model snapshot. To delete that snapshot, first\nrevert to a different one. To identify the active model snapshot, refer to\nthe `model_snapshot_id` in the results from the get jobs API.", + "description": "Delete a model snapshot.\nYou cannot delete the active model snapshot. To delete that snapshot, first\nrevert to a different one. To identify the active model snapshot, refer to\nthe `model_snapshot_id` in the results from the get jobs API.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html", "name": "ml.delete_model_snapshot", "privileges": { @@ -9835,7 +9835,7 @@ "stability": "stable" } }, - "description": "Deletes an existing trained inference model that is currently not referenced\nby an ingest pipeline.", + "description": "Delete an unreferenced trained model.\nThe request deletes a trained inference model that is not referenced by an ingest pipeline.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html", "name": "ml.delete_trained_model", "privileges": { @@ -9875,7 +9875,7 @@ "stability": "stable" } }, - "description": "Deletes a trained model alias.\nThis API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", + "description": "Delete a trained model alias.\nThis API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html", "name": "ml.delete_trained_model_alias", "privileges": { @@ -9918,7 +9918,7 @@ "stability": "stable" } }, - "description": "Makes an estimation of the memory usage for an anomaly detection job model.\nIt is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", + "description": "Estimate job model memory usage.\nMakes an estimation of the memory usage for an anomaly detection job model.\nIt is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html", "name": "ml.estimate_model_memory", "privileges": { @@ -10004,7 +10004,7 @@ "stability": "stable" } }, - "description": "Explains a data frame analytics config.\nThis API provides explanations for a data frame analytics config that either\nexists already or one that has not been created yet. The following\nexplanations are provided:\n* which fields are included or not in the analysis and why,\n* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.\nIf you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", + "description": "Explain data frame analytics config.\nThis API provides explanations for a data frame analytics config that either\nexists already or one that has not been created yet. The following\nexplanations are provided:\n* which fields are included or not in the analysis and why,\n* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.\nIf you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", "docUrl": "http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html", "name": "ml.explain_data_frame_analytics", "privileges": { @@ -153590,7 +153590,7 @@ "body": { "kind": "no_body" }, - "description": "Clears a trained model deployment cache on all nodes where the trained model is assigned.\nA trained model deployment may have an inference cache enabled.\nAs requests are handled by each allocated node, their responses may be cached on that individual node.\nCalling this API clears the caches without restarting the deployment.", + "description": "Clear trained model deployment cache.\nCache will be cleared on all nodes where the trained model is assigned.\nA trained model deployment may have an inference cache enabled.\nAs requests are handled by each allocated node, their responses may be cached on that individual node.\nCalling this API clears the caches without restarting the deployment.", "inherits": { "type": { "name": "RequestBase", @@ -153617,7 +153617,7 @@ } ], "query": [], - "specLocation": "ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts#L25-L42" + "specLocation": "ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts#L25-L43" }, { "body": { @@ -153791,7 +153791,7 @@ "body": { "kind": "no_body" }, - "description": "Removes all scheduled events from a calendar, then deletes it.", + "description": "Delete a calendar.\nRemoves all scheduled events from a calendar, then deletes it.", "inherits": { "type": { "name": "RequestBase", @@ -153818,7 +153818,7 @@ } ], "query": [], - "specLocation": "ml/delete_calendar/MlDeleteCalendarRequest.ts#L23-L36" + "specLocation": "ml/delete_calendar/MlDeleteCalendarRequest.ts#L23-L37" }, { "body": { @@ -153845,7 +153845,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes scheduled events from a calendar.", + "description": "Delete events from a calendar.", "inherits": { "type": { "name": "RequestBase", @@ -153911,7 +153911,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes anomaly detection jobs from a calendar.", + "description": "Delete anomaly jobs from a calendar.", "inherits": { "type": { "name": "RequestBase", @@ -154008,7 +154008,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a data frame analytics job.", + "description": "Delete a data frame analytics job.", "inherits": { "type": { "name": "RequestBase", @@ -154089,7 +154089,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes an existing datafeed.", + "description": "Delete a datafeed.", "inherits": { "type": { "name": "RequestBase", @@ -154183,7 +154183,7 @@ } ] }, - "description": "Deletes expired and unused machine learning data.\nDeletes all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using _all, by specifying * as the , or by omitting the\n.", + "description": "Delete expired ML data.\nDeletes all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using _all, by specifying * as the , or by omitting the\n.", "inherits": { "type": { "name": "RequestBase", @@ -154269,7 +154269,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a filter.\nIf an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", + "description": "Delete a filter.\nIf an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", "inherits": { "type": { "name": "RequestBase", @@ -154323,7 +154323,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes forecasts from a machine learning job.\nBy default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire.", + "description": "Delete forecasts from a job.\nBy default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire.", "inherits": { "type": { "name": "RequestBase", @@ -154509,7 +154509,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes an existing model snapshot.\nYou cannot delete the active model snapshot. To delete that snapshot, first\nrevert to a different one. To identify the active model snapshot, refer to\nthe `model_snapshot_id` in the results from the get jobs API.", + "description": "Delete a model snapshot.\nYou cannot delete the active model snapshot. To delete that snapshot, first\nrevert to a different one. To identify the active model snapshot, refer to\nthe `model_snapshot_id` in the results from the get jobs API.", "inherits": { "type": { "name": "RequestBase", @@ -154575,7 +154575,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes an existing trained inference model that is currently not referenced\nby an ingest pipeline.", + "description": "Delete an unreferenced trained model.\nThe request deletes a trained inference model that is not referenced by an ingest pipeline.", "inherits": { "type": { "name": "RequestBase", @@ -154642,7 +154642,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a trained model alias.\nThis API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", + "description": "Delete a trained model alias.\nThis API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", "inherits": { "type": { "name": "RequestBase", @@ -154768,7 +154768,7 @@ } ] }, - "description": "Makes an estimation of the memory usage for an anomaly detection job model.\nIt is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", + "description": "Estimate job model memory usage.\nMakes an estimation of the memory usage for an anomaly detection job model.\nIt is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", "inherits": { "type": { "name": "RequestBase", @@ -154782,7 +154782,7 @@ }, "path": [], "query": [], - "specLocation": "ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts#L26-L61" + "specLocation": "ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts#L26-L62" }, { "body": { @@ -155661,7 +155661,7 @@ } ] }, - "description": "Explains a data frame analytics config.\nThis API provides explanations for a data frame analytics config that either\nexists already or one that has not been created yet. The following\nexplanations are provided:\n* which fields are included or not in the analysis and why,\n* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.\nIf you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", + "description": "Explain data frame analytics config.\nThis API provides explanations for a data frame analytics config that either\nexists already or one that has not been created yet. The following\nexplanations are provided:\n* which fields are included or not in the analysis and why,\n* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.\nIf you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", "inherits": { "type": { "name": "RequestBase", diff --git a/specification/ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts b/specification/ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts index 077eda9d56..81448358e9 100644 --- a/specification/ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts +++ b/specification/ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts @@ -23,7 +23,8 @@ import { integer } from '@_types/Numeric' import { Include } from '@ml/_types/Include' /** - * Clears a trained model deployment cache on all nodes where the trained model is assigned. + * Clear trained model deployment cache. + * Cache will be cleared on all nodes where the trained model is assigned. * A trained model deployment may have an inference cache enabled. * As requests are handled by each allocated node, their responses may be cached on that individual node. * Calling this API clears the caches without restarting the deployment. diff --git a/specification/ml/delete_calendar/MlDeleteCalendarRequest.ts b/specification/ml/delete_calendar/MlDeleteCalendarRequest.ts index 6b95084202..a295812a75 100644 --- a/specification/ml/delete_calendar/MlDeleteCalendarRequest.ts +++ b/specification/ml/delete_calendar/MlDeleteCalendarRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** + * Delete a calendar. * Removes all scheduled events from a calendar, then deletes it. * @rest_spec_name ml.delete_calendar * @availability stack since=6.2.0 stability=stable diff --git a/specification/ml/delete_calendar_event/MlDeleteCalendarEventRequest.ts b/specification/ml/delete_calendar_event/MlDeleteCalendarEventRequest.ts index 16c7378fcf..1b8c79bdb3 100644 --- a/specification/ml/delete_calendar_event/MlDeleteCalendarEventRequest.ts +++ b/specification/ml/delete_calendar_event/MlDeleteCalendarEventRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Deletes scheduled events from a calendar. + * Delete events from a calendar. * @rest_spec_name ml.delete_calendar_event * @availability stack since=6.2.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/delete_calendar_job/MlDeleteCalendarJobRequest.ts b/specification/ml/delete_calendar_job/MlDeleteCalendarJobRequest.ts index 7d891a1f40..6562502b8c 100644 --- a/specification/ml/delete_calendar_job/MlDeleteCalendarJobRequest.ts +++ b/specification/ml/delete_calendar_job/MlDeleteCalendarJobRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Id, Ids } from '@_types/common' /** - * Deletes anomaly detection jobs from a calendar. + * Delete anomaly jobs from a calendar. * @rest_spec_name ml.delete_calendar_job * @availability stack since=6.2.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts b/specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts index 24142cde53..b43ed22cc7 100644 --- a/specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts +++ b/specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts @@ -22,7 +22,7 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** - * Deletes a data frame analytics job. + * Delete a data frame analytics job. * @rest_spec_name ml.delete_data_frame_analytics * @availability stack since=7.3.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/delete_datafeed/MlDeleteDatafeedRequest.ts b/specification/ml/delete_datafeed/MlDeleteDatafeedRequest.ts index 1477308226..9f84f4280b 100644 --- a/specification/ml/delete_datafeed/MlDeleteDatafeedRequest.ts +++ b/specification/ml/delete_datafeed/MlDeleteDatafeedRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Deletes an existing datafeed. + * Delete a datafeed. * @rest_spec_name ml.delete_datafeed * @availability stack since=5.4.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/delete_expired_data/MlDeleteExpiredDataRequest.ts b/specification/ml/delete_expired_data/MlDeleteExpiredDataRequest.ts index a2edeedcf2..912b25ed8c 100644 --- a/specification/ml/delete_expired_data/MlDeleteExpiredDataRequest.ts +++ b/specification/ml/delete_expired_data/MlDeleteExpiredDataRequest.ts @@ -23,7 +23,7 @@ import { float } from '@_types/Numeric' import { Duration } from '@_types/Time' /** - * Deletes expired and unused machine learning data. + * Delete expired ML data. * Deletes all job results, model snapshots and forecast data that have exceeded * their retention days period. Machine learning state documents that are not * associated with any job are also deleted. diff --git a/specification/ml/delete_filter/MlDeleteFilterRequest.ts b/specification/ml/delete_filter/MlDeleteFilterRequest.ts index bb02374679..8edc3f08b5 100644 --- a/specification/ml/delete_filter/MlDeleteFilterRequest.ts +++ b/specification/ml/delete_filter/MlDeleteFilterRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Deletes a filter. + * Delete a filter. * If an anomaly detection job references the filter, you cannot delete the * filter. You must update or delete the job before you can delete the filter. * @rest_spec_name ml.delete_filter diff --git a/specification/ml/delete_forecast/MlDeleteForecastRequest.ts b/specification/ml/delete_forecast/MlDeleteForecastRequest.ts index 4b934406af..724142789d 100644 --- a/specification/ml/delete_forecast/MlDeleteForecastRequest.ts +++ b/specification/ml/delete_forecast/MlDeleteForecastRequest.ts @@ -22,7 +22,7 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** - * Deletes forecasts from a machine learning job. + * Delete forecasts from a job. * By default, forecasts are retained for 14 days. You can specify a * different retention period with the `expires_in` parameter in the forecast * jobs API. The delete forecast API enables you to delete one or more diff --git a/specification/ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts b/specification/ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts index 02ddf7d558..0a26eaae1f 100644 --- a/specification/ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts +++ b/specification/ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Deletes an existing model snapshot. + * Delete a model snapshot. * You cannot delete the active model snapshot. To delete that snapshot, first * revert to a different one. To identify the active model snapshot, refer to * the `model_snapshot_id` in the results from the get jobs API. diff --git a/specification/ml/delete_trained_model/MlDeleteTrainedModelRequest.ts b/specification/ml/delete_trained_model/MlDeleteTrainedModelRequest.ts index c89527ccce..36d2112542 100644 --- a/specification/ml/delete_trained_model/MlDeleteTrainedModelRequest.ts +++ b/specification/ml/delete_trained_model/MlDeleteTrainedModelRequest.ts @@ -21,8 +21,8 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Deletes an existing trained inference model that is currently not referenced - * by an ingest pipeline. + * Delete an unreferenced trained model. + * The request deletes a trained inference model that is not referenced by an ingest pipeline. * @rest_spec_name ml.delete_trained_model * @availability stack since=7.10.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts b/specification/ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts index 42c3ff0ba7..767f6b9b03 100644 --- a/specification/ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts +++ b/specification/ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Id, Name } from '@_types/common' /** - * Deletes a trained model alias. + * Delete a trained model alias. * This API deletes an existing model alias that refers to a trained model. If * the model alias is missing or refers to a model other than the one identified * by the `model_id`, this API returns an error. diff --git a/specification/ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts b/specification/ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts index a9f407560d..b661a76b13 100644 --- a/specification/ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts +++ b/specification/ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts @@ -24,6 +24,7 @@ import { Field } from '@_types/common' import { long } from '@_types/Numeric' /** + * Estimate job model memory usage. * Makes an estimation of the memory usage for an anomaly detection job model. * It is based on analysis configuration details for the job and cardinality * estimates for the fields it references. diff --git a/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts b/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts index 229a80ac0a..70e81b3393 100644 --- a/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts +++ b/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts @@ -28,7 +28,7 @@ import { ByteSize, Id } from '@_types/common' import { integer } from '@_types/Numeric' /** - * Explains a data frame analytics config. + * Explain data frame analytics config. * This API provides explanations for a data frame analytics config that either * exists already or one that has not been created yet. The following * explanations are provided: From 8240ad87fa5ca2dbfc6af35b5eef4af4a6adcabb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Tue, 30 Jul 2024 12:32:38 +0200 Subject: [PATCH 2/2] Review evaluate DFA API. --- output/openapi/elasticsearch-openapi.json | 2 +- output/openapi/elasticsearch-serverless-openapi.json | 2 +- output/schema/schema.json | 4 ++-- .../ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index e7bed32cf4..600fb6c5f1 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -19152,7 +19152,7 @@ "tags": [ "ml.evaluate_data_frame" ], - "summary": "Evaluates the data frame analytics for an annotated index", + "summary": "Evaluate data frame analytics", "description": "The API packages together commonly used evaluation metrics for various types\nof machine learning features. This has been designed for use on indexes\ncreated by data frame analytics. Evaluation requires both a ground truth\nfield and an analytics result field to be present.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html" diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 7df6e103b0..91b4e4c11b 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -11954,7 +11954,7 @@ "tags": [ "ml.evaluate_data_frame" ], - "summary": "Evaluates the data frame analytics for an annotated index", + "summary": "Evaluate data frame analytics", "description": "The API packages together commonly used evaluation metrics for various types\nof machine learning features. This has been designed for use on indexes\ncreated by data frame analytics. Evaluation requires both a ground truth\nfield and an analytics result field to be present.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html" diff --git a/output/schema/schema.json b/output/schema/schema.json index ec8cc22268..a137714af3 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -9961,7 +9961,7 @@ "stability": "stable" } }, - "description": "Evaluates the data frame analytics for an annotated index.\nThe API packages together commonly used evaluation metrics for various types\nof machine learning features. This has been designed for use on indexes\ncreated by data frame analytics. Evaluation requires both a ground truth\nfield and an analytics result field to be present.", + "description": "Evaluate data frame analytics.\nThe API packages together commonly used evaluation metrics for various types\nof machine learning features. This has been designed for use on indexes\ncreated by data frame analytics. Evaluation requires both a ground truth\nfield and an analytics result field to be present.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html", "name": "ml.evaluate_data_frame", "privileges": { @@ -155487,7 +155487,7 @@ } ] }, - "description": "Evaluates the data frame analytics for an annotated index.\nThe API packages together commonly used evaluation metrics for various types\nof machine learning features. This has been designed for use on indexes\ncreated by data frame analytics. Evaluation requires both a ground truth\nfield and an analytics result field to be present.", + "description": "Evaluate data frame analytics.\nThe API packages together commonly used evaluation metrics for various types\nof machine learning features. This has been designed for use on indexes\ncreated by data frame analytics. Evaluation requires both a ground truth\nfield and an analytics result field to be present.", "inherits": { "type": { "name": "RequestBase", diff --git a/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts b/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts index 864bbe0114..fdf966da16 100644 --- a/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts +++ b/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts @@ -23,7 +23,7 @@ import { IndexName } from '@_types/common' import { QueryContainer } from '@_types/query_dsl/abstractions' /** - * Evaluates the data frame analytics for an annotated index. + * Evaluate data frame analytics. * The API packages together commonly used evaluation metrics for various types * of machine learning features. This has been designed for use on indexes * created by data frame analytics. Evaluation requires both a ground truth