diff --git a/output/schema/schema.json b/output/schema/schema.json index ea08f8ed0f..5eec022677 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -5960,6 +5960,11 @@ "description": "Deletes an existing data frame analytics job.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html", "name": "ml.delete_data_frame_analytics", + "privileges": { + "cluster": [ + "manage_ml" + ] + }, "request": { "name": "Request", "namespace": "ml.delete_data_frame_analytics" @@ -122592,6 +122597,11 @@ "name": "PredictedValue", "namespace": "ml._types" }, + "specLocation": { + "endLine": 251, + "path": "ml/_types/TrainedModel.ts", + "startLine": 251 + }, "type": { "items": [ { @@ -122796,7 +122806,12 @@ } } } - ] + ], + "specLocation": { + "endLine": 249, + "path": "ml/_types/TrainedModel.ts", + "startLine": 245 + } }, { "kind": "interface", @@ -123472,7 +123487,12 @@ } } } - ] + ], + "specLocation": { + "endLine": 244, + "path": "ml/_types/TrainedModel.ts", + "startLine": 238 + } }, { "kind": "interface", @@ -124083,7 +124103,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes an existing data frame analytics job.", + "description": "Deletes a data frame analytics job.", "inherits": { "type": { "name": "RequestBase", @@ -124138,7 +124158,7 @@ } ], "specLocation": { - "endLine": 48, + "endLine": 50, "path": "ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts", "startLine": 24 } @@ -124531,7 +124551,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes an existing anomaly detection job.\nAll job configuration, model state and results are deleted.\nIt is not currently possible to delete multiple jobs using wildcards or a\ncomma separated list. If you delete a job that has a datafeed, the request\nfirst tries to delete the datafeed. This behavior is equivalent to calling\nthe delete datafeed API with the same timeout and force parameters as the\ndelete job request.", + "description": "Deletes an anomaly detection job.\n\nAll job configuration, model state and results are deleted.\nIt is not currently possible to delete multiple jobs using wildcards or a\ncomma separated list. If you delete a job that has a datafeed, the request\nfirst tries to delete the datafeed. This behavior is equivalent to calling\nthe delete datafeed API with the same timeout and force parameters as the\ndelete job request.", "inherits": { "type": { "name": "RequestBase", @@ -124585,7 +124605,7 @@ } ], "specLocation": { - "endLine": 56, + "endLine": 57, "path": "ml/delete_job/MlDeleteJobRequest.ts", "startLine": 23 } @@ -126981,33 +127001,33 @@ } }, { - "description": "Specifies the maximum number of categories to obtain.", - "name": "size", + "description": "Only return categories for the specified partition.", + "name": "partition_field_value", "required": false, - "serverDefault": 100, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "internal" } } }, { - "description": "Only return categories for the specified partition.", - "name": "partition_field_value", + "description": "Specifies the maximum number of categories to obtain.", + "name": "size", "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "internal" + "name": "integer", + "namespace": "_types" } } } ], "specLocation": { - "endLine": 65, + "endLine": 66, "path": "ml/get_categories/MlGetCategoriesRequest.ts", "startLine": 25 } @@ -129209,7 +129229,12 @@ } } } - ] + ], + "specLocation": { + "endLine": 52, + "path": "ml/infer_trained_model_deployment/MlInferTrainedModelDeploymentRequest.ts", + "startLine": 25 + } }, { "body": { @@ -129314,6 +129339,11 @@ "name": { "name": "Response", "namespace": "ml.infer_trained_model_deployment" + }, + "specLocation": { + "endLine": 65, + "path": "ml/infer_trained_model_deployment/MlInferTrainedModelDeploymentResponse.ts", + "startLine": 27 } }, { @@ -132381,7 +132411,7 @@ } ] }, - "description": "The create trained model API enables you to supply a trained model that is\nnot created by data frame analytics.", + "description": "Enables you to supply a trained model that is not created by data frame analytics.", "inherits": { "type": { "name": "RequestBase", @@ -132409,7 +132439,7 @@ ], "query": [], "specLocation": { - "endLine": 82, + "endLine": 81, "path": "ml/put_trained_model/MlPutTrainedModelRequest.ts", "startLine": 27 } @@ -133046,7 +133076,7 @@ "body": { "kind": "no_body" }, - "description": "Resets an existing 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": "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.", "inherits": { "type": { "name": "RequestBase", @@ -134000,9 +134030,9 @@ } ], "specLocation": { - "endLine": 58, + "endLine": 53, "path": "ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts", - "startLine": 28 + "startLine": 23 } }, { diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 5c4b04cde0..7518e735ab 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -12087,8 +12087,8 @@ export interface MlGetCategoriesRequest extends RequestBase { job_id: Id category_id?: CategoryId from?: integer - size?: integer partition_field_value?: string + size?: integer body?: { page?: MlPage } diff --git a/specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts b/specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts index 6cdc3c4f52..dd0a077d22 100644 --- a/specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts +++ b/specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts @@ -22,9 +22,11 @@ import { Id } from '@_types/common' import { Time } from '@_types/Time' /** + * Deletes a data frame analytics job. * @rest_spec_name ml.delete_data_frame_analytics * @since 7.3.0 * @stability stable + * @cluster_privileges manage_ml */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/ml/delete_job/MlDeleteJobRequest.ts b/specification/ml/delete_job/MlDeleteJobRequest.ts index e8eb288da9..ad305dfc37 100644 --- a/specification/ml/delete_job/MlDeleteJobRequest.ts +++ b/specification/ml/delete_job/MlDeleteJobRequest.ts @@ -21,7 +21,8 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Deletes an existing anomaly detection job. + * Deletes an anomaly detection job. + * * All job configuration, model state and results are deleted. * It is not currently possible to delete multiple jobs using wildcards or a * comma separated list. If you delete a job that has a datafeed, the request diff --git a/specification/ml/get_categories/MlGetCategoriesRequest.ts b/specification/ml/get_categories/MlGetCategoriesRequest.ts index f4cf324a5d..055e56695d 100644 --- a/specification/ml/get_categories/MlGetCategoriesRequest.ts +++ b/specification/ml/get_categories/MlGetCategoriesRequest.ts @@ -23,6 +23,7 @@ import { CategoryId, Id } from '@_types/common' import { integer } from '@_types/Numeric' /** + * Retrieves anomaly detection job results for one or more categories. * @rest_spec_name ml.get_categories * @since 5.4.0 * @stability stable @@ -49,15 +50,15 @@ export interface Request extends RequestBase { * @server_default 0 */ from?: integer + /** + * Only return categories for the specified partition. + */ + partition_field_value?: string /** * Specifies the maximum number of categories to obtain. * @server_default 100 */ size?: integer - /** - * Only return categories for the specified partition. - */ - partition_field_value?: string } body: { page?: Page diff --git a/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts b/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts index 6c32d17d7f..e4e647f19d 100644 --- a/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts +++ b/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts @@ -25,8 +25,7 @@ import { Definition, Input } from './types' import { TrainedModelType } from '../_types/TrainedModel' /** - * The create trained model API enables you to supply a trained model that is - * not created by data frame analytics. + * Enables you to supply a trained model that is not created by data frame analytics. * @rest_spec_name ml.put_trained_model * @since 7.10.0 * @stability stable diff --git a/specification/ml/reset_job/MlResetJobRequest.ts b/specification/ml/reset_job/MlResetJobRequest.ts index 31cdc4cc4b..59aabf8c0b 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 existing anomaly detection job. + * Resets 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/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts b/specification/ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts index 38c03c9c4d..f81d7fc192 100644 --- a/specification/ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts +++ b/specification/ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts @@ -19,12 +19,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' -/* -import { UserDefinedValue } from '@spec_utils/UserDefinedValue' -import { InferenceConfigContainer } from '@_types/aggregations/pipeline' -import { Definition, Input } from './types' -import { TrainedModelType } from '../_types/TrainedModel' -*/ + /** * Stops a trained model deployment. * @rest_spec_name ml.stop_trained_model_deployment