diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index 0aeab2a5ed..85c069f678 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -2137,7 +2137,8 @@ } }, "description": "Delete an enrich policy.\nDeletes an existing enrich policy and its enrich index.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html", + "docId": "delete-enrich-policy-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-enrich-policy-api.html", "name": "enrich.delete_policy", "request": { "name": "Request", @@ -2208,7 +2209,8 @@ } }, "description": "Get an enrich policy.\nReturns information about an enrich policy.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html", + "docId": "get-enrich-policy-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-enrich-policy-api.html", "name": "enrich.get_policy", "request": { "name": "Request", @@ -2288,7 +2290,8 @@ } }, "description": "Delete an async EQL search.\nDelete an async EQL search or a stored synchronous EQL search.\nThe API also deletes results for the search.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", + "docId": "eql-async-search-delete", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-delete", "name": "eql.delete", "request": { "name": "Request", @@ -2395,7 +2398,8 @@ } }, "description": "Get EQL search results.\nReturns search results for an Event Query Language (EQL) query.\nEQL assumes each document in a data stream or index corresponds to an event.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", + "docId": "eql-search-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-search-api.html", "extDocId": "eql", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql.html", "name": "eql.search", @@ -2692,8 +2696,9 @@ } }, "description": "Get a script or search template.\nRetrieves a stored script or search template.", + "docId": "script-get", "docTag": "script", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-stored-script-api.html", "name": "get_script", "privileges": { "cluster": [ @@ -2869,8 +2874,9 @@ "stability": "stable" } }, - "description": "Add an index block.\nLimits the operations allowed on an index by blocking specific operation types.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html", + "description": "Add an index block.\n\nAdd an index block to an index.\nIndex blocks limit the operations allowed on an index by blocking specific operation types.", + "docId": "index-block-add", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules-blocks.html#add-index-block", "name": "indices.add_block", "request": { "name": "Request", @@ -3001,9 +3007,10 @@ "stability": "stable" } }, - "description": "Create a data stream.\nCreates a data stream.\nYou must have a matching index template with data stream enabled.", + "description": "Create a data stream.\n\nYou must have a matching index template with data stream enabled.", + "docId": "indices-create-data-stream", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-create-data-stream.html", "name": "indices.create_data_stream", "privileges": { "index": [ @@ -3129,8 +3136,9 @@ } }, "description": "Delete data streams.\nDeletes one or more data streams and their backing indices.", + "docId": "data-stream-delete", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-delete-data-stream.html", "name": "indices.delete_data_stream", "privileges": { "index": [ @@ -3244,8 +3252,9 @@ "stability": "stable" } }, - "description": "Check aliases.\nChecks if one or more data stream or index aliases exist.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", + "description": "Check aliases.\n\nCheck if one or more data stream or index aliases exist.", + "docId": "indices-aliases-exist", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-alias", "name": "indices.exists_alias", "request": { "name": "Request", @@ -3284,8 +3293,9 @@ "stability": "stable" } }, - "description": "Check index templates.\nCheck whether index templates exist.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-templates.html", + "description": "Check index templates.\n\nCheck whether index templates exist.", + "docId": "index-templates-exist", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-index-template", "name": "indices.exists_index_template", "request": { "name": "Request", @@ -3320,8 +3330,9 @@ } }, "description": "Get the status for a data stream lifecycle.\nGet information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.", + "docId": "data-stream-explain-lifecycle", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-explain-lifecycle.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams-explain-lifecycle.html", "name": "indices.explain_data_lifecycle", "request": { "name": "Request", @@ -3454,9 +3465,10 @@ "stability": "stable" } }, - "description": "Get data stream lifecycles.\nRetrieves the data stream lifecycle configuration of one or more data streams.", + "description": "Get data stream lifecycles.\n\nGet the data stream lifecycle configuration of one or more data streams.", + "docId": "data-stream-get-lifecycle", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams-get-lifecycle.html", "name": "indices.get_data_lifecycle", "request": { "name": "Request", @@ -3490,9 +3502,10 @@ "stability": "stable" } }, - "description": "Get data streams.\nRetrieves information about one or more data streams.", + "description": "Get data streams.\n\nGet information about one or more data streams.", + "docId": "data-stream-get", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-get-data-stream.html", "name": "indices.get_data_stream", "privileges": { "index": [ @@ -4311,7 +4324,8 @@ } }, "description": "Delete an inference endpoint", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-inference-api.html", + "docId": "inference-api-delete", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-inference-api.html", "name": "inference.delete", "request": { "name": "Request", @@ -4353,7 +4367,8 @@ } }, "description": "Get an inference endpoint", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html", + "docId": "inference-api-get", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-inference-api.html", "name": "inference.get", "request": { "name": "Request", @@ -4400,9 +4415,15 @@ "visibility": "public" } }, - "description": "Perform inference on the service", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html", + "description": "Perform inference on the service.\n\nThis API enables you to use machine learning models to perform specific tasks on data that you provide as an input.\nIt returns a response with the results of the tasks.\nThe inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API.\n\n> info\n> The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", + "docId": "inference-api-post", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/post-inference-api.html", "name": "inference.inference", + "privileges": { + "cluster": [ + "monitor_inference" + ] + }, "request": { "name": "Request", "namespace": "inference.inference" @@ -4446,7 +4467,8 @@ } }, "description": "Create an inference endpoint.\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html", + "docId": "inference-api-put", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-inference-api.html", "name": "inference.put", "privileges": { "cluster": [ @@ -4580,7 +4602,8 @@ } }, "description": "Delete pipelines.\nDelete one or more ingest pipelines.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html", + "docId": "delete-pipeline-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-pipeline-api.html", "extDocId": "ingest", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", "name": "ingest.delete_pipeline", @@ -4616,8 +4639,9 @@ "stability": "stable" } }, - "description": "Get pipelines.\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html", + "description": "Get pipelines.\n\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", + "docId": "get-pipeline-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-pipeline-api.html", "extDocId": "ingest", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", "name": "ingest.get_pipeline", @@ -4738,9 +4762,15 @@ "stability": "stable" } }, - "description": "Simulate a pipeline.\nRun an ingest pipeline against a set of provided documents.\nYou can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html", + "description": "Simulate a pipeline.\n\nRun an ingest pipeline against a set of provided documents.\nYou can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.", + "docId": "simulate-pipeline-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/simulate-pipeline-api.html", "name": "ingest.simulate", + "privileges": { + "cluster": [ + "read_pipeline" + ] + }, "request": { "name": "Request", "namespace": "ingest.simulate" @@ -4783,8 +4813,9 @@ "stability": "stable" } }, - "description": "Get license information.\nGet information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\nNOTE: If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\nIf you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html", + "description": "Get license information.\n\nGet information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\n>info\n> If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\n> If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", + "docId": "get-license", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-license.html", "name": "license.get", "request": { "name": "Request", @@ -5260,8 +5291,9 @@ } }, "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.", + "docId": "ml-delete-filter", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-filter.html", "name": "ml.delete_filter", "privileges": { "cluster": [ @@ -5301,8 +5333,9 @@ } }, "description": "Delete an 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.", + "docId": "ml-delete-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-job.html", "name": "ml.delete_job", "privileges": { "cluster": [ @@ -5342,8 +5375,9 @@ } }, "description": "Delete an unreferenced trained model.\nThe request deletes a trained inference model that is not referenced by an ingest pipeline.", + "docId": "delete-trained-models", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-trained-models.html", "name": "ml.delete_trained_model", "privileges": { "cluster": [ @@ -5383,8 +5417,9 @@ } }, "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.", + "docId": "delete-trained-models-aliases", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-trained-models-aliases.html", "name": "ml.delete_trained_model_alias", "privileges": { "cluster": [ @@ -5427,8 +5462,9 @@ } }, "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.", + "docId": "ml-estimate-memory", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-estimate-model-memory.html", "name": "ml.estimate_model_memory", "privileges": { "cluster": [ @@ -5471,8 +5507,9 @@ } }, "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.", + "docId": "evaluate-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/evaluate-dfanalytics.html", "name": "ml.evaluate_data_frame", "privileges": { "cluster": [ @@ -5515,8 +5552,9 @@ } }, "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.", + "docId": "ml-flush-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-flush-job.html", "name": "ml.flush_job", "privileges": { "cluster": [ @@ -5559,8 +5597,9 @@ } }, "description": "Get info about events in calendars.", + "docId": "ml-get-calendar-event", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-calendar-event.html", "name": "ml.get_calendar_events", "privileges": { "cluster": [ @@ -5600,8 +5639,9 @@ } }, "description": "Get calendar configuration info.", + "docId": "ml-get-calendar", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-calendar.html", "name": "ml.get_calendars", "privileges": { "cluster": [ @@ -5652,8 +5692,9 @@ } }, "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.", + "docId": "get-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-dfanalytics.html", "name": "ml.get_data_frame_analytics", "privileges": { "cluster": [ @@ -5699,8 +5740,9 @@ } }, "description": "Get data frame analytics jobs usage info.", + "docId": "get-dfanalytics-stats", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-dfanalytics-stats.html", "name": "ml.get_data_frame_analytics_stats", "privileges": { "cluster": [ @@ -5746,8 +5788,9 @@ } }, "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.", + "docId": "ml-get-datafeed-stats", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-datafeed-stats.html", "name": "ml.get_datafeed_stats", "privileges": { "cluster": [ @@ -5793,8 +5836,9 @@ } }, "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.", + "docId": "ml-get-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-datafeed.html", "name": "ml.get_datafeeds", "privileges": { "cluster": [ @@ -5840,8 +5884,9 @@ } }, "description": "Get filters.\nYou can get a single filter or all filters.", + "docId": "ml-get-filter", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-filter.html", "name": "ml.get_filters", "privileges": { "cluster": [ @@ -5887,8 +5932,9 @@ } }, "description": "Get anomaly detection jobs usage info.", + "docId": "ml-get-job-stats", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-job-stats.html", "name": "ml.get_job_stats", "privileges": { "cluster": [ @@ -5934,8 +5980,9 @@ } }, "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 ``.", + "docId": "ml-get-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-job.html", "name": "ml.get_jobs", "privileges": { "cluster": [ @@ -5981,8 +6028,9 @@ } }, "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.", + "docId": "ml-get-overall-buckets", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-overall-buckets.html", "name": "ml.get_overall_buckets", "privileges": { "cluster": [ @@ -6026,8 +6074,9 @@ } }, "description": "Get trained model configuration info.", + "docId": "get-trained-models", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-trained-models.html", "name": "ml.get_trained_models", "privileges": { "cluster": [ @@ -6073,8 +6122,9 @@ } }, "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.", + "docId": "get-trained-models-stats", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-trained-models-stats.html", "name": "ml.get_trained_models_stats", "privileges": { "cluster": [ @@ -6120,8 +6170,9 @@ } }, "description": "Evaluate a trained model.", + "docId": "infer-trained-model", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/infer-trained-model.html", "name": "ml.infer_trained_model", "request": { "name": "Request", @@ -6169,8 +6220,9 @@ } }, "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.", + "docId": "ml-open-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-open-job.html", "name": "ml.open_job", "privileges": { "cluster": [ @@ -6213,8 +6265,9 @@ } }, "description": "Add scheduled events to the calendar.", + "docId": "ml-post-calendar-event", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-post-calendar-event.html", "name": "ml.post_calendar_events", "privileges": { "cluster": [ @@ -6256,9 +6309,10 @@ "stability": "stable" } }, - "description": "Preview features used by data frame analytics.\nPreviews the extracted features used by a data frame analytics config.", + "description": "Preview features used by data frame analytics.\nPreview the extracted features used by a data frame analytics config.", + "docId": "preview-dfanalytics", "docTag": "ml data frame", - "docUrl": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/preview-dfanalytics.html", "name": "ml.preview_data_frame_analytics", "privileges": { "cluster": [ @@ -6309,8 +6363,9 @@ } }, "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.", + "docId": "ml-preview-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-preview-datafeed.html", "name": "ml.preview_datafeed", "privileges": { "cluster": [ @@ -6364,8 +6419,9 @@ } }, "description": "Create a calendar.", + "docId": "ml-put-calendar", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-put-calendar.html", "name": "ml.put_calendar", "privileges": { "cluster": [ @@ -6408,8 +6464,9 @@ } }, "description": "Add anomaly detection job to calendar.", + "docId": "ml-put-calendar-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-put-calendar-job.html", "name": "ml.put_calendar_job", "privileges": { "cluster": [ @@ -6501,8 +6558,9 @@ } }, "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.\nBy default, the datafeed uses the following query: `{\"match_all\": {\"boost\": 1}}`.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had\nat the time of creation and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.\nYou must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed\ndirectly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index.", + "docId": "ml-put-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-put-datafeed.html", "name": "ml.put_datafeed", "privileges": { "cluster": [ @@ -6548,8 +6606,9 @@ } }, "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.", + "docId": "ml-put-filter", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-put-filter.html", "name": "ml.put_filter", "privileges": { "cluster": [ @@ -6592,8 +6651,9 @@ } }, "description": "Create an anomaly detection job.\nIf you include a `datafeed_config`, you must have read index privileges on the source index.\nIf you include a `datafeed_config` but do not provide a query, the datafeed uses `{\"match_all\": {\"boost\": 1}}`.", + "docId": "ml-put-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-put-job.html", "name": "ml.put_job", "privileges": { "cluster": [ @@ -6639,8 +6699,9 @@ } }, "description": "Create a trained model.\nEnable you to supply a trained model that is not created by data frame analytics.", + "docId": "put-trained-models", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-trained-models.html", "name": "ml.put_trained_model", "privileges": { "cluster": [ @@ -6683,8 +6744,9 @@ } }, "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.", + "docId": "put-trained-models-aliases", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-trained-models-aliases.html", "name": "ml.put_trained_model_alias", "privileges": { "cluster": [ @@ -6727,8 +6789,9 @@ } }, "description": "Create part of a trained model definition.", + "docId": "put-trained-model-definition-part", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-definition-part.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-trained-model-definition-part.html", "name": "ml.put_trained_model_definition_part", "privileges": { "cluster": [ @@ -6771,8 +6834,9 @@ } }, "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.", + "docId": "put-trained-model-vocabulary", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-vocabulary.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-trained-model-vocabulary.html", "name": "ml.put_trained_model_vocabulary", "privileges": { "cluster": [ @@ -6815,8 +6879,9 @@ } }, "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.", + "docId": "ml-reset-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-reset-job.html", "name": "ml.reset_job", "privileges": { "cluster": [ @@ -6856,8 +6921,9 @@ } }, "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.", + "docId": "start-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/start-dfanalytics.html", "name": "ml.start_data_frame_analytics", "privileges": { "cluster": [ @@ -6907,8 +6973,9 @@ } }, "description": "Start 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.", + "docId": "ml-start-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-start-datafeed.html", "name": "ml.start_datafeed", "privileges": { "cluster": [ @@ -6951,8 +7018,9 @@ } }, "description": "Start a trained model deployment.\nIt allocates the model to every machine learning node.", + "docId": "start-trained-model-deployment", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trained-model-deployment.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/start-trained-model-deployment.html", "name": "ml.start_trained_model_deployment", "privileges": { "cluster": [ @@ -6995,8 +7063,9 @@ } }, "description": "Stop data frame analytics jobs.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.", + "docId": "stop-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/stop-dfanalytics.html", "name": "ml.stop_data_frame_analytics", "privileges": { "cluster": [ @@ -7039,8 +7108,9 @@ } }, "description": "Stop datafeeds.\nA datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.", + "docId": "ml-stop-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-stop-datafeed.html", "name": "ml.stop_datafeed", "privileges": { "cluster": [ @@ -7083,8 +7153,9 @@ } }, "description": "Stop a trained model deployment.", + "docId": "stop-trained-model-deployment", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/stop-trained-model-deployment.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/stop-trained-model-deployment.html", "name": "ml.stop_trained_model_deployment", "privileges": { "cluster": [ @@ -7127,8 +7198,9 @@ } }, "description": "Update a data frame analytics job.", + "docId": "update-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-dfanalytics.html", "name": "ml.update_data_frame_analytics", "privileges": { "cluster": [ @@ -7178,8 +7250,9 @@ } }, "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.", + "docId": "ml-update-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-update-datafeed.html", "name": "ml.update_datafeed", "privileges": { "cluster": [ @@ -7222,8 +7295,9 @@ } }, "description": "Update a filter.\nUpdates the description of a filter, adds items, or removes items from the list.", + "docId": "ml-update-filter", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-update-filter.html", "name": "ml.update_filter", "privileges": { "cluster": [ @@ -7266,8 +7340,9 @@ } }, "description": "Update an anomaly detection job.\nUpdates certain properties of an anomaly detection job.", + "docId": "ml-update-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-update-job.html", "name": "ml.update_job", "privileges": { "cluster": [ @@ -7310,8 +7385,9 @@ } }, "description": "Update a trained model deployment.", + "docId": "update-trained-model-deployment", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-trained-model-deployment.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-trained-model-deployment.html", "name": "ml.update_trained_model_deployment", "privileges": { "cluster": [ @@ -7354,8 +7430,9 @@ } }, "description": "Run multiple searches.\n\nThe format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.\nThe structure is as follows:\n\n```\nheader\\n\nbody\\n\nheader\\n\nbody\\n\n```\n\nThis structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.\n\nIMPORTANT: The final line of data must end with a newline character `\\n`.\nEach newline character may be preceded by a carriage return `\\r`.\nWhen sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.", + "docId": "search-multi-search", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-multi-search.html", "name": "msearch", "privileges": { "index": [ @@ -7557,8 +7634,9 @@ } }, "description": "Ping the cluster.\nGet information about whether the cluster is running.", + "docId": "cluster-ping", "docTag": "cluster", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster.html", "name": "ping", "request": { "name": "Request", @@ -7988,8 +8066,9 @@ } }, "description": "Evaluate ranked search results.\n\nEvaluate the quality of ranked search results over a set of typical search queries.", + "docId": "search-rank-eval", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html", "name": "rank_eval", "privileges": { "index": [ @@ -8289,8 +8368,9 @@ "stability": "beta" } }, - "description": "Delete a search application.\nRemove a search application and its associated alias. Indices attached to the search application are not removed.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-search-application.html", + "description": "Delete a search application.\n\nRemove a search application and its associated alias. Indices attached to the search application are not removed.", + "docId": "search-application-delete", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-search-application.html", "name": "search_application.delete", "privileges": { "cluster": [ @@ -8333,8 +8413,9 @@ } }, "description": "Delete a behavioral analytics collection.\nThe associated data stream is also deleted.", + "docId": "delete-analytics-collection", "docTag": "analytics", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-analytics-collection.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-analytics-collection.html", "name": "search_application.delete_behavioral_analytics", "request": { "name": "Request", @@ -8369,7 +8450,8 @@ } }, "description": "Get search application details.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-search-application.html", + "docId": "search-application-get", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-search-application.html", "name": "search_application.get", "privileges": { "cluster": [ @@ -8409,8 +8491,9 @@ } }, "description": "Get behavioral analytics collections.", + "docId": "list-analytics-collection", "docTag": "analytics", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-analytics-collection.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-analytics-collection.html", "name": "search_application.get_behavioral_analytics", "request": { "name": "Request", @@ -8451,7 +8534,8 @@ } }, "description": "Get search applications.\nGet information about search applications.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-search-applications.html", + "docId": "list-analytics-collection", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-analytics-collection.html", "name": "search_application.list", "privileges": { "cluster": [ @@ -8491,7 +8575,8 @@ } }, "description": "Create or update a search application.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-search-application.html", + "docId": "search-application-put", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-search-application.html", "name": "search_application.put", "privileges": { "cluster": [ @@ -8537,8 +8622,9 @@ } }, "description": "Create a behavioral analytics collection.", + "docId": "put-analytics-collection", "docTag": "analytics", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-analytics-collection.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-analytics-collection.html", "name": "search_application.put_behavioral_analytics", "request": { "name": "Request", @@ -8573,7 +8659,8 @@ } }, "description": "Run a search application search.\nGenerate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.\nUnspecified template parameters are assigned their default values if applicable.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-search.html", + "docId": "search-application-search", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-application-search.html", "name": "search_application.search", "request": { "name": "Request", @@ -9923,8 +10010,9 @@ "stability": "stable" } }, - "description": "Delete a transform.\nDeletes a transform.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html", + "description": "Delete a transform.", + "docId": "delete-transform", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-transform.html", "name": "transform.delete_transform", "privileges": { "cluster": [ @@ -9963,8 +10051,9 @@ "stability": "stable" } }, - "description": "Get transforms.\nRetrieves configuration information for transforms.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html", + "description": "Get transforms.\nGet configuration information for transforms.", + "docId": "get-transform", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-transform.html", "name": "transform.get_transform", "privileges": { "cluster": [ @@ -10009,8 +10098,9 @@ "stability": "stable" } }, - "description": "Get transform stats.\nRetrieves usage information for transforms.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html", + "description": "Get transform stats.\nGet usage information for transforms.", + "docId": "get-transform-stats", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-transform-stats.html", "name": "transform.get_transform_stats", "privileges": { "cluster": [ @@ -10054,7 +10144,8 @@ } }, "description": "Preview a transform.\nGenerates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html", + "docId": "preview-transform", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/preview-transform.html", "name": "transform.preview_transform", "privileges": { "cluster": [ @@ -10109,7 +10200,8 @@ } }, "description": "Create a transform.\nCreates a transform.\n\nA transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as\na data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a\nunique row per entity.\n\nYou must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If\nyou choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in\nthe pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values\nin the latest object.\n\nYou must have `create_index`, `index`, and `read` privileges on the destination index and `read` and\n`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the\ntransform remembers which roles the user that created it had at the time of creation and uses those same roles. If\nthose roles do not have the required privileges on the source and destination indices, the transform fails when it\nattempts unauthorized operations.\n\nNOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any\n`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do\nnot give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not\ngive users any privileges on `.data-frame-internal*` indices.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html", + "docId": "put-transform", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-transform.html", "name": "transform.put_transform", "privileges": { "cluster": [ @@ -10158,7 +10250,8 @@ } }, "description": "Reset a transform.\nResets a transform.\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/reset-transform.html", + "docId": "reset-transform", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/reset-transform.html", "name": "transform.reset_transform", "privileges": { "cluster": [ @@ -10198,7 +10291,8 @@ } }, "description": "Schedule a transform to start now.\nInstantly runs a transform to process data.\n\nIf you _schedule_now a transform, it will process the new data instantly,\nwithout waiting for the configured frequency interval. After _schedule_now API is called,\nthe transform will be processed again at now + frequency unless _schedule_now API\nis called again in the meantime.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/schedule-now-transform.html", + "docId": "schedule-now-transform", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/schedule-now-transform.html", "name": "transform.schedule_now_transform", "privileges": { "cluster": [ @@ -10241,7 +10335,8 @@ } }, "description": "Start a transform.\nStarts a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html", + "docId": "start-transform", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/start-transform.html", "name": "transform.start_transform", "privileges": { "cluster": [ @@ -10285,7 +10380,8 @@ } }, "description": "Stop transforms.\nStops one or more transforms.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html", + "docId": "stop-transform", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/stop-transform.html", "name": "transform.stop_transform", "privileges": { "cluster": [ @@ -10325,7 +10421,8 @@ } }, "description": "Update a transform.\nUpdates certain properties of a transform.\n\nAll updated properties except `description` do not take effect until after the transform starts the next checkpoint,\nthus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`\nprivileges for the source indices. You must also have `index` and `read` privileges for the destination index. When\nElasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the\ntime of update and runs with those privileges.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html", + "docId": "update-transform", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-transform.html", "name": "transform.update_transform", "privileges": { "cluster": [ @@ -17326,7 +17423,7 @@ } } ], - "specLocation": "enrich/delete_policy/DeleteEnrichPolicyRequest.ts#L24-L51" + "specLocation": "enrich/delete_policy/DeleteEnrichPolicyRequest.ts#L24-L52" }, { "body": { @@ -17492,7 +17589,7 @@ } } ], - "specLocation": "enrich/get_policy/GetEnrichPolicyRequest.ts#L24-L56" + "specLocation": "enrich/get_policy/GetEnrichPolicyRequest.ts#L24-L57" }, { "body": { @@ -17661,7 +17758,7 @@ } ], "query": [], - "specLocation": "eql/delete/EqlDeleteRequest.ts#L23-L46" + "specLocation": "eql/delete/EqlDeleteRequest.ts#L23-L47" }, { "body": { @@ -18294,7 +18391,7 @@ } } ], - "specLocation": "eql/search/EqlSearchRequest.ts#L28-L148" + "specLocation": "eql/search/EqlSearchRequest.ts#L28-L149" }, { "body": { @@ -19736,7 +19833,7 @@ } } ], - "specLocation": "_global/get_script/GetScriptRequest.ts#L24-L55" + "specLocation": "_global/get_script/GetScriptRequest.ts#L24-L56" }, { "body": { @@ -20401,7 +20498,7 @@ "body": { "kind": "no_body" }, - "description": "Add an index block.\nLimits the operations allowed on an index by blocking specific operation types.", + "description": "Add an index block.\n\nAdd an index block to an index.\nIndex blocks limit the operations allowed on an index by blocking specific operation types.", "inherits": { "type": { "name": "RequestBase", @@ -20415,7 +20512,7 @@ }, "path": [ { - "description": "A comma separated list of indices to add a block to", + "description": "A comma-separated list or wildcard expression of index names used to limit the request.\nBy default, you must explicitly name the indices you are adding blocks to.\nTo allow the adding of blocks to indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`.\nYou can update this setting in the `elasticsearch.yml` file or by using the cluster update settings API.", "name": "index", "required": true, "type": { @@ -20427,7 +20524,7 @@ } }, { - "description": "The block to add (one of read, write, read_only or metadata)", + "description": "The block type to add to the index.", "name": "block", "required": true, "type": { @@ -20441,9 +20538,10 @@ ], "query": [ { - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.\nFor example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.", "name": "allow_no_indices", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -20453,9 +20551,10 @@ } }, { - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "The type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nIt supports comma-separated values, such as `open,hidden`.", "name": "expand_wildcards", "required": false, + "serverDefault": "open", "type": { "kind": "instance_of", "type": { @@ -20465,9 +20564,10 @@ } }, { - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "description": "If `false`, the request returns an error if it targets a missing or closed index.", "name": "ignore_unavailable", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -20477,9 +20577,10 @@ } }, { - "description": "Specify timeout for connection to master", + "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "name": "master_timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -20489,9 +20590,10 @@ } }, { - "description": "Explicit operation timeout", + "description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.\nIt can also be set to `-1` to indicate that the request should never timeout.", "name": "timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -20501,7 +20603,7 @@ } } ], - "specLocation": "indices/add_block/IndicesAddBlockRequest.ts#L24-L49" + "specLocation": "indices/add_block/IndicesAddBlockRequest.ts#L24-L89" }, { "body": { @@ -20938,7 +21040,7 @@ "body": { "kind": "no_body" }, - "description": "Create a data stream.\nCreates a data stream.\nYou must have a matching index template with data stream enabled.", + "description": "Create a data stream.\n\nYou must have a matching index template with data stream enabled.", "inherits": { "type": { "name": "RequestBase", @@ -20992,7 +21094,7 @@ } } ], - "specLocation": "indices/create_data_stream/IndicesCreateDataStreamRequest.ts#L24-L64" + "specLocation": "indices/create_data_stream/IndicesCreateDataStreamRequest.ts#L24-L65" }, { "body": { @@ -21286,7 +21388,7 @@ } } ], - "specLocation": "indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts#L24-L58" + "specLocation": "indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts#L24-L59" }, { "body": { @@ -21520,7 +21622,7 @@ "body": { "kind": "no_body" }, - "description": "Check aliases.\nChecks if one or more data stream or index aliases exist.", + "description": "Check aliases.\n\nCheck if one or more data stream or index aliases exist.", "inherits": { "type": { "name": "RequestBase", @@ -21612,7 +21714,7 @@ } } ], - "specLocation": "indices/exists_alias/IndicesExistsAliasRequest.ts#L24-L80" + "specLocation": "indices/exists_alias/IndicesExistsAliasRequest.ts#L24-L82" }, { "body": { @@ -21632,7 +21734,7 @@ "body": { "kind": "no_body" }, - "description": "Check index templates.\nCheck whether index templates exist.", + "description": "Check index templates.\n\nCheck whether index templates exist.", "inherits": { "type": { "name": "RequestBase", @@ -21673,7 +21775,7 @@ } } ], - "specLocation": "indices/exists_index_template/IndicesExistsIndexTemplateRequest.ts#L24-L49" + "specLocation": "indices/exists_index_template/IndicesExistsIndexTemplateRequest.ts#L24-L51" }, { "body": { @@ -21745,7 +21847,7 @@ } } ], - "specLocation": "indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts#L24-L46" + "specLocation": "indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts#L24-L47" }, { "body": { @@ -22124,7 +22226,7 @@ "body": { "kind": "no_body" }, - "description": "Get data stream lifecycles.\nRetrieves the data stream lifecycle configuration of one or more data streams.", + "description": "Get data stream lifecycles.\n\nGet the data stream lifecycle configuration of one or more data streams.", "inherits": { "type": { "name": "RequestBase", @@ -22191,7 +22293,7 @@ } } ], - "specLocation": "indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts#L24-L66" + "specLocation": "indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts#L24-L68" }, { "body": { @@ -22227,7 +22329,7 @@ "body": { "kind": "no_body" }, - "description": "Get data streams.\nRetrieves information about one or more data streams.", + "description": "Get data streams.\n\nGet information about one or more data streams.", "inherits": { "type": { "name": "RequestBase", @@ -22316,7 +22418,7 @@ } } ], - "specLocation": "indices/get_data_stream/IndicesGetDataStreamRequest.ts#L24-L76" + "specLocation": "indices/get_data_stream/IndicesGetDataStreamRequest.ts#L24-L78" }, { "body": { @@ -25106,7 +25208,7 @@ } }, { - "description": "The inference Id", + "description": "The inference identifier.", "name": "inference_id", "required": true, "type": { @@ -25120,7 +25222,7 @@ ], "query": [ { - "description": "When true, the endpoint is not deleted, and a list of ingest processors which reference this endpoint is returned", + "description": "When true, the endpoint is not deleted and a list of ingest processors which reference this endpoint is returned.", "name": "dry_run", "required": false, "serverDefault": false, @@ -25133,7 +25235,7 @@ } }, { - "description": "When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields", + "description": "When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields.", "name": "force", "required": false, "serverDefault": false, @@ -25146,7 +25248,7 @@ } } ], - "specLocation": "inference/delete/DeleteRequest.ts#L24-L65" + "specLocation": "inference/delete/DeleteRequest.ts#L24-L66" }, { "body": { @@ -25212,7 +25314,7 @@ } ], "query": [], - "specLocation": "inference/get/GetRequest.ts#L24-L55" + "specLocation": "inference/get/GetRequest.ts#L24-L56" }, { "body": { @@ -25249,7 +25351,7 @@ "kind": "properties", "properties": [ { - "description": "Query input, required for rerank task.\nNot required for other tasks.", + "description": "The query input, which is required only for the `rerank` task.\nIt is not required for other tasks.", "name": "query", "required": false, "type": { @@ -25261,7 +25363,7 @@ } }, { - "description": "Inference input.\nEither a string or an array of strings.", + "description": "The text on which you want to perform the inference task.\nIt can be a single string or an array.\n\n> info\n> Inference endpoints for the `completion` task type currently only support a single string as input.", "name": "input", "required": true, "type": { @@ -25288,7 +25390,7 @@ } }, { - "description": "Optional task settings", + "description": "Task settings for the individual inference request.\nThese settings are specific to the task type you specified and override the task settings specified when initializing the service.", "name": "task_settings", "required": false, "type": { @@ -25301,7 +25403,7 @@ } ] }, - "description": "Perform inference on the service", + "description": "Perform inference on the service.\n\nThis API enables you to use machine learning models to perform specific tasks on data that you provide as an input.\nIt returns a response with the results of the tasks.\nThe inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API.\n\n> info\n> The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", "inherits": { "type": { "name": "RequestBase", @@ -25315,7 +25417,7 @@ }, "path": [ { - "description": "The task type", + "description": "The type of inference task that the model performs.", "name": "task_type", "required": false, "type": { @@ -25327,7 +25429,7 @@ } }, { - "description": "The inference Id", + "description": "The unique identifier for the inference endpoint.", "name": "inference_id", "required": true, "type": { @@ -25341,7 +25443,7 @@ ], "query": [ { - "description": "Specifies the amount of time to wait for the inference request to complete.", + "description": "The amount of time to wait for the inference request to complete.", "name": "timeout", "required": false, "serverDefault": "30s", @@ -25354,7 +25456,7 @@ } } ], - "specLocation": "inference/inference/InferenceRequest.ts#L26-L76" + "specLocation": "inference/inference/InferenceRequest.ts#L26-L89" }, { "body": { @@ -25428,7 +25530,7 @@ } ], "query": [], - "specLocation": "inference/put/PutRequest.ts#L25-L64" + "specLocation": "inference/put/PutRequest.ts#L25-L65" }, { "body": { @@ -25790,7 +25892,7 @@ } } ], - "specLocation": "ingest/delete_pipeline/DeletePipelineRequest.ts#L24-L60" + "specLocation": "ingest/delete_pipeline/DeletePipelineRequest.ts#L24-L61" }, { "body": { @@ -25817,7 +25919,7 @@ "body": { "kind": "no_body" }, - "description": "Get pipelines.\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", + "description": "Get pipelines.\n\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", "inherits": { "type": { "name": "RequestBase", @@ -25871,7 +25973,7 @@ } } ], - "specLocation": "ingest/get_pipeline/GetPipelineRequest.ts#L24-L62" + "specLocation": "ingest/get_pipeline/GetPipelineRequest.ts#L24-L64" }, { "body": { @@ -26157,7 +26259,7 @@ } }, { - "description": "Pipeline to test.\nIf you don’t specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.", + "description": "The pipeline to test.\nIf you don't specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.", "name": "pipeline", "required": false, "type": { @@ -26170,7 +26272,7 @@ } ] }, - "description": "Simulate a pipeline.\nRun an ingest pipeline against a set of provided documents.\nYou can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.", + "description": "Simulate a pipeline.\n\nRun an ingest pipeline against a set of provided documents.\nYou can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.", "inherits": { "type": { "name": "RequestBase", @@ -26184,7 +26286,7 @@ }, "path": [ { - "description": "Pipeline to test.\nIf you don’t specify a `pipeline` in the request body, this parameter is required.", + "description": "The pipeline to test.\nIf you don't specify a `pipeline` in the request body, this parameter is required.", "name": "id", "required": false, "type": { @@ -26210,7 +26312,7 @@ } } ], - "specLocation": "ingest/simulate/SimulatePipelineRequest.ts#L25-L69" + "specLocation": "ingest/simulate/SimulatePipelineRequest.ts#L25-L72" }, { "body": { @@ -26246,7 +26348,7 @@ "body": { "kind": "no_body" }, - "description": "Get license information.\nGet information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\nNOTE: If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\nIf you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", + "description": "Get license information.\n\nGet information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\n>info\n> If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\n> If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", "inherits": { "type": { "name": "RequestBase", @@ -26291,7 +26393,7 @@ } } ], - "specLocation": "license/get/GetLicenseRequest.ts#L22-L53" + "specLocation": "license/get/GetLicenseRequest.ts#L22-L56" }, { "body": { @@ -27238,7 +27340,7 @@ } ], "query": [], - "specLocation": "ml/delete_filter/MlDeleteFilterRequest.ts#L23-L46" + "specLocation": "ml/delete_filter/MlDeleteFilterRequest.ts#L23-L47" }, { "body": { @@ -27331,7 +27433,7 @@ } } ], - "specLocation": "ml/delete_job/MlDeleteJobRequest.ts#L23-L70" + "specLocation": "ml/delete_job/MlDeleteJobRequest.ts#L23-L71" }, { "body": { @@ -27411,7 +27513,7 @@ } } ], - "specLocation": "ml/delete_trained_model/MlDeleteTrainedModelRequest.ts#L24-L55" + "specLocation": "ml/delete_trained_model/MlDeleteTrainedModelRequest.ts#L24-L56" }, { "body": { @@ -27477,7 +27579,7 @@ } ], "query": [], - "specLocation": "ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts#L23-L51" + "specLocation": "ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts#L23-L52" }, { "body": { @@ -27578,7 +27680,7 @@ }, "path": [], "query": [], - "specLocation": "ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts#L26-L69" + "specLocation": "ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts#L26-L70" }, { "body": { @@ -27665,7 +27767,7 @@ }, "path": [], "query": [], - "specLocation": "ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts#L25-L59" + "specLocation": "ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts#L25-L60" }, { "body": { @@ -27873,7 +27975,7 @@ } } ], - "specLocation": "ml/flush_job/MlFlushJobRequest.ts#L24-L106" + "specLocation": "ml/flush_job/MlFlushJobRequest.ts#L24-L107" }, { "body": { @@ -28008,7 +28110,7 @@ } } ], - "specLocation": "ml/get_calendar_events/MlGetCalendarEventsRequest.ts#L25-L60" + "specLocation": "ml/get_calendar_events/MlGetCalendarEventsRequest.ts#L25-L61" }, { "body": { @@ -28123,7 +28225,7 @@ } } ], - "specLocation": "ml/get_calendars/MlGetCalendarsRequest.ts#L25-L62" + "specLocation": "ml/get_calendars/MlGetCalendarsRequest.ts#L25-L63" }, { "body": { @@ -28250,7 +28352,7 @@ } } ], - "specLocation": "ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts#L24-L88" + "specLocation": "ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts#L24-L89" }, { "body": { @@ -28378,7 +28480,7 @@ } } ], - "specLocation": "ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts#L24-L83" + "specLocation": "ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts#L24-L84" }, { "body": { @@ -28466,7 +28568,7 @@ } } ], - "specLocation": "ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts#L23-L71" + "specLocation": "ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts#L23-L72" }, { "body": { @@ -28566,7 +28668,7 @@ } } ], - "specLocation": "ml/get_datafeeds/MlGetDatafeedsRequest.ts#L23-L77" + "specLocation": "ml/get_datafeeds/MlGetDatafeedsRequest.ts#L23-L78" }, { "body": { @@ -28667,7 +28769,7 @@ } } ], - "specLocation": "ml/get_filters/MlGetFiltersRequest.ts#L24-L62" + "specLocation": "ml/get_filters/MlGetFiltersRequest.ts#L24-L63" }, { "body": { @@ -28755,7 +28857,7 @@ } } ], - "specLocation": "ml/get_job_stats/MlGetJobStatsRequest.ts#L23-L67" + "specLocation": "ml/get_job_stats/MlGetJobStatsRequest.ts#L23-L68" }, { "body": { @@ -28856,7 +28958,7 @@ } } ], - "specLocation": "ml/get_jobs/MlGetJobsRequest.ts#L23-L77" + "specLocation": "ml/get_jobs/MlGetJobsRequest.ts#L23-L78" }, { "body": { @@ -29131,7 +29233,7 @@ } } ], - "specLocation": "ml/get_overall_buckets/MlGetOverallBucketsRequest.ts#L25-L152" + "specLocation": "ml/get_overall_buckets/MlGetOverallBucketsRequest.ts#L25-L153" }, { "body": { @@ -29327,7 +29429,7 @@ } } ], - "specLocation": "ml/get_trained_models/MlGetTrainedModelRequest.ts#L25-L109" + "specLocation": "ml/get_trained_models/MlGetTrainedModelRequest.ts#L25-L110" }, { "body": { @@ -29442,7 +29544,7 @@ } } ], - "specLocation": "ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts#L24-L76" + "specLocation": "ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts#L24-L77" }, { "body": { @@ -29568,7 +29670,7 @@ } } ], - "specLocation": "ml/infer_trained_model/MlInferTrainedModelRequest.ts#L27-L71" + "specLocation": "ml/infer_trained_model/MlInferTrainedModelRequest.ts#L27-L72" }, { "body": { @@ -29660,7 +29762,7 @@ } } ], - "specLocation": "ml/open_job/MlOpenJobRequest.ts#L24-L65" + "specLocation": "ml/open_job/MlOpenJobRequest.ts#L24-L66" }, { "body": { @@ -29749,7 +29851,7 @@ } ], "query": [], - "specLocation": "ml/post_calendar_events/MlPostCalendarEventsRequest.ts#L24-L47" + "specLocation": "ml/post_calendar_events/MlPostCalendarEventsRequest.ts#L24-L48" }, { "body": { @@ -29801,7 +29903,7 @@ } ] }, - "description": "Preview features used by data frame analytics.\nPreviews the extracted features used by a data frame analytics config.", + "description": "Preview features used by data frame analytics.\nPreview the extracted features used by a data frame analytics config.", "inherits": { "type": { "name": "RequestBase", @@ -29828,7 +29930,7 @@ } ], "query": [], - "specLocation": "ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts#L24-L59" + "specLocation": "ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts#L24-L60" }, { "body": { @@ -29954,7 +30056,7 @@ } } ], - "specLocation": "ml/preview_datafeed/MlPreviewDatafeedRequest.ts#L26-L80" + "specLocation": "ml/preview_datafeed/MlPreviewDatafeedRequest.ts#L26-L81" }, { "body": { @@ -30046,7 +30148,7 @@ } ], "query": [], - "specLocation": "ml/put_calendar/MlPutCalendarRequest.ts#L23-L50" + "specLocation": "ml/put_calendar/MlPutCalendarRequest.ts#L23-L51" }, { "body": { @@ -30143,7 +30245,7 @@ } ], "query": [], - "specLocation": "ml/put_calendar_job/MlPutCalendarJobRequest.ts#L23-L44" + "specLocation": "ml/put_calendar_job/MlPutCalendarJobRequest.ts#L23-L45" }, { "body": { @@ -30839,7 +30941,7 @@ } } ], - "specLocation": "ml/put_datafeed/MlPutDatafeedRequest.ts#L37-L183" + "specLocation": "ml/put_datafeed/MlPutDatafeedRequest.ts#L37-L184" }, { "body": { @@ -31107,7 +31209,7 @@ } ], "query": [], - "specLocation": "ml/put_filter/MlPutFilterRequest.ts#L23-L57" + "specLocation": "ml/put_filter/MlPutFilterRequest.ts#L23-L58" }, { "body": { @@ -31450,7 +31552,7 @@ } } ], - "specLocation": "ml/put_job/MlPutJobRequest.ts#L30-L155" + "specLocation": "ml/put_job/MlPutJobRequest.ts#L30-L156" }, { "body": { @@ -31899,7 +32001,7 @@ } } ], - "specLocation": "ml/put_trained_model/MlPutTrainedModelRequest.ts#L31-L134" + "specLocation": "ml/put_trained_model/MlPutTrainedModelRequest.ts#L31-L135" }, { "body": { @@ -31979,7 +32081,7 @@ } } ], - "specLocation": "ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts#L23-L73" + "specLocation": "ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts#L23-L74" }, { "body": { @@ -32083,7 +32185,7 @@ } ], "query": [], - "specLocation": "ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartRequest.ts#L24-L64" + "specLocation": "ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartRequest.ts#L24-L65" }, { "body": { @@ -32196,7 +32298,7 @@ } ], "query": [], - "specLocation": "ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyRequest.ts#L24-L67" + "specLocation": "ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyRequest.ts#L24-L68" }, { "body": { @@ -32277,7 +32379,7 @@ } } ], - "specLocation": "ml/reset_job/MlResetJobRequest.ts#L23-L64" + "specLocation": "ml/reset_job/MlResetJobRequest.ts#L23-L65" }, { "body": { @@ -32345,7 +32447,7 @@ } } ], - "specLocation": "ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts#L24-L67" + "specLocation": "ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts#L24-L68" }, { "body": { @@ -32494,7 +32596,7 @@ } } ], - "specLocation": "ml/start_datafeed/MlStartDatafeedRequest.ts#L24-L98" + "specLocation": "ml/start_datafeed/MlStartDatafeedRequest.ts#L24-L99" }, { "body": { @@ -32657,7 +32759,7 @@ } } ], - "specLocation": "ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts#L29-L100" + "specLocation": "ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts#L29-L101" }, { "body": { @@ -32757,7 +32859,7 @@ } } ], - "specLocation": "ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts#L24-L77" + "specLocation": "ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts#L24-L78" }, { "body": { @@ -32898,7 +33000,7 @@ } } ], - "specLocation": "ml/stop_datafeed/MlStopDatafeedRequest.ts#L24-L85" + "specLocation": "ml/stop_datafeed/MlStopDatafeedRequest.ts#L24-L86" }, { "body": { @@ -32985,7 +33087,7 @@ } } ], - "specLocation": "ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts#L23-L60" + "specLocation": "ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts#L23-L61" }, { "body": { @@ -33102,7 +33204,7 @@ } ], "query": [], - "specLocation": "ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts#L24-L79" + "specLocation": "ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts#L24-L80" }, { "body": { @@ -33527,7 +33629,7 @@ } } ], - "specLocation": "ml/update_datafeed/MlUpdateDatafeedRequest.ts#L31-L169" + "specLocation": "ml/update_datafeed/MlUpdateDatafeedRequest.ts#L31-L170" }, { "body": { @@ -33810,7 +33912,7 @@ } ], "query": [], - "specLocation": "ml/update_filter/MlUpdateFilterRequest.ts#L23-L59" + "specLocation": "ml/update_filter/MlUpdateFilterRequest.ts#L23-L60" }, { "body": { @@ -34099,7 +34201,7 @@ } ], "query": [], - "specLocation": "ml/update_job/MlUpdateJobRequest.ts#L33-L146" + "specLocation": "ml/update_job/MlUpdateJobRequest.ts#L33-L147" }, { "body": { @@ -34440,7 +34542,7 @@ } } ], - "specLocation": "ml/update_trained_model_deployment/MlUpdateTrainedModelDeploymentRequest.ts#L24-L69" + "specLocation": "ml/update_trained_model_deployment/MlUpdateTrainedModelDeploymentRequest.ts#L24-L70" }, { "body": { @@ -34676,7 +34778,7 @@ } } ], - "specLocation": "_global/msearch/MultiSearchRequest.ts#L25-L134" + "specLocation": "_global/msearch/MultiSearchRequest.ts#L25-L135" }, { "body": { @@ -35289,7 +35391,7 @@ }, "path": [], "query": [], - "specLocation": "_global/ping/PingRequest.ts#L22-L37" + "specLocation": "_global/ping/PingRequest.ts#L22-L38" }, { "body": { @@ -36181,7 +36283,7 @@ } } ], - "specLocation": "_global/rank_eval/RankEvalRequest.ts#L24-L75" + "specLocation": "_global/rank_eval/RankEvalRequest.ts#L24-L76" }, { "body": { @@ -38225,7 +38327,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a search application.\nRemove a search application and its associated alias. Indices attached to the search application are not removed.", + "description": "Delete a search application.\n\nRemove a search application and its associated alias. Indices attached to the search application are not removed.", "inherits": { "type": { "name": "RequestBase", @@ -38239,7 +38341,7 @@ }, "path": [ { - "description": "The name of the search application to delete", + "description": "The name of the search application to delete.", "name": "name", "required": true, "type": { @@ -38252,7 +38354,7 @@ } ], "query": [], - "specLocation": "search_application/delete/SearchApplicationsDeleteRequest.ts#L22-L44" + "specLocation": "search_application/delete/SearchApplicationsDeleteRequest.ts#L22-L46" }, { "body": { @@ -38306,7 +38408,7 @@ } ], "query": [], - "specLocation": "search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts#L22-L43" + "specLocation": "search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts#L22-L44" }, { "body": { @@ -38360,7 +38462,7 @@ } ], "query": [], - "specLocation": "search_application/get/SearchApplicationsGetRequest.ts#L22-L42" + "specLocation": "search_application/get/SearchApplicationsGetRequest.ts#L22-L43" }, { "body": { @@ -38417,7 +38519,7 @@ } ], "query": [], - "specLocation": "search_application/get_behavioral_analytics/BehavioralAnalyticsGetRequest.ts#L22-L46" + "specLocation": "search_application/get_behavioral_analytics/BehavioralAnalyticsGetRequest.ts#L22-L47" }, { "body": { @@ -38507,7 +38609,7 @@ } } ], - "specLocation": "search_application/list/SearchApplicationsListRequest.ts#L22-L52" + "specLocation": "search_application/list/SearchApplicationsListRequest.ts#L22-L53" }, { "body": { @@ -38603,7 +38705,7 @@ } } ], - "specLocation": "search_application/put/SearchApplicationsPutRequest.ts#L23-L56" + "specLocation": "search_application/put/SearchApplicationsPutRequest.ts#L23-L57" }, { "body": { @@ -38663,7 +38765,7 @@ } ], "query": [], - "specLocation": "search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts#L22-L42" + "specLocation": "search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts#L22-L43" }, { "body": { @@ -38758,7 +38860,7 @@ } } ], - "specLocation": "search_application/search/SearchApplicationsSearchRequest.ts#L24-L60" + "specLocation": "search_application/search/SearchApplicationsSearchRequest.ts#L24-L61" }, { "body": { @@ -43612,7 +43714,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a transform.\nDeletes a transform.", + "description": "Delete a transform.", "inherits": { "type": { "name": "RequestBase", @@ -43706,7 +43808,7 @@ "body": { "kind": "no_body" }, - "description": "Get transforms.\nRetrieves configuration information for transforms.", + "description": "Get transforms.\nGet configuration information for transforms.", "inherits": { "type": { "name": "RequestBase", @@ -43786,7 +43888,7 @@ } } ], - "specLocation": "transform/get_transform/GetTransformRequest.ts#L24-L83" + "specLocation": "transform/get_transform/GetTransformRequest.ts#L24-L84" }, { "body": { @@ -43833,7 +43935,7 @@ "body": { "kind": "no_body" }, - "description": "Get transform stats.\nRetrieves usage information for transforms.", + "description": "Get transform stats.\nGet usage information for transforms.", "inherits": { "type": { "name": "RequestBase", @@ -43912,7 +44014,7 @@ } } ], - "specLocation": "transform/get_transform_stats/GetTransformStatsRequest.ts#L25-L75" + "specLocation": "transform/get_transform_stats/GetTransformStatsRequest.ts#L25-L76" }, { "body": { @@ -44111,7 +44213,7 @@ } } ], - "specLocation": "transform/preview_transform/PreviewTransformRequest.ts#L33-L118" + "specLocation": "transform/preview_transform/PreviewTransformRequest.ts#L33-L119" }, { "body": { @@ -44341,7 +44443,7 @@ } } ], - "specLocation": "transform/put_transform/PutTransformRequest.ts#L33-L129" + "specLocation": "transform/put_transform/PutTransformRequest.ts#L33-L130" }, { "body": { @@ -44422,7 +44524,7 @@ } } ], - "specLocation": "transform/reset_transform/ResetTransformRequest.ts#L24-L61" + "specLocation": "transform/reset_transform/ResetTransformRequest.ts#L24-L62" }, { "body": { @@ -44490,7 +44592,7 @@ } } ], - "specLocation": "transform/schedule_now_transform/ScheduleNowTransformRequest.ts#L23-L56" + "specLocation": "transform/schedule_now_transform/ScheduleNowTransformRequest.ts#L23-L57" }, { "body": { @@ -44570,7 +44672,7 @@ } } ], - "specLocation": "transform/start_transform/StartTransformRequest.ts#L24-L72" + "specLocation": "transform/start_transform/StartTransformRequest.ts#L24-L73" }, { "body": { @@ -44690,7 +44792,7 @@ } } ], - "specLocation": "transform/stop_transform/StopTransformRequest.ts#L24-L83" + "specLocation": "transform/stop_transform/StopTransformRequest.ts#L24-L84" }, { "body": { @@ -44881,7 +44983,7 @@ } } ], - "specLocation": "transform/update_transform/UpdateTransformRequest.ts#L31-L112" + "specLocation": "transform/update_transform/UpdateTransformRequest.ts#L31-L113" }, { "body": { @@ -95966,15 +96068,19 @@ "kind": "enum", "members": [ { + "description": "Disable metadata changes, such as closing the index.", "name": "metadata" }, { + "description": "Disable read operations.", "name": "read" }, { + "description": "Disable write operations and metadata changes.", "name": "read_only" }, { + "description": "Disable write operations. However, metadata changes are still allowed.", "name": "write" } ], @@ -95982,7 +96088,7 @@ "name": "IndicesBlockOptions", "namespace": "indices.add_block" }, - "specLocation": "indices/add_block/IndicesAddBlockRequest.ts#L51-L56" + "specLocation": "indices/add_block/IndicesAddBlockRequest.ts#L91-L100" }, { "kind": "type_alias",