`. 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.\n\n## Required authorization\n\n* Cluster privileges: `monitor_ml`\n",
+ "operationId": "ml-get-datafeed-stats",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/ml.get_datafeed_stats-datafeed_id"
+ },
+ {
+ "$ref": "#/components/parameters/ml.get_datafeed_stats-allow_no_match"
+ }
+ ],
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/ml.get_datafeed_stats-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET _ml/datafeeds/datafeed-high_sum_total_sales/_stats\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.ml.get_datafeed_stats(\n datafeed_id=\"datafeed-high_sum_total_sales\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.ml.getDatafeedStats({\n datafeed_id: \"datafeed-high_sum_total_sales\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.ml.get_datafeed_stats(\n datafeed_id: \"datafeed-high_sum_total_sales\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->ml()->getDatafeedStats([\n \"datafeed_id\" => \"datafeed-high_sum_total_sales\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_ml/datafeeds/datafeed-high_sum_total_sales/_stats\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.ml().getDatafeedStats(g -> g\n .datafeedId(\"datafeed-high_sum_total_sales\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch, Machine Learning",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_ml/anomaly_detectors/{job_id}/_stats": {
+ "get": {
+ "tags": [
+ "ml anomaly"
+ ],
+ "summary": "Get anomaly detection job stats\n",
+ "description": "**All methods and paths for this operation:**\n\n\n GET\n /_ml/anomaly_detectors/_stats\n
\n \n GET\n /_ml/anomaly_detectors/{job_id}/_stats\n
\n\n## Required authorization\n\n* Cluster privileges: `monitor_ml`\n",
+ "operationId": "ml-get-job-stats",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/ml.get_job_stats-job_id"
+ },
+ {
+ "$ref": "#/components/parameters/ml.get_job_stats-allow_no_match"
+ }
+ ],
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/ml.get_job_stats-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET _ml/anomaly_detectors/low_request_rate/_stats\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.ml.get_job_stats(\n job_id=\"low_request_rate\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.ml.getJobStats({\n job_id: \"low_request_rate\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.ml.get_job_stats(\n job_id: \"low_request_rate\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->ml()->getJobStats([\n \"job_id\" => \"low_request_rate\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_ml/anomaly_detectors/low_request_rate/_stats\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.ml().getJobStats(g -> g\n .jobId(\"low_request_rate\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch, Machine Learning",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_ml/anomaly_detectors/{job_id}/results/overall_buckets": {
+ "post": {
+ "tags": [
+ "ml anomaly"
+ ],
+ "summary": "Get overall bucket results\n",
+ "description": "**All methods and paths for this operation:**\n\n\n GET\n /_ml/anomaly_detectors/{job_id}/results/overall_buckets\n
\n \n POST\n /_ml/anomaly_detectors/{job_id}/results/overall_buckets\n
\n \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.\n\n## Required authorization\n\n* Cluster privileges: `monitor_ml`\n",
+ "operationId": "ml-get-overall-buckets",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/ml.get_overall_buckets-job_id"
+ },
+ {
+ "$ref": "#/components/parameters/ml.get_overall_buckets-allow_no_match"
+ },
+ {
+ "$ref": "#/components/parameters/ml.get_overall_buckets-bucket_span"
+ },
+ {
+ "$ref": "#/components/parameters/ml.get_overall_buckets-end"
+ },
+ {
+ "$ref": "#/components/parameters/ml.get_overall_buckets-exclude_interim"
+ },
+ {
+ "$ref": "#/components/parameters/ml.get_overall_buckets-overall_score"
+ },
+ {
+ "$ref": "#/components/parameters/ml.get_overall_buckets-start"
+ },
+ {
+ "$ref": "#/components/parameters/ml.get_overall_buckets-top_n"
+ }
+ ],
+ "requestBody": {
+ "$ref": "#/components/requestBodies/ml.get_overall_buckets"
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/ml.get_overall_buckets-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET _ml/anomaly_detectors/job-*/results/overall_buckets\n{\n \"overall_score\": 80,\n \"start\": \"1403532000000\"\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.ml.get_overall_buckets(\n job_id=\"job-*\",\n overall_score=80,\n start=\"1403532000000\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.ml.getOverallBuckets({\n job_id: \"job-*\",\n overall_score: 80,\n start: 1403532000000,\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.ml.get_overall_buckets(\n job_id: \"job-*\",\n body: {\n \"overall_score\": 80,\n \"start\": \"1403532000000\"\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->ml()->getOverallBuckets([\n \"job_id\" => \"job-*\",\n \"body\" => [\n \"overall_score\" => 80,\n \"start\" => \"1403532000000\",\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"overall_score\":80,\"start\":\"1403532000000\"}' \"$ELASTICSEARCH_URL/_ml/anomaly_detectors/job-*/results/overall_buckets\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.ml().getOverallBuckets(g -> g\n .jobId(\"job-*\")\n .overallScore(\"80\")\n .start(DateTime.of(\"1403532000000\"))\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch, Machine Learning",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_ml/trained_models/{model_id}/_stats": {
+ "get": {
+ "tags": [
+ "ml trained model"
+ ],
+ "summary": "Get trained models usage info\n",
+ "description": "**All methods and paths for this operation:**\n\n\n GET\n /_ml/trained_models/_stats\n
\n \n GET\n /_ml/trained_models/{model_id}/_stats\n
\n \n\nYou can get usage information for multiple trained\nmodels in a single API request by using a comma-separated list of model IDs or a wildcard expression.\n\n## Required authorization\n\n* Cluster privileges: `monitor_ml`\n",
+ "operationId": "ml-get-trained-models-stats",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/ml.get_trained_models_stats-model_id"
+ },
+ {
+ "$ref": "#/components/parameters/ml.get_trained_models_stats-allow_no_match"
+ },
+ {
+ "$ref": "#/components/parameters/ml.get_trained_models_stats-from"
+ },
+ {
+ "$ref": "#/components/parameters/ml.get_trained_models_stats-size"
+ }
+ ],
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/ml.get_trained_models_stats-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET _ml/trained_models/_stats\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.ml.get_trained_models_stats()"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.ml.getTrainedModelsStats();"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.ml.get_trained_models_stats"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->ml()->getTrainedModelsStats();"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_ml/trained_models/_stats\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.ml().getTrainedModelsStats(g -> g);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch, Machine Learning",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_ml/trained_models/{model_id}/_infer": {
+ "post": {
+ "tags": [
+ "ml trained model"
+ ],
+ "summary": "Evaluate a trained model",
+ "operationId": "ml-infer-trained-model",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "model_id",
+ "description": "The unique identifier of the trained model.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "timeout",
+ "description": "Controls the amount of time to wait for inference results.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "docs": {
+ "description": "An array of objects to pass to the model for inference. The objects should contain a fields matching your\nconfigured trained model input. Typically, for NLP models, the field name is `text_field`.\nCurrently, for NLP models, only a single value is allowed.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "inference_config": {
+ "description": "The inference configuration updates to apply on the API call",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.InferenceConfigUpdateContainer"
+ }
+ ]
+ }
+ },
+ "required": [
+ "docs"
+ ]
+ },
+ "examples": {
+ "MlInferTrainedModelExample1": {
+ "description": "An example body for a `POST _ml/trained_models/lang_ident_model_1/_infer` request.",
+ "value": "{\n \"docs\":[{\"text\": \"The fool doth think he is wise, but the wise man knows himself to be a fool.\"}]\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "inference_results": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.InferenceResponseResult"
+ }
+ }
+ },
+ "required": [
+ "inference_results"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _ml/trained_models/lang_ident_model_1/_infer\n{\n \"docs\":[{\"text\": \"The fool doth think he is wise, but the wise man knows himself to be a fool.\"}]\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.ml.infer_trained_model(\n model_id=\"lang_ident_model_1\",\n docs=[\n {\n \"text\": \"The fool doth think he is wise, but the wise man knows himself to be a fool.\"\n }\n ],\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.ml.inferTrainedModel({\n model_id: \"lang_ident_model_1\",\n docs: [\n {\n text: \"The fool doth think he is wise, but the wise man knows himself to be a fool.\",\n },\n ],\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.ml.infer_trained_model(\n model_id: \"lang_ident_model_1\",\n body: {\n \"docs\": [\n {\n \"text\": \"The fool doth think he is wise, but the wise man knows himself to be a fool.\"\n }\n ]\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->ml()->inferTrainedModel([\n \"model_id\" => \"lang_ident_model_1\",\n \"body\" => [\n \"docs\" => array(\n [\n \"text\" => \"The fool doth think he is wise, but the wise man knows himself to be a fool.\",\n ],\n ),\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"docs\":[{\"text\":\"The fool doth think he is wise, but the wise man knows himself to be a fool.\"}]}' \"$ELASTICSEARCH_URL/_ml/trained_models/lang_ident_model_1/_infer\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.ml().inferTrainedModel(i -> i\n .docs(Map.of(\"text\", JsonData.fromJson(\"\\\"The fool doth think he is wise, but the wise man knows himself to be a fool.\\\"\")))\n .modelId(\"lang_ident_model_1\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch, Machine Learning",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_ml/anomaly_detectors/{job_id}/_open": {
+ "post": {
+ "tags": [
+ "ml anomaly"
+ ],
+ "summary": "Open anomaly detection jobs",
+ "description": "An anomaly detection job must be opened to be ready to receive and analyze\ndata. It can be opened and closed multiple times throughout its lifecycle.\nWhen you open a new job, it starts with an empty model.\nWhen you open an existing job, the most recent model state is automatically\nloaded. The job is ready to resume its analysis from where it left off, once\nnew data is received.\n\n## Required authorization\n\n* Cluster privileges: `manage_ml`\n",
+ "operationId": "ml-open-job",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "job_id",
+ "description": "Identifier for the anomaly detection job.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "timeout",
+ "description": "Controls the time to wait until a job has opened.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "timeout": {
+ "description": "Refer to the description for the `timeout` query parameter.",
+ "default": "30m",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "MlOpenJobRequestExample1": {
+ "description": "A request to open anomaly detection jobs. The timeout specifies to wait 35 minutes for the job to open.\n",
+ "value": "{\n \"timeout\": \"35m\"\n}"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "opened": {
+ "type": "boolean"
+ },
+ "node": {
+ "description": "The ID of the node that the job was started on. In serverless this will be the \"serverless\".\nIf the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.NodeId"
+ }
+ ]
+ }
+ },
+ "required": [
+ "opened",
+ "node"
+ ]
+ },
+ "examples": {
+ "MlOpenJobResponseExample1": {
+ "description": "A successful response when opening an anomaly detection job.",
+ "value": "{\n \"opened\": true,\n \"node\": \"node-1\"\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST /_ml/anomaly_detectors/job-01/_open\n{\n \"timeout\": \"35m\"\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.ml.open_job(\n job_id=\"job-01\",\n timeout=\"35m\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.ml.openJob({\n job_id: \"job-01\",\n timeout: \"35m\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.ml.open_job(\n job_id: \"job-01\",\n body: {\n \"timeout\": \"35m\"\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->ml()->openJob([\n \"job_id\" => \"job-01\",\n \"body\" => [\n \"timeout\" => \"35m\",\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"timeout\":\"35m\"}' \"$ELASTICSEARCH_URL/_ml/anomaly_detectors/job-01/_open\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.ml().openJob(o -> o\n .jobId(\"job-01\")\n .timeout(t -> t\n .time(\"35m\")\n )\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch, Machine Learning",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_ml/data_frame/analytics/{id}/_preview": {
+ "post": {
+ "tags": [
+ "ml data frame"
+ ],
+ "summary": "Preview features used by data frame analytics\n",
+ "description": "**All methods and paths for this operation:**\n\n\n GET\n /_ml/data_frame/analytics/_preview\n
\n \n POST\n /_ml/data_frame/analytics/_preview\n
\n \n GET\n /_ml/data_frame/analytics/{id}/_preview\n
\n \n POST\n /_ml/data_frame/analytics/{id}/_preview\n
\n \n\nPreview the extracted features used by a data frame analytics config.\n\n## Required authorization\n\n* Cluster privileges: `monitor_ml`\n",
+ "operationId": "ml-preview-data-frame-analytics",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/ml.preview_data_frame_analytics-id"
+ }
+ ],
+ "requestBody": {
+ "$ref": "#/components/requestBodies/ml.preview_data_frame_analytics"
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/ml.preview_data_frame_analytics-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _ml/data_frame/analytics/_preview\n{\n \"config\": {\n \"source\": {\n \"index\": \"houses_sold_last_10_yrs\"\n },\n \"analysis\": {\n \"regression\": {\n \"dependent_variable\": \"price\"\n }\n }\n }\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.ml.preview_data_frame_analytics(\n config={\n \"source\": {\n \"index\": \"houses_sold_last_10_yrs\"\n },\n \"analysis\": {\n \"regression\": {\n \"dependent_variable\": \"price\"\n }\n }\n },\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.ml.previewDataFrameAnalytics({\n config: {\n source: {\n index: \"houses_sold_last_10_yrs\",\n },\n analysis: {\n regression: {\n dependent_variable: \"price\",\n },\n },\n },\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.ml.preview_data_frame_analytics(\n body: {\n \"config\": {\n \"source\": {\n \"index\": \"houses_sold_last_10_yrs\"\n },\n \"analysis\": {\n \"regression\": {\n \"dependent_variable\": \"price\"\n }\n }\n }\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->ml()->previewDataFrameAnalytics([\n \"body\" => [\n \"config\" => [\n \"source\" => [\n \"index\" => \"houses_sold_last_10_yrs\",\n ],\n \"analysis\" => [\n \"regression\" => [\n \"dependent_variable\" => \"price\",\n ],\n ],\n ],\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"config\":{\"source\":{\"index\":\"houses_sold_last_10_yrs\"},\"analysis\":{\"regression\":{\"dependent_variable\":\"price\"}}}}' \"$ELASTICSEARCH_URL/_ml/data_frame/analytics/_preview\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.ml().previewDataFrameAnalytics(p -> p\n .config(c -> c\n .source(s -> s\n .index(\"houses_sold_last_10_yrs\")\n )\n .analysis(a -> a\n .regression(r -> r\n .dependentVariable(\"price\")\n )\n )\n )\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch, Machine Learning",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_ml/datafeeds/{datafeed_id}/_preview": {
+ "post": {
+ "tags": [
+ "ml anomaly"
+ ],
+ "summary": "Preview a datafeed\n",
+ "description": "**All methods and paths for this operation:**\n\n\n GET\n /_ml/datafeeds/_preview\n
\n \n POST\n /_ml/datafeeds/_preview\n
\n \n GET\n /_ml/datafeeds/{datafeed_id}/_preview\n
\n \n POST\n /_ml/datafeeds/{datafeed_id}/_preview\n
\n \n\nThis API returns the first \"page\" of search results from a datafeed.\nYou can preview an existing datafeed or provide configuration details for a datafeed\nand anomaly detection job in the API. The preview shows the structure of the data\nthat will be passed to the anomaly detection engine.\nIMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that\ncalled the API. However, when the datafeed starts it uses the roles of the last user that created or updated the\ndatafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials.\nYou can also use secondary authorization headers to supply the credentials.\n\n## Required authorization\n\n* Index privileges: `read`\n* Cluster privileges: `manage_ml`\n",
+ "operationId": "ml-preview-datafeed",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/ml.preview_datafeed-datafeed_id"
+ },
+ {
+ "$ref": "#/components/parameters/ml.preview_datafeed-start"
+ },
+ {
+ "$ref": "#/components/parameters/ml.preview_datafeed-end"
+ }
+ ],
+ "requestBody": {
+ "$ref": "#/components/requestBodies/ml.preview_datafeed"
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/ml.preview_datafeed-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET _ml/datafeeds/datafeed-high_sum_total_sales/_preview\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.ml.preview_datafeed(\n datafeed_id=\"datafeed-high_sum_total_sales\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.ml.previewDatafeed({\n datafeed_id: \"datafeed-high_sum_total_sales\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.ml.preview_datafeed(\n datafeed_id: \"datafeed-high_sum_total_sales\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->ml()->previewDatafeed([\n \"datafeed_id\" => \"datafeed-high_sum_total_sales\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_ml/datafeeds/datafeed-high_sum_total_sales/_preview\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.ml().previewDatafeed(p -> p\n .datafeedId(\"datafeed-high_sum_total_sales\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch, Machine Learning",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_ml/trained_models/{model_id}/definition/{part}": {
+ "put": {
+ "tags": [
+ "ml trained model"
+ ],
+ "summary": "Create part of a trained model definition",
+ "description": "\n\n## Required authorization\n\n* Cluster privileges: `manage_ml`\n",
+ "operationId": "ml-put-trained-model-definition-part",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "model_id",
+ "description": "The unique identifier of the trained model.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "path",
+ "name": "part",
+ "description": "The definition part number. When the definition is loaded for inference the definition parts are streamed in the\norder of their part number. The first part must be `0` and the final part must be `total_parts - 1`.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "definition": {
+ "description": "The definition part for the model. Must be a base64 encoded string.",
+ "type": "string"
+ },
+ "total_definition_length": {
+ "description": "The total uncompressed definition length in bytes. Not base64 encoded.",
+ "type": "number"
+ },
+ "total_parts": {
+ "description": "The total number of parts that will be uploaded. Must be greater than 0.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "definition",
+ "total_definition_length",
+ "total_parts"
+ ]
+ },
+ "examples": {
+ "MlPutTrainedModelDefinitionPartExample1": {
+ "description": "An example body for a `PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/definition/0` request.",
+ "value": "{\n \"definition\": \"...\",\n \"total_definition_length\": 265632637,\n \"total_parts\": 64\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/definition/0\n{\n \"definition\": \"...\",\n \"total_definition_length\": 265632637,\n \"total_parts\": 64\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.ml.put_trained_model_definition_part(\n model_id=\"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n part=\"0\",\n definition=\"...\",\n total_definition_length=265632637,\n total_parts=64,\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.ml.putTrainedModelDefinitionPart({\n model_id: \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n part: 0,\n definition: \"...\",\n total_definition_length: 265632637,\n total_parts: 64,\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.ml.put_trained_model_definition_part(\n model_id: \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n part: \"0\",\n body: {\n \"definition\": \"...\",\n \"total_definition_length\": 265632637,\n \"total_parts\": 64\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->ml()->putTrainedModelDefinitionPart([\n \"model_id\" => \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n \"part\" => \"0\",\n \"body\" => [\n \"definition\" => \"...\",\n \"total_definition_length\" => 265632637,\n \"total_parts\" => 64,\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"definition\":\"...\",\"total_definition_length\":265632637,\"total_parts\":64}' \"$ELASTICSEARCH_URL/_ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/definition/0\""
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch, Machine Learning",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_ml/trained_models/{model_id}/vocabulary": {
+ "put": {
+ "tags": [
+ "ml trained model"
+ ],
+ "summary": "Create a trained model vocabulary",
+ "description": "This API is supported only for natural language processing (NLP) models.\nThe vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.\n\n## Required authorization\n\n* Cluster privileges: `manage_ml`\n",
+ "operationId": "ml-put-trained-model-vocabulary",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "model_id",
+ "description": "The unique identifier of the trained model.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "vocabulary": {
+ "description": "The model vocabulary, which must not be empty.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "merges": {
+ "description": "The optional model merges if required by the tokenizer.",
+ "x-state": "Generally available",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "scores": {
+ "description": "The optional vocabulary value scores if required by the tokenizer.",
+ "x-state": "Generally available",
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ },
+ "required": [
+ "vocabulary"
+ ]
+ },
+ "examples": {
+ "MlPutTrainedModelVocabularyExample1": {
+ "description": "An example body for a `PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/vocabulary` request.",
+ "value": "{\n \"vocabulary\": [\n \"[PAD]\",\n \"[unused0]\",\n ]\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/vocabulary\n{\n \"vocabulary\": [\n \"[PAD]\",\n \"[unused0]\",\n ]\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.ml.put_trained_model_vocabulary(\n model_id=\"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n vocabulary=[\n \"[PAD]\",\n \"[unused0]\"\n ],\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.ml.putTrainedModelVocabulary({\n model_id: \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n vocabulary: [\"[PAD]\", \"[unused0]\"],\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.ml.put_trained_model_vocabulary(\n model_id: \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n body: {\n \"vocabulary\": [\n \"[PAD]\",\n \"[unused0]\"\n ]\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->ml()->putTrainedModelVocabulary([\n \"model_id\" => \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n \"body\" => [\n \"vocabulary\" => array(\n \"[PAD]\",\n \"[unused0]\",\n ),\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"vocabulary\":[\"[PAD]\",\"[unused0]\"]}' \"$ELASTICSEARCH_URL/_ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/vocabulary\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.ml().putTrainedModelVocabulary(p -> p\n .modelId(\"elastic__distilbert-base-uncased-finetuned-conll03-english\")\n .vocabulary(List.of(\"[PAD]\",\"[unused0]\"))\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch, Machine Learning",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_ml/anomaly_detectors/{job_id}/_reset": {
+ "post": {
+ "tags": [
+ "ml anomaly"
+ ],
+ "summary": "Reset an anomaly detection job",
+ "description": "All model state and results are deleted. The job is ready to start over as if\nit had just been created.\nIt is not currently possible to reset multiple jobs using wildcards or a\ncomma separated list.\n\n## Required authorization\n\n* Cluster privileges: `manage_ml`\n",
+ "operationId": "ml-reset-job",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "job_id",
+ "description": "The ID of the job to reset.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "wait_for_completion",
+ "description": "Should this request wait until the operation has completed before\nreturning.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "delete_user_annotations",
+ "description": "Specifies whether annotations that have been added by the\nuser should be deleted along with any auto-generated annotations when the job is\nreset.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _ml/anomaly_detectors/total-requests/_reset\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.ml.reset_job(\n job_id=\"total-requests\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.ml.resetJob({\n job_id: \"total-requests\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.ml.reset_job(\n job_id: \"total-requests\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->ml()->resetJob([\n \"job_id\" => \"total-requests\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_ml/anomaly_detectors/total-requests/_reset\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.ml().resetJob(r -> r\n .jobId(\"total-requests\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch, Machine Learning",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_ml/data_frame/analytics/{id}/_start": {
+ "post": {
+ "tags": [
+ "ml data frame"
+ ],
+ "summary": "Start a data frame analytics job",
+ "description": "A data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.\nIf the destination index does not exist, it is created automatically the\nfirst time you start the data frame analytics job. The\n`index.number_of_shards` and `index.number_of_replicas` settings for the\ndestination index are copied from the source index. If there are multiple\nsource indices, the destination index copies the highest setting values. The\nmappings for the destination index are also copied from the source indices.\nIf there are any mapping conflicts, the job fails to start.\nIf the destination index exists, it is used as is. You can therefore set up\nthe destination index in advance with custom settings and mappings.\n\n## Required authorization\n\n* Index privileges: `create_index`,`index`,`manage`,`read`,`view_index_metadata`\n* Cluster privileges: `manage_ml`\n",
+ "operationId": "ml-start-data-frame-analytics",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "id",
+ "description": "Identifier for the data frame analytics job. This identifier can contain\nlowercase alphanumeric characters (a-z and 0-9), hyphens, and\nunderscores. It must start and end with alphanumeric characters.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "timeout",
+ "description": "Controls the amount of time to wait until the data frame analytics job\nstarts.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "acknowledged": {
+ "type": "boolean"
+ },
+ "node": {
+ "description": "The ID of the node that the job was started on. If the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string.\nThe node ID of the node the job has been assigned to, or\nan empty string if it hasn't been assigned to a node. In\nserverless if the job has been assigned to run then the\nnode ID will be \"serverless\".",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.NodeId"
+ }
+ ]
+ }
+ },
+ "required": [
+ "acknowledged",
+ "node"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _ml/data_frame/analytics/loganalytics/_start\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.ml.start_data_frame_analytics(\n id=\"loganalytics\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.ml.startDataFrameAnalytics({\n id: \"loganalytics\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.ml.start_data_frame_analytics(\n id: \"loganalytics\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->ml()->startDataFrameAnalytics([\n \"id\" => \"loganalytics\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_ml/data_frame/analytics/loganalytics/_start\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.ml().startDataFrameAnalytics(s -> s\n .id(\"loganalytics\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch, Machine Learning",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_ml/datafeeds/{datafeed_id}/_start": {
+ "post": {
+ "tags": [
+ "ml anomaly"
+ ],
+ "summary": "Start datafeeds",
+ "description": "A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.\n\nBefore you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.\n\nIf you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.\nIf new data was indexed for that exact millisecond between stopping and starting, it will be ignored.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or\nupdate it had at the time of creation or update and runs the query using those same roles. If you provided secondary\nauthorization headers when you created or updated the datafeed, those credentials are used instead.\n\n## Required authorization\n\n* Cluster privileges: `manage_ml`\n",
+ "operationId": "ml-start-datafeed",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "datafeed_id",
+ "description": "A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase\nalphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric\ncharacters.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "end",
+ "description": "The time that the datafeed should end, which can be specified by using one of the following formats:\n\n* ISO 8601 format with milliseconds, for example `2017-01-22T06:00:00.000Z`\n* ISO 8601 format without milliseconds, for example `2017-01-22T06:00:00+00:00`\n* Milliseconds since the epoch, for example `1485061200000`\n\nDate-time arguments using either of the ISO 8601 formats must have a time zone designator, where `Z` is accepted\nas an abbreviation for UTC time. When a URL is expected (for example, in browsers), the `+` used in time zone\ndesignators must be encoded as `%2B`.\nThe end time value is exclusive. If you do not specify an end time, the datafeed\nruns continuously.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.DateTime"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "start",
+ "description": "The time that the datafeed should begin, which can be specified by using the same formats as the `end` parameter.\nThis value is inclusive.\nIf you do not specify a start time and the datafeed is associated with a new anomaly detection job, the analysis\nstarts from the earliest time for which data is available.\nIf you restart a stopped datafeed and specify a start value that is earlier than the timestamp of the latest\nprocessed record, the datafeed continues from 1 millisecond after the timestamp of the latest processed record.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.DateTime"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "timeout",
+ "description": "Specifies the amount of time to wait until a datafeed starts.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "end": {
+ "description": "Refer to the description for the `end` query parameter.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "start": {
+ "description": "Refer to the description for the `start` query parameter.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "timeout": {
+ "description": "Refer to the description for the `timeout` query parameter.",
+ "default": "20s",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "MlStartDatafeedExample1": {
+ "description": "An example body for a `POST _ml/datafeeds/datafeed-low_request_rate/_start` request.",
+ "value": "{\n \"start\": \"2019-04-07T18:22:16Z\"\n}"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "node": {
+ "description": "The ID of the node that the job was started on. In serverless this will be the \"serverless\".\nIf the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.NodeIds"
+ }
+ ]
+ },
+ "started": {
+ "description": "For a successful response, this value is always `true`. On failure, an exception is returned instead.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "node",
+ "started"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _ml/datafeeds/datafeed-low_request_rate/_start\n{\n \"start\": \"2019-04-07T18:22:16Z\"\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.ml.start_datafeed(\n datafeed_id=\"datafeed-low_request_rate\",\n start=\"2019-04-07T18:22:16Z\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.ml.startDatafeed({\n datafeed_id: \"datafeed-low_request_rate\",\n start: \"2019-04-07T18:22:16Z\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.ml.start_datafeed(\n datafeed_id: \"datafeed-low_request_rate\",\n body: {\n \"start\": \"2019-04-07T18:22:16Z\"\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->ml()->startDatafeed([\n \"datafeed_id\" => \"datafeed-low_request_rate\",\n \"body\" => [\n \"start\" => \"2019-04-07T18:22:16Z\",\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"start\":\"2019-04-07T18:22:16Z\"}' \"$ELASTICSEARCH_URL/_ml/datafeeds/datafeed-low_request_rate/_start\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.ml().startDatafeed(s -> s\n .datafeedId(\"datafeed-low_request_rate\")\n .start(DateTime.of(\"2019-04-07T18:22:16Z\"))\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch, Machine Learning",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_ml/trained_models/{model_id}/deployment/_start": {
+ "post": {
+ "tags": [
+ "ml trained model"
+ ],
+ "summary": "Start a trained model deployment",
+ "description": "It allocates the model to every machine learning node.\n\n## Required authorization\n\n* Cluster privileges: `manage_ml`\n",
+ "operationId": "ml-start-trained-model-deployment",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "model_id",
+ "description": "The unique identifier of the trained model. Currently, only PyTorch models are supported.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "cache_size",
+ "description": "The inference cache size (in memory outside the JVM heap) per node for the model.\nThe default value is the same size as the `model_size_bytes`. To disable the cache,\n`0b` can be provided.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "number_of_allocations",
+ "description": "The number of model allocations on each node where the model is deployed.\nAll allocations on a node share the same copy of the model in memory but use\na separate set of threads to evaluate the model.\nIncreasing this value generally increases the throughput.\nIf this setting is greater than the number of hardware threads\nit will automatically be changed to a value less than the number of hardware threads.\nIf adaptive_allocations is enabled, do not set this value, because it’s automatically set.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "priority",
+ "description": "The deployment priority.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/ml._types.TrainingPriority"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "queue_capacity",
+ "description": "Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds\nthis value, new requests are rejected with a 429 error.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "threads_per_allocation",
+ "description": "Sets the number of threads used by each model allocation during inference. This generally increases\nthe inference speed. The inference process is a compute-bound process; any number\ngreater than the number of available hardware threads on the machine does not increase the\ninference speed. If this setting is greater than the number of hardware threads\nit will automatically be changed to a value less than the number of hardware threads.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "timeout",
+ "description": "Specifies the amount of time to wait for the model to deploy.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "wait_for",
+ "description": "Specifies the allocation status to wait for before returning.\n\nSupported values include:\n - `started`: The trained model is started on at least one node.\n - `starting`: Trained model deployment is starting but it is not yet deployed on any nodes.\n - `fully_allocated`: Trained model deployment has started on all valid nodes.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/ml._types.DeploymentAllocationState"
+ },
+ "style": "form"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "adaptive_allocations": {
+ "description": "Adaptive allocations configuration. When enabled, the number of allocations\nis set based on the current load.\nIf adaptive_allocations is enabled, do not set the number of allocations manually.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.AdaptiveAllocationsSettings"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "assignment": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TrainedModelAssignment"
+ }
+ ]
+ }
+ },
+ "required": [
+ "assignment"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_start?wait_for=started&timeout=1m\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.ml.start_trained_model_deployment(\n model_id=\"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n wait_for=\"started\",\n timeout=\"1m\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.ml.startTrainedModelDeployment({\n model_id: \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n wait_for: \"started\",\n timeout: \"1m\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.ml.start_trained_model_deployment(\n model_id: \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n wait_for: \"started\",\n timeout: \"1m\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->ml()->startTrainedModelDeployment([\n \"model_id\" => \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n \"wait_for\" => \"started\",\n \"timeout\" => \"1m\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_start?wait_for=started&timeout=1m\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.ml().startTrainedModelDeployment(s -> s\n .modelId(\"elastic__distilbert-base-uncased-finetuned-conll03-english\")\n .timeout(t -> t\n .offset(1)\n )\n .waitFor(DeploymentAllocationState.Started)\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch, Machine Learning",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_ml/data_frame/analytics/{id}/_stop": {
+ "post": {
+ "tags": [
+ "ml data frame"
+ ],
+ "summary": "Stop data frame analytics jobs",
+ "description": "A data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.\n\n## Required authorization\n\n* Cluster privileges: `manage_ml`\n",
+ "operationId": "ml-stop-data-frame-analytics",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "id",
+ "description": "Identifier for the data frame analytics job. This identifier can contain\nlowercase alphanumeric characters (a-z and 0-9), hyphens, and\nunderscores. It must start and end with alphanumeric characters.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "allow_no_match",
+ "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no data frame analytics\njobs that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is true, which returns an empty data_frame_analytics\narray when there are no matches and the subset of results when there are\npartial matches. If this parameter is false, the request returns a 404\nstatus code when there are no matches or only partial matches.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "force",
+ "description": "If true, the data frame analytics job is stopped forcefully.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "timeout",
+ "description": "Controls the amount of time to wait until the data frame analytics job\nstops. Defaults to 20 seconds.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "stopped": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "stopped"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _ml/data_frame/analytics/loganalytics/_stop\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.ml.stop_data_frame_analytics(\n id=\"loganalytics\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.ml.stopDataFrameAnalytics({\n id: \"loganalytics\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.ml.stop_data_frame_analytics(\n id: \"loganalytics\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->ml()->stopDataFrameAnalytics([\n \"id\" => \"loganalytics\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_ml/data_frame/analytics/loganalytics/_stop\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.ml().stopDataFrameAnalytics(s -> s\n .id(\"loganalytics\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch, Machine Learning",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_ml/datafeeds/{datafeed_id}/_stop": {
+ "post": {
+ "tags": [
+ "ml anomaly"
+ ],
+ "summary": "Stop datafeeds",
+ "description": "A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.\n\n## Required authorization\n\n* Cluster privileges: `manage_ml`\n",
+ "operationId": "ml-stop-datafeed",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "datafeed_id",
+ "description": "Identifier for the datafeed. You can stop multiple datafeeds in a single API request by using a comma-separated\nlist of datafeeds or a wildcard expression. You can close all datafeeds by using `_all` or by specifying `*` as\nthe identifier.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "allow_no_match",
+ "description": "Specifies what to do when the request:\n\n* Contains wildcard expressions and there are no datafeeds that match.\n* Contains the `_all` string or no identifiers and there are no matches.\n* Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when\nthere are partial matches. If `false`, the API returns a 404 status code when there are no matches or only\npartial matches.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "force",
+ "description": "If `true`, the datafeed is stopped forcefully.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "timeout",
+ "description": "Specifies the amount of time to wait until a datafeed stops.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "allow_no_match": {
+ "description": "Refer to the description for the `allow_no_match` query parameter.",
+ "default": true,
+ "type": "boolean"
+ },
+ "force": {
+ "description": "Refer to the description for the `force` query parameter.",
+ "default": false,
+ "type": "boolean"
+ },
+ "timeout": {
+ "description": "Refer to the description for the `timeout` query parameter.",
+ "default": "20s",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "MlStopDatafeedExample1": {
+ "description": "An example body for a `POST _ml/datafeeds/datafeed-low_request_rate/_stop` request.",
+ "value": "{\n \"timeout\": \"30s\"\n}"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "stopped": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "stopped"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _ml/datafeeds/datafeed-low_request_rate/_stop\n{\n \"timeout\": \"30s\"\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.ml.stop_datafeed(\n datafeed_id=\"datafeed-low_request_rate\",\n timeout=\"30s\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.ml.stopDatafeed({\n datafeed_id: \"datafeed-low_request_rate\",\n timeout: \"30s\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.ml.stop_datafeed(\n datafeed_id: \"datafeed-low_request_rate\",\n body: {\n \"timeout\": \"30s\"\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->ml()->stopDatafeed([\n \"datafeed_id\" => \"datafeed-low_request_rate\",\n \"body\" => [\n \"timeout\" => \"30s\",\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"timeout\":\"30s\"}' \"$ELASTICSEARCH_URL/_ml/datafeeds/datafeed-low_request_rate/_stop\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.ml().stopDatafeed(s -> s\n .datafeedId(\"datafeed-low_request_rate\")\n .timeout(t -> t\n .time(\"30s\")\n )\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch, Machine Learning",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_ml/trained_models/{model_id}/deployment/_stop": {
+ "post": {
+ "tags": [
+ "ml trained model"
+ ],
+ "summary": "Stop a trained model deployment",
+ "description": "\n\n## Required authorization\n\n* Cluster privileges: `manage_ml`\n",
+ "operationId": "ml-stop-trained-model-deployment",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "model_id",
+ "description": "The unique identifier of the trained model.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "allow_no_match",
+ "description": "Specifies what to do when the request: contains wildcard expressions and there are no deployments that match;\ncontains the `_all` string or no identifiers and there are no matches; or contains wildcard expressions and\nthere are only partial matches. By default, it returns an empty array when there are no matches and the subset of results when there are partial matches.\nIf `false`, the request returns a 404 status code when there are no matches or only partial matches.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "force",
+ "description": "Forcefully stops the deployment, even if it is used by ingest pipelines. You can't use these pipelines until you\nrestart the model deployment.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "stopped": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "stopped"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _ml/trained_models/my_model_for_search/deployment/_stop\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.ml.stop_trained_model_deployment(\n model_id=\"my_model_for_search\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.ml.stopTrainedModelDeployment({\n model_id: \"my_model_for_search\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.ml.stop_trained_model_deployment(\n model_id: \"my_model_for_search\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->ml()->stopTrainedModelDeployment([\n \"model_id\" => \"my_model_for_search\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_ml/trained_models/my_model_for_search/deployment/_stop\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.ml().stopTrainedModelDeployment(s -> s\n .modelId(\"my_model_for_search\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch, Machine Learning",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_ml/data_frame/analytics/{id}/_update": {
+ "post": {
+ "tags": [
+ "ml data frame"
+ ],
+ "summary": "Update a data frame analytics job",
+ "description": "\n\n## Required authorization\n\n* Index privileges: `read`,`create_index`,`manage`,`index`,`view_index_metadata`\n* Cluster privileges: `manage_ml`\n",
+ "operationId": "ml-update-data-frame-analytics",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "id",
+ "description": "Identifier for the data frame analytics job. This identifier can contain\nlowercase alphanumeric characters (a-z and 0-9), hyphens, and\nunderscores. It must start and end with alphanumeric characters.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "A description of the job.",
+ "type": "string"
+ },
+ "model_memory_limit": {
+ "description": "The approximate maximum amount of memory resources that are permitted for\nanalytical processing. If your `elasticsearch.yml` file contains an\n`xpack.ml.max_model_memory_limit` setting, an error occurs when you try\nto create data frame analytics jobs that have `model_memory_limit` values\ngreater than that setting.",
+ "default": "1gb",
+ "type": "string"
+ },
+ "max_num_threads": {
+ "description": "The maximum number of threads to be used by the analysis. Using more\nthreads may decrease the time necessary to complete the analysis at the\ncost of using more CPU. Note that the process may use additional threads\nfor operational functionality other than the analysis itself.",
+ "default": 1.0,
+ "type": "number"
+ },
+ "allow_lazy_start": {
+ "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node.",
+ "default": false,
+ "type": "boolean"
+ }
+ }
+ },
+ "examples": {
+ "MlUpdateDataFrameAnalyticsExample1": {
+ "description": "An example body for a `POST _ml/data_frame/analytics/loganalytics/_update` request.",
+ "value": "{\n \"model_memory_limit\": \"200mb\"\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "authorization": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalyticsAuthorization"
+ }
+ ]
+ },
+ "allow_lazy_start": {
+ "type": "boolean"
+ },
+ "analysis": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer"
+ }
+ ]
+ },
+ "analyzed_fields": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields"
+ }
+ ]
+ },
+ "create_time": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "dest": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalyticsDestination"
+ }
+ ]
+ },
+ "id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "max_num_threads": {
+ "type": "number"
+ },
+ "model_memory_limit": {
+ "type": "string"
+ },
+ "source": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource"
+ }
+ ]
+ },
+ "version": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ }
+ },
+ "required": [
+ "allow_lazy_start",
+ "analysis",
+ "create_time",
+ "dest",
+ "id",
+ "max_num_threads",
+ "model_memory_limit",
+ "source",
+ "version"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _ml/data_frame/analytics/loganalytics/_update\n{\n \"model_memory_limit\": \"200mb\"\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.ml.update_data_frame_analytics(\n id=\"loganalytics\",\n model_memory_limit=\"200mb\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.ml.updateDataFrameAnalytics({\n id: \"loganalytics\",\n model_memory_limit: \"200mb\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.ml.update_data_frame_analytics(\n id: \"loganalytics\",\n body: {\n \"model_memory_limit\": \"200mb\"\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->ml()->updateDataFrameAnalytics([\n \"id\" => \"loganalytics\",\n \"body\" => [\n \"model_memory_limit\" => \"200mb\",\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"model_memory_limit\":\"200mb\"}' \"$ELASTICSEARCH_URL/_ml/data_frame/analytics/loganalytics/_update\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.ml().updateDataFrameAnalytics(u -> u\n .id(\"loganalytics\")\n .modelMemoryLimit(\"200mb\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch, Machine Learning",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_ml/datafeeds/{datafeed_id}/_update": {
+ "post": {
+ "tags": [
+ "ml anomaly"
+ ],
+ "summary": "Update a datafeed",
+ "description": "You must stop and start the datafeed for the changes to be applied.\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at\nthe time of the update and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.\n\n## Required authorization\n\n* Cluster privileges: `manage_ml`\n",
+ "operationId": "ml-update-datafeed",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "datafeed_id",
+ "description": "A numerical character string that uniquely identifies the datafeed.\nThis identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.\nIt must start and end with alphanumeric characters.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "allow_no_indices",
+ "description": "If `true`, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the\n`_all` string or when no indices are specified.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "expand_wildcards",
+ "description": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines\nwhether wildcard expressions match hidden data streams. Supports comma-separated values.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ExpandWildcards"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "ignore_throttled",
+ "description": "If `true`, concrete, expanded or aliased indices are ignored when frozen.",
+ "deprecated": true,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "ignore_unavailable",
+ "description": "If `true`, unavailable indices (missing or closed) are ignored.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "aggregations": {
+ "description": "If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only\nwith low cardinality data.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.AggregationContainer"
+ }
+ },
+ "chunking_config": {
+ "description": "Datafeeds might search over long time periods, for several months or years. This search is split into time\nchunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of\nthese time chunks are calculated; it is an advanced configuration option.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.ChunkingConfig"
+ }
+ ]
+ },
+ "delayed_data_check_config": {
+ "description": "Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally\nsearch over indices that have already been read in an effort to determine whether any data has subsequently been\nadded to the index. If missing data is found, it is a good indication that the `query_delay` is set too low and\nthe data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time\ndatafeeds.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig"
+ }
+ ]
+ },
+ "frequency": {
+ "description": "The interval at which scheduled queries are made while the datafeed runs in real time. The default value is\neither the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket\nspan. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are\nwritten then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value\nmust be divisible by the interval of the date histogram aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "indices": {
+ "description": "An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine\nlearning nodes must have the `remote_cluster_client` role.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "indices_options": {
+ "description": "Specifies index expansion options that are used during search.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndicesOptions"
+ }
+ ]
+ },
+ "job_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "max_empty_searches": {
+ "description": "If a real-time datafeed has never seen any data (including during any initial training period), it automatically\nstops and closes the associated job after this many real-time searches return no documents. In other words,\nit stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no\nend time that sees no data remains started until it is explicitly stopped. By default, it is not set.",
+ "type": "number"
+ },
+ "query": {
+ "description": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an\nElasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this\nobject is passed verbatim to Elasticsearch. Note that if you change the query, the analyzed data is also\nchanged. Therefore, the time required to learn might be long and the understandability of the results is\nunpredictable. If you want to make significant changes to the source data, it is recommended that you\nclone the job and datafeed and make the amendments in the clone. Let both run in parallel and close one\nwhen you are satisfied with the results of the job.",
+ "default": "{\"match_all\": {\"boost\": 1}}",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "query_delay": {
+ "description": "The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might\nnot be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default\nvalue is randomly selected between `60s` and `120s`. This randomness improves the query performance\nwhen there are multiple jobs running on the same node.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "runtime_mappings": {
+ "description": "Specifies runtime fields for the datafeed search.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RuntimeFields"
+ }
+ ]
+ },
+ "script_fields": {
+ "description": "Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.\nThe detector configuration objects in a job can contain functions that use these script fields.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.ScriptField"
+ }
+ },
+ "scroll_size": {
+ "description": "The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations.\nThe maximum value is the value of `index.max_result_window`.",
+ "default": 1000.0,
+ "type": "number"
+ }
+ }
+ },
+ "examples": {
+ "MlUpdateDatafeedExample1": {
+ "description": "An example body for a `POST _ml/datafeeds/datafeed-test-job/_update` request.",
+ "value": "{\n \"query\": {\n \"term\": {\n \"geo.src\": \"US\"\n }\n }\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "authorization": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DatafeedAuthorization"
+ }
+ ]
+ },
+ "aggregations": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.AggregationContainer"
+ }
+ },
+ "chunking_config": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.ChunkingConfig"
+ }
+ ]
+ },
+ "delayed_data_check_config": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig"
+ }
+ ]
+ },
+ "datafeed_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "frequency": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "indices": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "indices_options": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndicesOptions"
+ }
+ ]
+ },
+ "job_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "max_empty_searches": {
+ "type": "number"
+ },
+ "query": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "query_delay": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "runtime_mappings": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RuntimeFields"
+ }
+ ]
+ },
+ "script_fields": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.ScriptField"
+ }
+ },
+ "scroll_size": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "chunking_config",
+ "datafeed_id",
+ "indices",
+ "job_id",
+ "query",
+ "query_delay",
+ "scroll_size"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _ml/datafeeds/datafeed-test-job/_update\n{\n \"query\": {\n \"term\": {\n \"geo.src\": \"US\"\n }\n }\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.ml.update_datafeed(\n datafeed_id=\"datafeed-test-job\",\n query={\n \"term\": {\n \"geo.src\": \"US\"\n }\n },\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.ml.updateDatafeed({\n datafeed_id: \"datafeed-test-job\",\n query: {\n term: {\n \"geo.src\": \"US\",\n },\n },\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.ml.update_datafeed(\n datafeed_id: \"datafeed-test-job\",\n body: {\n \"query\": {\n \"term\": {\n \"geo.src\": \"US\"\n }\n }\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->ml()->updateDatafeed([\n \"datafeed_id\" => \"datafeed-test-job\",\n \"body\" => [\n \"query\" => [\n \"term\" => [\n \"geo.src\" => \"US\",\n ],\n ],\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"query\":{\"term\":{\"geo.src\":\"US\"}}}' \"$ELASTICSEARCH_URL/_ml/datafeeds/datafeed-test-job/_update\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.ml().updateDatafeed(u -> u\n .datafeedId(\"datafeed-test-job\")\n .query(q -> q\n .term(t -> t\n .field(\"geo.src\")\n .value(FieldValue.of(\"US\"))\n )\n )\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch, Machine Learning",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_ml/filters/{filter_id}/_update": {
+ "post": {
+ "tags": [
+ "ml anomaly"
+ ],
+ "summary": "Update a filter",
+ "description": "Updates the description of a filter, adds items, or removes items from the list.\n\n## Required authorization\n\n* Cluster privileges: `manage_ml`\n",
+ "operationId": "ml-update-filter",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "filter_id",
+ "description": "A string that uniquely identifies a filter.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "add_items": {
+ "description": "The items to add to the filter.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "description": "A description for the filter.",
+ "type": "string"
+ },
+ "remove_items": {
+ "description": "The items to remove from the filter.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "MlUpdateFilterExample1": {
+ "description": "An example body for a `POST _ml/filters/safe_domains/_update` request.",
+ "value": "{\n \"description\": \"Updated list of domains\",\n \"add_items\": [\"*.myorg.com\"],\n \"remove_items\": [\"wikipedia.org\"]\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "filter_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "description",
+ "filter_id",
+ "items"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _ml/filters/safe_domains/_update\n{\n \"description\": \"Updated list of domains\",\n \"add_items\": [\"*.myorg.com\"],\n \"remove_items\": [\"wikipedia.org\"]\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.ml.update_filter(\n filter_id=\"safe_domains\",\n description=\"Updated list of domains\",\n add_items=[\n \"*.myorg.com\"\n ],\n remove_items=[\n \"wikipedia.org\"\n ],\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.ml.updateFilter({\n filter_id: \"safe_domains\",\n description: \"Updated list of domains\",\n add_items: [\"*.myorg.com\"],\n remove_items: [\"wikipedia.org\"],\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.ml.update_filter(\n filter_id: \"safe_domains\",\n body: {\n \"description\": \"Updated list of domains\",\n \"add_items\": [\n \"*.myorg.com\"\n ],\n \"remove_items\": [\n \"wikipedia.org\"\n ]\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->ml()->updateFilter([\n \"filter_id\" => \"safe_domains\",\n \"body\" => [\n \"description\" => \"Updated list of domains\",\n \"add_items\" => array(\n \"*.myorg.com\",\n ),\n \"remove_items\" => array(\n \"wikipedia.org\",\n ),\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"description\":\"Updated list of domains\",\"add_items\":[\"*.myorg.com\"],\"remove_items\":[\"wikipedia.org\"]}' \"$ELASTICSEARCH_URL/_ml/filters/safe_domains/_update\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.ml().updateFilter(u -> u\n .addItems(\"*.myorg.com\")\n .description(\"Updated list of domains\")\n .filterId(\"safe_domains\")\n .removeItems(\"wikipedia.org\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch, Machine Learning",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_ml/anomaly_detectors/{job_id}/_update": {
+ "post": {
+ "tags": [
+ "ml anomaly"
+ ],
+ "summary": "Update an anomaly detection job",
+ "description": "Updates certain properties of an anomaly detection job.\n\n## Required authorization\n\n* Cluster privileges: `manage_ml`\n",
+ "operationId": "ml-update-job",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "job_id",
+ "description": "Identifier for the job.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "allow_lazy_open": {
+ "description": "Advanced configuration option. Specifies whether this job can open when\nthere is insufficient machine learning node capacity for it to be\nimmediately assigned to a node. If `false` and a machine learning node\nwith capacity to run the job cannot immediately be found, the open\nanomaly detection jobs API returns an error. However, this is also\nsubject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this\noption is set to `true`, the open anomaly detection jobs API does not\nreturn an error and the job waits in the opening state until sufficient\nmachine learning node capacity is available.",
+ "default": false,
+ "type": "boolean"
+ },
+ "analysis_limits": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.AnalysisMemoryLimit"
+ }
+ ]
+ },
+ "background_persist_interval": {
+ "description": "Advanced configuration option. The time between each periodic persistence\nof the model.\nThe default value is a randomized value between 3 to 4 hours, which\navoids all jobs persisting at exactly the same time. The smallest allowed\nvalue is 1 hour.\nFor very large models (several GB), persistence could take 10-20 minutes,\nso do not set the value too low.\nIf the job is open when you make the update, you must stop the datafeed,\nclose the job, then reopen the job and restart the datafeed for the\nchanges to take effect.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "custom_settings": {
+ "description": "Advanced configuration option. Contains custom meta data about the job.\nFor example, it can contain custom URL information as shown in Adding\ncustom URLs to machine learning results.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "categorization_filters": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "description": "A description of the job.",
+ "type": "string"
+ },
+ "model_plot_config": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.ModelPlotConfig"
+ }
+ ]
+ },
+ "model_prune_window": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "daily_model_snapshot_retention_after_days": {
+ "description": "Advanced configuration option, which affects the automatic removal of old\nmodel snapshots for this job. It specifies a period of time (in days)\nafter which only the first snapshot per day is retained. This period is\nrelative to the timestamp of the most recent snapshot for this job. Valid\nvalues range from 0 to `model_snapshot_retention_days`. For jobs created\nbefore version 7.8.0, the default value matches\n`model_snapshot_retention_days`.",
+ "default": 1.0,
+ "type": "number"
+ },
+ "model_snapshot_retention_days": {
+ "description": "Advanced configuration option, which affects the automatic removal of old\nmodel snapshots for this job. It specifies the maximum period of time (in\ndays) that snapshots are retained. This period is relative to the\ntimestamp of the most recent snapshot for this job.",
+ "default": 10.0,
+ "type": "number"
+ },
+ "renormalization_window_days": {
+ "description": "Advanced configuration option. The period over which adjustments to the\nscore are applied, as new data is seen.",
+ "type": "number"
+ },
+ "results_retention_days": {
+ "description": "Advanced configuration option. The period of time (in days) that results\nare retained. Age is calculated relative to the timestamp of the latest\nbucket result. If this property has a non-null value, once per day at\n00:30 (server time), results that are the specified number of days older\nthan the latest bucket result are deleted from Elasticsearch. The default\nvalue is null, which means all results are retained.",
+ "type": "number"
+ },
+ "groups": {
+ "description": "A list of job groups. A job can belong to no groups or many.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "detectors": {
+ "description": "An array of detector update objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.DetectorUpdate"
+ }
+ },
+ "per_partition_categorization": {
+ "description": "Settings related to how categorization interacts with partition fields.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.PerPartitionCategorization"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "MlUpdateJobExample1": {
+ "description": "An example body for a `POST _ml/anomaly_detectors/low_request_rate/_update` request.",
+ "value": "{\n \"description\":\"An updated job\",\n \"detectors\": {\n \"detector_index\": 0,\n \"description\": \"An updated detector description\"\n },\n \"groups\": [\"kibana_sample_data\",\"kibana_sample_web_logs\"],\n \"model_plot_config\": {\n \"enabled\": true\n },\n \"renormalization_window_days\": 30,\n \"background_persist_interval\": \"2h\",\n \"model_snapshot_retention_days\": 7,\n \"results_retention_days\": 60\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "allow_lazy_open": {
+ "type": "boolean"
+ },
+ "analysis_config": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.AnalysisConfigRead"
+ }
+ ]
+ },
+ "analysis_limits": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.AnalysisLimits"
+ }
+ ]
+ },
+ "background_persist_interval": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "create_time": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "finished_time": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "custom_settings": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "daily_model_snapshot_retention_after_days": {
+ "type": "number"
+ },
+ "data_description": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataDescription"
+ }
+ ]
+ },
+ "datafeed_config": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.Datafeed"
+ }
+ ]
+ },
+ "description": {
+ "type": "string"
+ },
+ "groups": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "job_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "job_type": {
+ "type": "string"
+ },
+ "job_version": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ },
+ "model_plot_config": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.ModelPlotConfig"
+ }
+ ]
+ },
+ "model_snapshot_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "model_snapshot_retention_days": {
+ "type": "number"
+ },
+ "renormalization_window_days": {
+ "type": "number"
+ },
+ "results_index_name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "results_retention_days": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "allow_lazy_open",
+ "analysis_config",
+ "analysis_limits",
+ "create_time",
+ "daily_model_snapshot_retention_after_days",
+ "data_description",
+ "job_id",
+ "job_type",
+ "job_version",
+ "model_snapshot_retention_days",
+ "results_index_name"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _ml/anomaly_detectors/low_request_rate/_update\n{\n \"description\":\"An updated job\",\n \"detectors\": {\n \"detector_index\": 0,\n \"description\": \"An updated detector description\"\n },\n \"groups\": [\"kibana_sample_data\",\"kibana_sample_web_logs\"],\n \"model_plot_config\": {\n \"enabled\": true\n },\n \"renormalization_window_days\": 30,\n \"background_persist_interval\": \"2h\",\n \"model_snapshot_retention_days\": 7,\n \"results_retention_days\": 60\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.ml.update_job(\n job_id=\"low_request_rate\",\n description=\"An updated job\",\n detectors={\n \"detector_index\": 0,\n \"description\": \"An updated detector description\"\n },\n groups=[\n \"kibana_sample_data\",\n \"kibana_sample_web_logs\"\n ],\n model_plot_config={\n \"enabled\": True\n },\n renormalization_window_days=30,\n background_persist_interval=\"2h\",\n model_snapshot_retention_days=7,\n results_retention_days=60,\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.ml.updateJob({\n job_id: \"low_request_rate\",\n description: \"An updated job\",\n detectors: {\n detector_index: 0,\n description: \"An updated detector description\",\n },\n groups: [\"kibana_sample_data\", \"kibana_sample_web_logs\"],\n model_plot_config: {\n enabled: true,\n },\n renormalization_window_days: 30,\n background_persist_interval: \"2h\",\n model_snapshot_retention_days: 7,\n results_retention_days: 60,\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.ml.update_job(\n job_id: \"low_request_rate\",\n body: {\n \"description\": \"An updated job\",\n \"detectors\": {\n \"detector_index\": 0,\n \"description\": \"An updated detector description\"\n },\n \"groups\": [\n \"kibana_sample_data\",\n \"kibana_sample_web_logs\"\n ],\n \"model_plot_config\": {\n \"enabled\": true\n },\n \"renormalization_window_days\": 30,\n \"background_persist_interval\": \"2h\",\n \"model_snapshot_retention_days\": 7,\n \"results_retention_days\": 60\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->ml()->updateJob([\n \"job_id\" => \"low_request_rate\",\n \"body\" => [\n \"description\" => \"An updated job\",\n \"detectors\" => [\n \"detector_index\" => 0,\n \"description\" => \"An updated detector description\",\n ],\n \"groups\" => array(\n \"kibana_sample_data\",\n \"kibana_sample_web_logs\",\n ),\n \"model_plot_config\" => [\n \"enabled\" => true,\n ],\n \"renormalization_window_days\" => 30,\n \"background_persist_interval\" => \"2h\",\n \"model_snapshot_retention_days\" => 7,\n \"results_retention_days\" => 60,\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"description\":\"An updated job\",\"detectors\":{\"detector_index\":0,\"description\":\"An updated detector description\"},\"groups\":[\"kibana_sample_data\",\"kibana_sample_web_logs\"],\"model_plot_config\":{\"enabled\":true},\"renormalization_window_days\":30,\"background_persist_interval\":\"2h\",\"model_snapshot_retention_days\":7,\"results_retention_days\":60}' \"$ELASTICSEARCH_URL/_ml/anomaly_detectors/low_request_rate/_update\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.ml().updateJob(u -> u\n .backgroundPersistInterval(b -> b\n .time(\"2h\")\n )\n .description(\"An updated job\")\n .detectors(d -> d\n .detectorIndex(0)\n .description(\"An updated detector description\")\n )\n .groups(List.of(\"kibana_sample_data\",\"kibana_sample_web_logs\"))\n .jobId(\"low_request_rate\")\n .modelPlotConfig(m -> m\n .enabled(true)\n )\n .modelSnapshotRetentionDays(7L)\n .renormalizationWindowDays(30L)\n .resultsRetentionDays(60L)\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch, Machine Learning",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_ml/trained_models/{model_id}/deployment/_update": {
+ "post": {
+ "tags": [
+ "ml trained model"
+ ],
+ "summary": "Update a trained model deployment",
+ "description": "\n\n## Required authorization\n\n* Cluster privileges: `manage_ml`\n",
+ "operationId": "ml-update-trained-model-deployment",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "model_id",
+ "description": "The unique identifier of the trained model. Currently, only PyTorch models are supported.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "number_of_allocations",
+ "description": "The number of model allocations on each node where the model is deployed.\nAll allocations on a node share the same copy of the model in memory but use\na separate set of threads to evaluate the model.\nIncreasing this value generally increases the throughput.\nIf this setting is greater than the number of hardware threads\nit will automatically be changed to a value less than the number of hardware threads.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "number_of_allocations": {
+ "description": "The number of model allocations on each node where the model is deployed.\nAll allocations on a node share the same copy of the model in memory but use\na separate set of threads to evaluate the model.\nIncreasing this value generally increases the throughput.\nIf this setting is greater than the number of hardware threads\nit will automatically be changed to a value less than the number of hardware threads.\nIf adaptive_allocations is enabled, do not set this value, because it’s automatically set.",
+ "default": 1.0,
+ "type": "number"
+ },
+ "adaptive_allocations": {
+ "description": "Adaptive allocations configuration. When enabled, the number of allocations\nis set based on the current load.\nIf adaptive_allocations is enabled, do not set the number of allocations manually.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.AdaptiveAllocationsSettings"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "MlUpdateTrainedModelDeploymentExample1": {
+ "description": "An example body for a `POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_update` request.",
+ "value": "{\n \"number_of_allocations\": 4\n}"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "assignment": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TrainedModelAssignment"
+ }
+ ]
+ }
+ },
+ "required": [
+ "assignment"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Beta",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_update\n{\n \"number_of_allocations\": 4\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.ml.update_trained_model_deployment(\n model_id=\"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n number_of_allocations=4,\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.ml.updateTrainedModelDeployment({\n model_id: \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n number_of_allocations: 4,\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.ml.update_trained_model_deployment(\n model_id: \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n body: {\n \"number_of_allocations\": 4\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->ml()->updateTrainedModelDeployment([\n \"model_id\" => \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n \"body\" => [\n \"number_of_allocations\" => 4,\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"number_of_allocations\":4}' \"$ELASTICSEARCH_URL/_ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_update\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.ml().updateTrainedModelDeployment(u -> u\n .modelId(\"elastic__distilbert-base-uncased-finetuned-conll03-english\")\n .numberOfAllocations(4)\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch, Machine Learning",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/{index}/_msearch": {
+ "post": {
+ "tags": [
+ "search"
+ ],
+ "summary": "Run multiple searches\n",
+ "description": "**All methods and paths for this operation:**\n\n\n GET\n /_msearch\n
\n \n POST\n /_msearch\n
\n \n GET\n /{index}/_msearch\n
\n \n POST\n /{index}/_msearch\n
\n \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`.\n\n## Required authorization\n\n* Index privileges: `read`\n",
+ "operationId": "msearch",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/msearch-index"
+ },
+ {
+ "$ref": "#/components/parameters/msearch-allow_no_indices"
+ },
+ {
+ "$ref": "#/components/parameters/msearch-ccs_minimize_roundtrips"
+ },
+ {
+ "$ref": "#/components/parameters/msearch-expand_wildcards"
+ },
+ {
+ "$ref": "#/components/parameters/msearch-ignore_throttled"
+ },
+ {
+ "$ref": "#/components/parameters/msearch-ignore_unavailable"
+ },
+ {
+ "$ref": "#/components/parameters/msearch-include_named_queries_score"
+ },
+ {
+ "$ref": "#/components/parameters/msearch-index_"
+ },
+ {
+ "$ref": "#/components/parameters/msearch-max_concurrent_searches"
+ },
+ {
+ "$ref": "#/components/parameters/msearch-max_concurrent_shard_requests"
+ },
+ {
+ "$ref": "#/components/parameters/msearch-pre_filter_shard_size"
+ },
+ {
+ "$ref": "#/components/parameters/msearch-rest_total_hits_as_int"
+ },
+ {
+ "$ref": "#/components/parameters/msearch-routing"
+ },
+ {
+ "$ref": "#/components/parameters/msearch-search_type"
+ },
+ {
+ "$ref": "#/components/parameters/msearch-typed_keys"
+ }
+ ],
+ "requestBody": {
+ "$ref": "#/components/requestBodies/msearch"
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/msearch-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET my-index-000001/_msearch\n{ }\n{\"query\" : {\"match\" : { \"message\": \"this is a test\"}}}\n{\"index\": \"my-index-000002\"}\n{\"query\" : {\"match_all\" : {}}}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.msearch(\n index=\"my-index-000001\",\n searches=[\n {},\n {\n \"query\": {\n \"match\": {\n \"message\": \"this is a test\"\n }\n }\n },\n {\n \"index\": \"my-index-000002\"\n },\n {\n \"query\": {\n \"match_all\": {}\n }\n }\n ],\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.msearch({\n index: \"my-index-000001\",\n searches: [\n {},\n {\n query: {\n match: {\n message: \"this is a test\",\n },\n },\n },\n {\n index: \"my-index-000002\",\n },\n {\n query: {\n match_all: {},\n },\n },\n ],\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.msearch(\n index: \"my-index-000001\",\n body: [\n {},\n {\n \"query\": {\n \"match\": {\n \"message\": \"this is a test\"\n }\n }\n },\n {\n \"index\": \"my-index-000002\"\n },\n {\n \"query\": {\n \"match_all\": {}\n }\n }\n ]\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->msearch([\n \"index\" => \"my-index-000001\",\n \"body\" => array(\n new ArrayObject([]),\n [\n \"query\" => [\n \"match\" => [\n \"message\" => \"this is a test\",\n ],\n ],\n ],\n [\n \"index\" => \"my-index-000002\",\n ],\n [\n \"query\" => [\n \"match_all\" => new ArrayObject([]),\n ],\n ],\n ),\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '[{},{\"query\":{\"match\":{\"message\":\"this is a test\"}}},{\"index\":\"my-index-000002\"},{\"query\":{\"match_all\":{}}}]' \"$ELASTICSEARCH_URL/my-index-000001/_msearch\""
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/{index}/_msearch/template": {
+ "post": {
+ "tags": [
+ "search"
+ ],
+ "summary": "Run multiple templated searches\n",
+ "description": "**All methods and paths for this operation:**\n\n\n GET\n /_msearch/template\n
\n \n POST\n /_msearch/template\n
\n \n GET\n /{index}/_msearch/template\n
\n \n POST\n /{index}/_msearch/template\n
\n \n\nRun multiple templated searches with a single request.\nIf you are providing a text file or text input to `curl`, use the `--data-binary` flag instead of `-d` to preserve newlines.\nFor example:\n\n```\n$ cat requests\n{ \"index\": \"my-index\" }\n{ \"id\": \"my-search-template\", \"params\": { \"query_string\": \"hello world\", \"from\": 0, \"size\": 10 }}\n{ \"index\": \"my-other-index\" }\n{ \"id\": \"my-other-search-template\", \"params\": { \"query_type\": \"match_all\" }}\n\n$ curl -H \"Content-Type: application/x-ndjson\" -XGET localhost:9200/_msearch/template --data-binary \"@requests\"; echo\n```\n\n## Required authorization\n\n* Index privileges: `read`\n",
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/solutions/search/search-templates",
+ "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/multi-search-template.html"
+ },
+ "operationId": "msearch-template",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/msearch_template-index"
+ },
+ {
+ "$ref": "#/components/parameters/msearch_template-ccs_minimize_roundtrips"
+ },
+ {
+ "$ref": "#/components/parameters/msearch_template-max_concurrent_searches"
+ },
+ {
+ "$ref": "#/components/parameters/msearch_template-search_type"
+ },
+ {
+ "$ref": "#/components/parameters/msearch_template-rest_total_hits_as_int"
+ },
+ {
+ "$ref": "#/components/parameters/msearch_template-typed_keys"
+ }
+ ],
+ "requestBody": {
+ "$ref": "#/components/requestBodies/msearch_template"
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/msearch_template-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET my-index/_msearch/template\n{ }\n{ \"id\": \"my-search-template\", \"params\": { \"query_string\": \"hello world\", \"from\": 0, \"size\": 10 }}\n{ }\n{ \"id\": \"my-other-search-template\", \"params\": { \"query_type\": \"match_all\" }}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.msearch_template(\n index=\"my-index\",\n search_templates=[\n {},\n {\n \"id\": \"my-search-template\",\n \"params\": {\n \"query_string\": \"hello world\",\n \"from\": 0,\n \"size\": 10\n }\n },\n {},\n {\n \"id\": \"my-other-search-template\",\n \"params\": {\n \"query_type\": \"match_all\"\n }\n }\n ],\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.msearchTemplate({\n index: \"my-index\",\n search_templates: [\n {},\n {\n id: \"my-search-template\",\n params: {\n query_string: \"hello world\",\n from: 0,\n size: 10,\n },\n },\n {},\n {\n id: \"my-other-search-template\",\n params: {\n query_type: \"match_all\",\n },\n },\n ],\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.msearch_template(\n index: \"my-index\",\n body: [\n {},\n {\n \"id\": \"my-search-template\",\n \"params\": {\n \"query_string\": \"hello world\",\n \"from\": 0,\n \"size\": 10\n }\n },\n {},\n {\n \"id\": \"my-other-search-template\",\n \"params\": {\n \"query_type\": \"match_all\"\n }\n }\n ]\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->msearchTemplate([\n \"index\" => \"my-index\",\n \"body\" => array(\n new ArrayObject([]),\n [\n \"id\" => \"my-search-template\",\n \"params\" => [\n \"query_string\" => \"hello world\",\n \"from\" => 0,\n \"size\" => 10,\n ],\n ],\n new ArrayObject([]),\n [\n \"id\" => \"my-other-search-template\",\n \"params\" => [\n \"query_type\" => \"match_all\",\n ],\n ],\n ),\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '[{},{\"id\":\"my-search-template\",\"params\":{\"query_string\":\"hello world\",\"from\":0,\"size\":10}},{},{\"id\":\"my-other-search-template\",\"params\":{\"query_type\":\"match_all\"}}]' \"$ELASTICSEARCH_URL/my-index/_msearch/template\""
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/{index}/_mtermvectors": {
+ "post": {
+ "tags": [
+ "document"
+ ],
+ "summary": "Get multiple term vectors\n",
+ "description": "**All methods and paths for this operation:**\n\n\n GET\n /_mtermvectors\n
\n \n POST\n /_mtermvectors\n
\n \n GET\n /{index}/_mtermvectors\n
\n \n POST\n /{index}/_mtermvectors\n
\n \n\nGet multiple term vectors with a single request.\nYou can specify existing documents by index and ID or provide artificial documents in the body of the request.\nYou can specify the index in the request body or request URI.\nThe response contains a `docs` array with all the fetched termvectors.\nEach element has the structure provided by the termvectors API.\n\n**Artificial documents**\n\nYou can also use `mtermvectors` to generate term vectors for artificial documents provided in the body of the request.\nThe mapping used is determined by the specified `_index`.\n\n## Required authorization\n\n* Index privileges: `read`\n",
+ "operationId": "mtermvectors",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/mtermvectors-index"
+ },
+ {
+ "$ref": "#/components/parameters/mtermvectors-ids"
+ },
+ {
+ "$ref": "#/components/parameters/mtermvectors-fields"
+ },
+ {
+ "$ref": "#/components/parameters/mtermvectors-field_statistics"
+ },
+ {
+ "$ref": "#/components/parameters/mtermvectors-offsets"
+ },
+ {
+ "$ref": "#/components/parameters/mtermvectors-payloads"
+ },
+ {
+ "$ref": "#/components/parameters/mtermvectors-positions"
+ },
+ {
+ "$ref": "#/components/parameters/mtermvectors-preference"
+ },
+ {
+ "$ref": "#/components/parameters/mtermvectors-realtime"
+ },
+ {
+ "$ref": "#/components/parameters/mtermvectors-routing"
+ },
+ {
+ "$ref": "#/components/parameters/mtermvectors-term_statistics"
+ },
+ {
+ "$ref": "#/components/parameters/mtermvectors-version"
+ },
+ {
+ "$ref": "#/components/parameters/mtermvectors-version_type"
+ }
+ ],
+ "requestBody": {
+ "$ref": "#/components/requestBodies/mtermvectors"
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/mtermvectors-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST /my-index-000001/_mtermvectors\n{\n \"docs\": [\n {\n \"_id\": \"2\",\n \"fields\": [\n \"message\"\n ],\n \"term_statistics\": true\n },\n {\n \"_id\": \"1\"\n }\n ]\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.mtermvectors(\n index=\"my-index-000001\",\n docs=[\n {\n \"_id\": \"2\",\n \"fields\": [\n \"message\"\n ],\n \"term_statistics\": True\n },\n {\n \"_id\": \"1\"\n }\n ],\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.mtermvectors({\n index: \"my-index-000001\",\n docs: [\n {\n _id: \"2\",\n fields: [\"message\"],\n term_statistics: true,\n },\n {\n _id: \"1\",\n },\n ],\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.mtermvectors(\n index: \"my-index-000001\",\n body: {\n \"docs\": [\n {\n \"_id\": \"2\",\n \"fields\": [\n \"message\"\n ],\n \"term_statistics\": true\n },\n {\n \"_id\": \"1\"\n }\n ]\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->mtermvectors([\n \"index\" => \"my-index-000001\",\n \"body\" => [\n \"docs\" => array(\n [\n \"_id\" => \"2\",\n \"fields\" => array(\n \"message\",\n ),\n \"term_statistics\" => true,\n ],\n [\n \"_id\" => \"1\",\n ],\n ),\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"docs\":[{\"_id\":\"2\",\"fields\":[\"message\"],\"term_statistics\":true},{\"_id\":\"1\"}]}' \"$ELASTICSEARCH_URL/my-index-000001/_mtermvectors\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.mtermvectors(m -> m\n .docs(List.of(MultiTermVectorsOperation.of(mu -> mu\n .id(\"2\")\n .fields(\"message\")\n .termStatistics(true)),MultiTermVectorsOperation.of(mu -> mu\n .id(\"1\"))))\n .index(\"my-index-000001\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/{index}/_pit": {
+ "post": {
+ "tags": [
+ "search"
+ ],
+ "summary": "Open a point in time",
+ "description": "A search request by default runs against the most recent visible data of the target indices,\nwhich is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.\n\nA point in time must be opened explicitly before being used in search requests.\n\nA subsequent search request with the `pit` parameter must not specify `index`, `routing`, or `preference` values as these parameters are copied from the point in time.\n\nJust like regular searches, you can use `from` and `size` to page through point in time search results, up to the first 10,000 hits.\nIf you want to retrieve more hits, use PIT with `search_after`.\n\nIMPORTANT: The open point in time request and each subsequent search request can return different identifiers; always use the most recently received ID for the next search request.\n\nWhen a PIT that contains shard failures is used in a search request, the missing are always reported in the search response as a `NoShardAvailableActionException` exception.\nTo get rid of these exceptions, a new PIT needs to be created so that shards missing from the previous PIT can be handled, assuming they become available in the meantime.\n\n**Keeping point in time alive**\n\nThe `keep_alive` parameter, which is passed to a open point in time request and search request, extends the time to live of the corresponding point in time.\nThe value does not need to be long enough to process all data — it just needs to be long enough for the next request.\n\nNormally, the background merge process optimizes the index by merging together smaller segments to create new, bigger segments.\nOnce the smaller segments are no longer needed they are deleted.\nHowever, open point-in-times prevent the old segments from being deleted since they are still in use.\n\nTIP: Keeping older segments alive means that more disk space and file handles are needed.\nEnsure that you have configured your nodes to have ample free file handles.\n\nAdditionally, if a segment contains deleted or updated documents then the point in time must keep track of whether each document in the segment was live at the time of the initial search request.\nEnsure that your nodes have sufficient heap space if you have many open point-in-times on an index that is subject to ongoing deletes or updates.\nNote that a point-in-time doesn't prevent its associated indices from being deleted.\nYou can check how many point-in-times (that is, search contexts) are open with the nodes stats API.\n\n## Required authorization\n\n* Index privileges: `read`\n",
+ "operationId": "open-point-in-time",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "index",
+ "description": "A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "keep_alive",
+ "description": "Extend the length of time that the point in time persists.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "ignore_unavailable",
+ "description": "If `false`, the request returns an error if it targets a missing or closed index.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "preference",
+ "description": "The node or shard the operation should be performed on.\nBy default, it is random.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "routing",
+ "description": "A custom value that is used to route operations to a specific shard.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Routing"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "expand_wildcards",
+ "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`.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ExpandWildcards"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "allow_partial_search_results",
+ "description": "Indicates whether the point in time tolerates unavailable shards or shard failures when initially creating the PIT.\nIf `false`, creating a point in time request when a shard is missing or unavailable will throw an exception.\nIf `true`, the point in time will contain all the shards that are available at the time of the request.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "max_concurrent_shard_requests",
+ "description": "Maximum number of concurrent shard requests that each sub-search request executes per node.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "index_filter": {
+ "description": "Filter indices if the provided query rewrites to `match_none` on every shard.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "_shards": {
+ "description": "Shards used to create the PIT",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ShardStatistics"
+ }
+ ]
+ },
+ "id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ }
+ },
+ "required": [
+ "_shards",
+ "id"
+ ]
+ },
+ "examples": {
+ "OpenPointInTimeResponseExample1": {
+ "description": "A successful response from `POST /my-index-000001/_pit?keep_alive=1m&allow_partial_search_results=true`. It includes a summary of the total number of shards, as well as the number of successful shards when creating the PIT.\n",
+ "value": "{\n \"id\": \"46ToAwMDaWR5BXV1aWQyKwZub2RlXzMAAAAAAAAAACoBYwADaWR4BXV1aWQxAgZub2RlXzEAAAAAAAAAAAEBYQADaWR5BXV1aWQyKgZub2RlXzIAAAAAAAAAAAwBYgACBXV1aWQyAAAFdXVpZDEAAQltYXRjaF9hbGw_gAAAAA=\",\n \"_shards\": {\n \"total\": 10,\n \"successful\": 10,\n \"skipped\": 0,\n \"failed\": 0\n }\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST /my-index-000001/_pit?keep_alive=1m&allow_partial_search_results=true\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.open_point_in_time(\n index=\"my-index-000001\",\n keep_alive=\"1m\",\n allow_partial_search_results=True,\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.openPointInTime({\n index: \"my-index-000001\",\n keep_alive: \"1m\",\n allow_partial_search_results: \"true\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.open_point_in_time(\n index: \"my-index-000001\",\n keep_alive: \"1m\",\n allow_partial_search_results: \"true\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->openPointInTime([\n \"index\" => \"my-index-000001\",\n \"keep_alive\" => \"1m\",\n \"allow_partial_search_results\" => \"true\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/my-index-000001/_pit?keep_alive=1m&allow_partial_search_results=true\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.openPointInTime(o -> o\n .allowPartialSearchResults(true)\n .index(\"my-index-000001\")\n .keepAlive(k -> k\n .offset(1)\n )\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_scripts/{id}/{context}": {
+ "post": {
+ "tags": [
+ "script"
+ ],
+ "summary": "Create or update a script or search template\n",
+ "description": "**All methods and paths for this operation:**\n\n\n PUT\n /_scripts/{id}\n
\n \n POST\n /_scripts/{id}\n
\n \n PUT\n /_scripts/{id}/{context}\n
\n \n POST\n /_scripts/{id}/{context}\n
\n \n\nCreates or updates a stored script or search template.\n\n## Required authorization\n\n* Cluster privileges: `manage`\n",
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/solutions/search/search-templates",
+ "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/create-stored-script-api.html"
+ },
+ "operationId": "put-script",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/put_script-id"
+ },
+ {
+ "$ref": "#/components/parameters/put_script-context"
+ },
+ {
+ "$ref": "#/components/parameters/put_script-context_"
+ },
+ {
+ "$ref": "#/components/parameters/put_script-master_timeout"
+ },
+ {
+ "$ref": "#/components/parameters/put_script-timeout"
+ }
+ ],
+ "requestBody": {
+ "$ref": "#/components/requestBodies/put_script"
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/put_script-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "PUT _scripts/my-search-template\n{\n \"script\": {\n \"lang\": \"mustache\",\n \"source\": {\n \"query\": {\n \"match\": {\n \"message\": \"{{query_string}}\"\n }\n },\n \"from\": \"{{from}}\",\n \"size\": \"{{size}}\"\n }\n }\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.put_script(\n id=\"my-search-template\",\n script={\n \"lang\": \"mustache\",\n \"source\": {\n \"query\": {\n \"match\": {\n \"message\": \"{{query_string}}\"\n }\n },\n \"from\": \"{{from}}\",\n \"size\": \"{{size}}\"\n }\n },\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.putScript({\n id: \"my-search-template\",\n script: {\n lang: \"mustache\",\n source: {\n query: {\n match: {\n message: \"{{query_string}}\",\n },\n },\n from: \"{{from}}\",\n size: \"{{size}}\",\n },\n },\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.put_script(\n id: \"my-search-template\",\n body: {\n \"script\": {\n \"lang\": \"mustache\",\n \"source\": {\n \"query\": {\n \"match\": {\n \"message\": \"{{query_string}}\"\n }\n },\n \"from\": \"{{from}}\",\n \"size\": \"{{size}}\"\n }\n }\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->putScript([\n \"id\" => \"my-search-template\",\n \"body\" => [\n \"script\" => [\n \"lang\" => \"mustache\",\n \"source\" => [\n \"query\" => [\n \"match\" => [\n \"message\" => \"{{query_string}}\",\n ],\n ],\n \"from\" => \"{{from}}\",\n \"size\" => \"{{size}}\",\n ],\n ],\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"script\":{\"lang\":\"mustache\",\"source\":{\"query\":{\"match\":{\"message\":\"{{query_string}}\"}},\"from\":\"{{from}}\",\"size\":\"{{size}}\"}}}' \"$ELASTICSEARCH_URL/_scripts/my-search-template\""
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_query_rules/{ruleset_id}/_rule/{rule_id}": {
+ "get": {
+ "tags": [
+ "query_rules"
+ ],
+ "summary": "Get a query rule",
+ "description": "Get details about a query rule within a query ruleset.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_query_rules`\n",
+ "externalDocs": {
+ "description": "See rules and rulesets in Query Rules UI",
+ "url": "https://www.elastic.co/docs/solutions/search/query-rules-ui#accessing-the-query-rules-ui",
+ "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-query-rule.html"
+ },
+ "operationId": "query-rules-get-rule",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "ruleset_id",
+ "description": "The unique identifier of the query ruleset containing the rule to retrieve",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "path",
+ "name": "rule_id",
+ "description": "The unique identifier of the query rule within the specified ruleset to retrieve",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/query_rules._types.QueryRule"
+ },
+ "examples": {
+ "QueryRuleGetResponseExample1": {
+ "description": "A successful response from `GET _query_rules/my-ruleset/_rule/my-rule1`.",
+ "value": "{\n \"rule_id\": \"my-rule1\",\n \"type\": \"pinned\",\n \"criteria\": [\n {\n \"type\": \"contains\",\n \"metadata\": \"query_string\",\n \"values\": [\n \"pugs\",\n \"puggles\"\n ]\n }\n ],\n \"actions\": {\n \"ids\": [\n \"id1\",\n \"id2\"\n ]\n }\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET _query_rules/my-ruleset/_rule/my-rule1\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.query_rules.get_rule(\n ruleset_id=\"my-ruleset\",\n rule_id=\"my-rule1\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.queryRules.getRule({\n ruleset_id: \"my-ruleset\",\n rule_id: \"my-rule1\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.query_rules.get_rule(\n ruleset_id: \"my-ruleset\",\n rule_id: \"my-rule1\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->queryRules()->getRule([\n \"ruleset_id\" => \"my-ruleset\",\n \"rule_id\" => \"my-rule1\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_query_rules/my-ruleset/_rule/my-rule1\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.queryRules().getRule(g -> g\n .ruleId(\"my-rule1\")\n .rulesetId(\"my-ruleset\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "query_rules"
+ ],
+ "summary": "Create or update a query rule",
+ "description": "Create or update a query rule within a query ruleset.\n\nIMPORTANT: Due to limitations within pinned queries, you can only pin documents using ids or docs, but cannot use both in single rule.\nIt is advised to use one or the other in query rulesets, to avoid errors.\nAdditionally, pinned queries have a maximum limit of 100 pinned hits.\nIf multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_query_rules`\n",
+ "externalDocs": {
+ "description": "Edit rules and rulesets from the Query Rules UI",
+ "url": "https://www.elastic.co/docs/solutions/search/query-rules-ui#edit-a-rule",
+ "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/put-query-rule.html"
+ },
+ "operationId": "query-rules-put-rule",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "ruleset_id",
+ "description": "The unique identifier of the query ruleset containing the rule to be created or updated.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "path",
+ "name": "rule_id",
+ "description": "The unique identifier of the query rule within the specified ruleset to be created or updated.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The type of rule.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/query_rules._types.QueryRuleType"
+ }
+ ]
+ },
+ "criteria": {
+ "description": "The criteria that must be met for the rule to be applied.\nIf multiple criteria are specified for a rule, all criteria must be met for the rule to be applied.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/query_rules._types.QueryRuleCriteria"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/query_rules._types.QueryRuleCriteria"
+ }
+ }
+ ]
+ },
+ "actions": {
+ "description": "The actions to take when the rule is matched.\nThe format of this action depends on the rule type.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/query_rules._types.QueryRuleActions"
+ }
+ ]
+ },
+ "priority": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "type",
+ "criteria",
+ "actions"
+ ]
+ },
+ "examples": {
+ "QueryRulePutRequestExample1": {
+ "description": "Run `POST _query_rules/my-ruleset/_test` to test a ruleset. Provide the match criteria that you want to test against.\n",
+ "value": "{\n \"match_criteria\": {\n \"query_string\": \"puggles\"\n }\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "result": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Result"
+ }
+ ]
+ }
+ },
+ "required": [
+ "result"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _query_rules/my-ruleset/_test\n{\n \"match_criteria\": {\n \"query_string\": \"puggles\"\n }\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.query_rules.test(\n ruleset_id=\"my-ruleset\",\n match_criteria={\n \"query_string\": \"puggles\"\n },\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.queryRules.test({\n ruleset_id: \"my-ruleset\",\n match_criteria: {\n query_string: \"puggles\",\n },\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.query_rules.test(\n ruleset_id: \"my-ruleset\",\n body: {\n \"match_criteria\": {\n \"query_string\": \"puggles\"\n }\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->queryRules()->test([\n \"ruleset_id\" => \"my-ruleset\",\n \"body\" => [\n \"match_criteria\" => [\n \"query_string\" => \"puggles\",\n ],\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"match_criteria\":{\"query_string\":\"puggles\"}}' \"$ELASTICSEARCH_URL/_query_rules/my-ruleset/_test\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.queryRules().test(t -> t\n .matchCriteria(\"query_string\", JsonData.fromJson(\"\\\"puggles\\\"\"))\n .rulesetId(\"my-ruleset\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "query_rules"
+ ],
+ "summary": "Delete a query rule",
+ "description": "Delete a query rule within a query ruleset.\nThis is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_query_rules`\n",
+ "externalDocs": {
+ "description": "Delete a rule from the Query Rules UI",
+ "url": "https://www.elastic.co/docs/solutions/search/query-rules-ui#delete-a-rule",
+ "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-query-rule.html"
+ },
+ "operationId": "query-rules-delete-rule",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "ruleset_id",
+ "description": "The unique identifier of the query ruleset containing the rule to delete",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "path",
+ "name": "rule_id",
+ "description": "The unique identifier of the query rule within the specified ruleset to delete",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "DELETE _query_rules/my-ruleset/_rule/my-rule1\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.query_rules.delete_rule(\n ruleset_id=\"my-ruleset\",\n rule_id=\"my-rule1\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.queryRules.deleteRule({\n ruleset_id: \"my-ruleset\",\n rule_id: \"my-rule1\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.query_rules.delete_rule(\n ruleset_id: \"my-ruleset\",\n rule_id: \"my-rule1\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->queryRules()->deleteRule([\n \"ruleset_id\" => \"my-ruleset\",\n \"rule_id\" => \"my-rule1\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_query_rules/my-ruleset/_rule/my-rule1\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.queryRules().deleteRule(d -> d\n .ruleId(\"my-rule1\")\n .rulesetId(\"my-ruleset\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_query_rules/{ruleset_id}": {
+ "get": {
+ "tags": [
+ "query_rules"
+ ],
+ "summary": "Get a query ruleset",
+ "description": "Get details about a query ruleset.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_query_rules`\n",
+ "externalDocs": {
+ "description": "See rules and rulesets in Query Rules UI",
+ "url": "https://www.elastic.co/docs/solutions/search/query-rules-ui#accessing-the-query-rules-ui",
+ "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-query-ruleset.html"
+ },
+ "operationId": "query-rules-get-ruleset",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "ruleset_id",
+ "description": "The unique identifier of the query ruleset",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/query_rules._types.QueryRuleset"
+ },
+ "examples": {
+ "QueryRulesetGetResponseExample1": {
+ "description": "A successful response from `GET _query_rules/my-ruleset/`.",
+ "value": "{\n \"ruleset_id\": \"my-ruleset\",\n \"rules\": [\n {\n \"rule_id\": \"my-rule1\",\n \"type\": \"pinned\",\n \"criteria\": [\n {\n \"type\": \"contains\",\n \"metadata\": \"query_string\",\n \"values\": [ \"pugs\", \"puggles\" ]\n }\n ],\n \"actions\": {\n \"ids\": [\n \"id1\",\n \"id2\"\n ]\n }\n },\n {\n \"rule_id\": \"my-rule2\",\n \"type\": \"pinned\",\n \"criteria\": [\n {\n \"type\": \"fuzzy\",\n \"metadata\": \"query_string\",\n \"values\": [ \"rescue dogs\" ]\n }\n ],\n \"actions\": {\n \"docs\": [\n {\n \"_index\": \"index1\",\n \"_id\": \"id3\"\n },\n {\n \"_index\": \"index2\",\n \"_id\": \"id4\"\n }\n ]\n }\n }\n ]\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET _query_rules/my-ruleset/\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.query_rules.get_ruleset(\n ruleset_id=\"my-ruleset\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.queryRules.getRuleset({\n ruleset_id: \"my-ruleset\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.query_rules.get_ruleset(\n ruleset_id: \"my-ruleset\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->queryRules()->getRuleset([\n \"ruleset_id\" => \"my-ruleset\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_query_rules/my-ruleset/\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.queryRules().getRuleset(g -> g\n .rulesetId(\"my-ruleset\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "query_rules"
+ ],
+ "summary": "Create or update a query ruleset",
+ "description": "There is a limit of 100 rules per ruleset.\nThis limit can be increased by using the `xpack.applications.rules.max_rules_per_ruleset` cluster setting.\n\nIMPORTANT: Due to limitations within pinned queries, you can only select documents using `ids` or `docs`, but cannot use both in single rule.\nIt is advised to use one or the other in query rulesets, to avoid errors.\nAdditionally, pinned queries have a maximum limit of 100 pinned hits.\nIf multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_query_rules`\n",
+ "externalDocs": {
+ "description": "Edit rules and rulesets from the Query Rules UI",
+ "url": "https://www.elastic.co/docs/solutions/search/query-rules-ui#edit-a-rule",
+ "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/put-query-ruleset.html"
+ },
+ "operationId": "query-rules-put-ruleset",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "ruleset_id",
+ "description": "The unique identifier of the query ruleset to be created or updated.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "rules": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/query_rules._types.QueryRule"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/query_rules._types.QueryRule"
+ }
+ }
+ ]
+ }
+ },
+ "required": [
+ "rules"
+ ]
+ },
+ "examples": {
+ "QueryRulesetPutRequestExample1": {
+ "description": "Run `PUT _query_rules/my-ruleset` to create a new query ruleset. Two rules are associated with `my-ruleset`. `my-rule1` will pin documents with IDs `id1` and `id2` when `user_query` contains `pugs` or `puggles` and `user_country` exactly matches `us`. `my-rule2` will exclude documents from different specified indices with IDs `id3` and `id4` when the `query_string` fuzzily matches `rescue dogs`.\n",
+ "value": "{\n \"rules\": [\n {\n \"rule_id\": \"my-rule1\",\n \"type\": \"pinned\",\n \"criteria\": [\n {\n \"type\": \"contains\",\n \"metadata\": \"user_query\",\n \"values\": [ \"pugs\", \"puggles\" ]\n },\n {\n \"type\": \"exact\",\n \"metadata\": \"user_country\",\n \"values\": [ \"us\" ]\n }\n ],\n \"actions\": {\n \"ids\": [\n \"id1\",\n \"id2\"\n ]\n }\n },\n {\n \"rule_id\": \"my-rule2\",\n \"type\": \"pinned\",\n \"criteria\": [\n {\n \"type\": \"fuzzy\",\n \"metadata\": \"user_query\",\n \"values\": [ \"rescue dogs\" ]\n }\n ],\n \"actions\": {\n \"docs\": [\n {\n \"_index\": \"index1\",\n \"_id\": \"id3\"\n },\n {\n \"_index\": \"index2\",\n \"_id\": \"id4\"\n }\n ]\n }\n }\n ]\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "result": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Result"
+ }
+ ]
+ }
+ },
+ "required": [
+ "result"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "PUT _query_rules/my-ruleset\n{\n \"rules\": [\n {\n \"rule_id\": \"my-rule1\",\n \"type\": \"pinned\",\n \"criteria\": [\n {\n \"type\": \"contains\",\n \"metadata\": \"user_query\",\n \"values\": [ \"pugs\", \"puggles\" ]\n },\n {\n \"type\": \"exact\",\n \"metadata\": \"user_country\",\n \"values\": [ \"us\" ]\n }\n ],\n \"actions\": {\n \"ids\": [\n \"id1\",\n \"id2\"\n ]\n }\n },\n {\n \"rule_id\": \"my-rule2\",\n \"type\": \"pinned\",\n \"criteria\": [\n {\n \"type\": \"fuzzy\",\n \"metadata\": \"user_query\",\n \"values\": [ \"rescue dogs\" ]\n }\n ],\n \"actions\": {\n \"docs\": [\n {\n \"_index\": \"index1\",\n \"_id\": \"id3\"\n },\n {\n \"_index\": \"index2\",\n \"_id\": \"id4\"\n }\n ]\n }\n }\n ]\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.query_rules.put_ruleset(\n ruleset_id=\"my-ruleset\",\n rules=[\n {\n \"rule_id\": \"my-rule1\",\n \"type\": \"pinned\",\n \"criteria\": [\n {\n \"type\": \"contains\",\n \"metadata\": \"user_query\",\n \"values\": [\n \"pugs\",\n \"puggles\"\n ]\n },\n {\n \"type\": \"exact\",\n \"metadata\": \"user_country\",\n \"values\": [\n \"us\"\n ]\n }\n ],\n \"actions\": {\n \"ids\": [\n \"id1\",\n \"id2\"\n ]\n }\n },\n {\n \"rule_id\": \"my-rule2\",\n \"type\": \"pinned\",\n \"criteria\": [\n {\n \"type\": \"fuzzy\",\n \"metadata\": \"user_query\",\n \"values\": [\n \"rescue dogs\"\n ]\n }\n ],\n \"actions\": {\n \"docs\": [\n {\n \"_index\": \"index1\",\n \"_id\": \"id3\"\n },\n {\n \"_index\": \"index2\",\n \"_id\": \"id4\"\n }\n ]\n }\n }\n ],\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.queryRules.putRuleset({\n ruleset_id: \"my-ruleset\",\n rules: [\n {\n rule_id: \"my-rule1\",\n type: \"pinned\",\n criteria: [\n {\n type: \"contains\",\n metadata: \"user_query\",\n values: [\"pugs\", \"puggles\"],\n },\n {\n type: \"exact\",\n metadata: \"user_country\",\n values: [\"us\"],\n },\n ],\n actions: {\n ids: [\"id1\", \"id2\"],\n },\n },\n {\n rule_id: \"my-rule2\",\n type: \"pinned\",\n criteria: [\n {\n type: \"fuzzy\",\n metadata: \"user_query\",\n values: [\"rescue dogs\"],\n },\n ],\n actions: {\n docs: [\n {\n _index: \"index1\",\n _id: \"id3\",\n },\n {\n _index: \"index2\",\n _id: \"id4\",\n },\n ],\n },\n },\n ],\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.query_rules.put_ruleset(\n ruleset_id: \"my-ruleset\",\n body: {\n \"rules\": [\n {\n \"rule_id\": \"my-rule1\",\n \"type\": \"pinned\",\n \"criteria\": [\n {\n \"type\": \"contains\",\n \"metadata\": \"user_query\",\n \"values\": [\n \"pugs\",\n \"puggles\"\n ]\n },\n {\n \"type\": \"exact\",\n \"metadata\": \"user_country\",\n \"values\": [\n \"us\"\n ]\n }\n ],\n \"actions\": {\n \"ids\": [\n \"id1\",\n \"id2\"\n ]\n }\n },\n {\n \"rule_id\": \"my-rule2\",\n \"type\": \"pinned\",\n \"criteria\": [\n {\n \"type\": \"fuzzy\",\n \"metadata\": \"user_query\",\n \"values\": [\n \"rescue dogs\"\n ]\n }\n ],\n \"actions\": {\n \"docs\": [\n {\n \"_index\": \"index1\",\n \"_id\": \"id3\"\n },\n {\n \"_index\": \"index2\",\n \"_id\": \"id4\"\n }\n ]\n }\n }\n ]\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->queryRules()->putRuleset([\n \"ruleset_id\" => \"my-ruleset\",\n \"body\" => [\n \"rules\" => array(\n [\n \"rule_id\" => \"my-rule1\",\n \"type\" => \"pinned\",\n \"criteria\" => array(\n [\n \"type\" => \"contains\",\n \"metadata\" => \"user_query\",\n \"values\" => array(\n \"pugs\",\n \"puggles\",\n ),\n ],\n [\n \"type\" => \"exact\",\n \"metadata\" => \"user_country\",\n \"values\" => array(\n \"us\",\n ),\n ],\n ),\n \"actions\" => [\n \"ids\" => array(\n \"id1\",\n \"id2\",\n ),\n ],\n ],\n [\n \"rule_id\" => \"my-rule2\",\n \"type\" => \"pinned\",\n \"criteria\" => array(\n [\n \"type\" => \"fuzzy\",\n \"metadata\" => \"user_query\",\n \"values\" => array(\n \"rescue dogs\",\n ),\n ],\n ),\n \"actions\" => [\n \"docs\" => array(\n [\n \"_index\" => \"index1\",\n \"_id\" => \"id3\",\n ],\n [\n \"_index\" => \"index2\",\n \"_id\" => \"id4\",\n ],\n ),\n ],\n ],\n ),\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"rules\":[{\"rule_id\":\"my-rule1\",\"type\":\"pinned\",\"criteria\":[{\"type\":\"contains\",\"metadata\":\"user_query\",\"values\":[\"pugs\",\"puggles\"]},{\"type\":\"exact\",\"metadata\":\"user_country\",\"values\":[\"us\"]}],\"actions\":{\"ids\":[\"id1\",\"id2\"]}},{\"rule_id\":\"my-rule2\",\"type\":\"pinned\",\"criteria\":[{\"type\":\"fuzzy\",\"metadata\":\"user_query\",\"values\":[\"rescue dogs\"]}],\"actions\":{\"docs\":[{\"_index\":\"index1\",\"_id\":\"id3\"},{\"_index\":\"index2\",\"_id\":\"id4\"}]}}]}' \"$ELASTICSEARCH_URL/_query_rules/my-ruleset\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.queryRules().putRuleset(p -> p\n .rules(List.of(QueryRule.queryRuleOf(q -> q\n .ruleId(\"my-rule1\")\n .type(QueryRuleType.Pinned)\n .criteria(List.of(QueryRuleCriteria.of(qu -> qu\n .type(QueryRuleCriteriaType.Contains)\n .metadata(\"user_query\")\n .values(List.of(JsonData.fromJson(\"\\\"pugs\\\"\"),JsonData.fromJson(\"\\\"puggles\\\"\")))),QueryRuleCriteria.of(qu -> qu\n .type(QueryRuleCriteriaType.Exact)\n .metadata(\"user_country\")\n .values(JsonData.fromJson(\"\\\"us\\\"\")))))\n .actions(a -> a\n .ids(List.of(\"id1\",\"id2\"))\n )),QueryRule.queryRuleOf(q -> q\n .ruleId(\"my-rule2\")\n .type(QueryRuleType.Pinned)\n .criteria(c -> c\n .type(QueryRuleCriteriaType.Fuzzy)\n .metadata(\"user_query\")\n .values(JsonData.fromJson(\"\\\"rescue dogs\\\"\"))\n )\n .actions(a -> a\n .docs(List.of(PinnedDoc.of(pi -> pi\n .id(\"id3\")\n .index(\"index1\")),PinnedDoc.of(pi -> pi\n .id(\"id4\")\n .index(\"index2\"))))\n ))))\n .rulesetId(\"my-ruleset\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "query_rules"
+ ],
+ "summary": "Delete a query ruleset",
+ "description": "Remove a query ruleset and its associated data.\nThis is a destructive action that is not recoverable.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_query_rules`\n",
+ "externalDocs": {
+ "description": "Delete a ruleset from the Query Rules UI",
+ "url": "https://www.elastic.co/docs/solutions/search/query-rules-ui#delete-a-ruleset",
+ "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-query-ruleset.html"
+ },
+ "operationId": "query-rules-delete-ruleset",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "ruleset_id",
+ "description": "The unique identifier of the query ruleset to delete",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "DELETE _query_rules/my-ruleset/\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.query_rules.delete_ruleset(\n ruleset_id=\"my-ruleset\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.queryRules.deleteRuleset({\n ruleset_id: \"my-ruleset\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.query_rules.delete_ruleset(\n ruleset_id: \"my-ruleset\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->queryRules()->deleteRuleset([\n \"ruleset_id\" => \"my-ruleset\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_query_rules/my-ruleset/\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.queryRules().deleteRuleset(d -> d\n .rulesetId(\"my-ruleset\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_query_rules": {
+ "get": {
+ "tags": [
+ "query_rules"
+ ],
+ "summary": "Get all query rulesets",
+ "description": "Get summarized information about the query rulesets.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_query_rules`\n",
+ "externalDocs": {
+ "description": "See rules and rulesets in Query Rules UI",
+ "url": "https://www.elastic.co/docs/solutions/search/query-rules-ui#accessing-the-query-rules-ui",
+ "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/list-query-rulesets.html"
+ },
+ "operationId": "query-rules-list-rulesets",
+ "parameters": [
+ {
+ "in": "query",
+ "name": "from",
+ "description": "The offset from the first result to fetch.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "size",
+ "description": "The maximum number of results to retrieve.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number"
+ },
+ "results": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/query_rules.list_rulesets.QueryRulesetListItem"
+ }
+ }
+ },
+ "required": [
+ "count",
+ "results"
+ ]
+ },
+ "examples": {
+ "QueryRulesetListResponseExample1": {
+ "description": "A successful response from `GET _query_rules/?from=0&size=3`.",
+ "value": "{\n \"count\": 3,\n \"results\": [\n {\n \"ruleset_id\": \"ruleset-1\",\n \"rule_total_count\": 1,\n \"rule_criteria_types_counts\": {\n \"exact\": 1\n }\n },\n {\n \"ruleset_id\": \"ruleset-2\",\n \"rule_total_count\": 2,\n \"rule_criteria_types_counts\": {\n \"exact\": 1,\n \"fuzzy\": 1\n }\n },\n {\n \"ruleset_id\": \"ruleset-3\",\n \"rule_total_count\": 3,\n \"rule_criteria_types_counts\": {\n \"exact\": 1,\n \"fuzzy\": 2\n }\n }\n ]\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET _query_rules/?from=0&size=3\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.query_rules.list_rulesets(\n from=\"0\",\n size=\"3\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.queryRules.listRulesets({\n from: 0,\n size: 3,\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.query_rules.list_rulesets(\n from: \"0\",\n size: \"3\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->queryRules()->listRulesets([\n \"from\" => \"0\",\n \"size\" => \"3\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_query_rules/?from=0&size=3\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.queryRules().listRulesets(l -> l\n .from(0)\n .size(3)\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_query_rules/{ruleset_id}/_test": {
+ "post": {
+ "tags": [
+ "query_rules"
+ ],
+ "summary": "Test a query ruleset",
+ "description": "Evaluate match criteria against a query ruleset to identify the rules that would match that criteria.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_query_rules`\n",
+ "operationId": "query-rules-test",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "ruleset_id",
+ "description": "The unique identifier of the query ruleset to be created or updated",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "match_criteria": {
+ "description": "The match criteria to apply to rules in the given query ruleset.\nMatch criteria should match the keys defined in the `criteria.metadata` field of the rule.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "required": [
+ "match_criteria"
+ ]
+ },
+ "examples": {
+ "QueryRulesetTestRequestExample1": {
+ "description": "Run `PUT _query_rules/my-ruleset` to create a new query ruleset. Two rules are associated with `my-ruleset`. `my-rule1` will pin documents with IDs `id1` and `id2` when `user_query` contains `pugs` or `puggles` and `user_country` exactly matches `us`. `my-rule2` will exclude documents from different specified indices with IDs `id3` and `id4` when the `query_string` fuzzily matches `rescue dogs`.\n",
+ "value": "{\n \"rules\": [\n {\n \"rule_id\": \"my-rule1\",\n \"type\": \"pinned\",\n \"criteria\": [\n {\n \"type\": \"contains\",\n \"metadata\": \"user_query\",\n \"values\": [ \"pugs\", \"puggles\" ]\n },\n {\n \"type\": \"exact\",\n \"metadata\": \"user_country\",\n \"values\": [ \"us\" ]\n }\n ],\n \"actions\": {\n \"ids\": [\n \"id1\",\n \"id2\"\n ]\n }\n },\n {\n \"rule_id\": \"my-rule2\",\n \"type\": \"pinned\",\n \"criteria\": [\n {\n \"type\": \"fuzzy\",\n \"metadata\": \"user_query\",\n \"values\": [ \"rescue dogs\" ]\n }\n ],\n \"actions\": {\n \"docs\": [\n {\n \"_index\": \"index1\",\n \"_id\": \"id3\"\n },\n {\n \"_index\": \"index2\",\n \"_id\": \"id4\"\n }\n ]\n }\n }\n ]\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "total_matched_rules": {
+ "type": "number"
+ },
+ "matched_rules": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/query_rules.test.QueryRulesetMatchedRule"
+ }
+ }
+ },
+ "required": [
+ "total_matched_rules",
+ "matched_rules"
+ ]
+ },
+ "examples": {
+ "QueryRulesetTestResponseExample1": {
+ "description": "A successful response from `POST _query_rules/my-ruleset/_test`.",
+ "value": "{\n \"total_matched_rules\": 1,\n \"matched_rules\": [\n {\n \"ruleset_id\": \"my-ruleset\",\n \"rule_id\": \"my-rule1\"\n }\n ]\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "PUT _query_rules/my-ruleset\n{\n \"rules\": [\n {\n \"rule_id\": \"my-rule1\",\n \"type\": \"pinned\",\n \"criteria\": [\n {\n \"type\": \"contains\",\n \"metadata\": \"user_query\",\n \"values\": [ \"pugs\", \"puggles\" ]\n },\n {\n \"type\": \"exact\",\n \"metadata\": \"user_country\",\n \"values\": [ \"us\" ]\n }\n ],\n \"actions\": {\n \"ids\": [\n \"id1\",\n \"id2\"\n ]\n }\n },\n {\n \"rule_id\": \"my-rule2\",\n \"type\": \"pinned\",\n \"criteria\": [\n {\n \"type\": \"fuzzy\",\n \"metadata\": \"user_query\",\n \"values\": [ \"rescue dogs\" ]\n }\n ],\n \"actions\": {\n \"docs\": [\n {\n \"_index\": \"index1\",\n \"_id\": \"id3\"\n },\n {\n \"_index\": \"index2\",\n \"_id\": \"id4\"\n }\n ]\n }\n }\n ]\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.query_rules.put_ruleset(\n ruleset_id=\"my-ruleset\",\n rules=[\n {\n \"rule_id\": \"my-rule1\",\n \"type\": \"pinned\",\n \"criteria\": [\n {\n \"type\": \"contains\",\n \"metadata\": \"user_query\",\n \"values\": [\n \"pugs\",\n \"puggles\"\n ]\n },\n {\n \"type\": \"exact\",\n \"metadata\": \"user_country\",\n \"values\": [\n \"us\"\n ]\n }\n ],\n \"actions\": {\n \"ids\": [\n \"id1\",\n \"id2\"\n ]\n }\n },\n {\n \"rule_id\": \"my-rule2\",\n \"type\": \"pinned\",\n \"criteria\": [\n {\n \"type\": \"fuzzy\",\n \"metadata\": \"user_query\",\n \"values\": [\n \"rescue dogs\"\n ]\n }\n ],\n \"actions\": {\n \"docs\": [\n {\n \"_index\": \"index1\",\n \"_id\": \"id3\"\n },\n {\n \"_index\": \"index2\",\n \"_id\": \"id4\"\n }\n ]\n }\n }\n ],\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.queryRules.putRuleset({\n ruleset_id: \"my-ruleset\",\n rules: [\n {\n rule_id: \"my-rule1\",\n type: \"pinned\",\n criteria: [\n {\n type: \"contains\",\n metadata: \"user_query\",\n values: [\"pugs\", \"puggles\"],\n },\n {\n type: \"exact\",\n metadata: \"user_country\",\n values: [\"us\"],\n },\n ],\n actions: {\n ids: [\"id1\", \"id2\"],\n },\n },\n {\n rule_id: \"my-rule2\",\n type: \"pinned\",\n criteria: [\n {\n type: \"fuzzy\",\n metadata: \"user_query\",\n values: [\"rescue dogs\"],\n },\n ],\n actions: {\n docs: [\n {\n _index: \"index1\",\n _id: \"id3\",\n },\n {\n _index: \"index2\",\n _id: \"id4\",\n },\n ],\n },\n },\n ],\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.query_rules.put_ruleset(\n ruleset_id: \"my-ruleset\",\n body: {\n \"rules\": [\n {\n \"rule_id\": \"my-rule1\",\n \"type\": \"pinned\",\n \"criteria\": [\n {\n \"type\": \"contains\",\n \"metadata\": \"user_query\",\n \"values\": [\n \"pugs\",\n \"puggles\"\n ]\n },\n {\n \"type\": \"exact\",\n \"metadata\": \"user_country\",\n \"values\": [\n \"us\"\n ]\n }\n ],\n \"actions\": {\n \"ids\": [\n \"id1\",\n \"id2\"\n ]\n }\n },\n {\n \"rule_id\": \"my-rule2\",\n \"type\": \"pinned\",\n \"criteria\": [\n {\n \"type\": \"fuzzy\",\n \"metadata\": \"user_query\",\n \"values\": [\n \"rescue dogs\"\n ]\n }\n ],\n \"actions\": {\n \"docs\": [\n {\n \"_index\": \"index1\",\n \"_id\": \"id3\"\n },\n {\n \"_index\": \"index2\",\n \"_id\": \"id4\"\n }\n ]\n }\n }\n ]\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->queryRules()->putRuleset([\n \"ruleset_id\" => \"my-ruleset\",\n \"body\" => [\n \"rules\" => array(\n [\n \"rule_id\" => \"my-rule1\",\n \"type\" => \"pinned\",\n \"criteria\" => array(\n [\n \"type\" => \"contains\",\n \"metadata\" => \"user_query\",\n \"values\" => array(\n \"pugs\",\n \"puggles\",\n ),\n ],\n [\n \"type\" => \"exact\",\n \"metadata\" => \"user_country\",\n \"values\" => array(\n \"us\",\n ),\n ],\n ),\n \"actions\" => [\n \"ids\" => array(\n \"id1\",\n \"id2\",\n ),\n ],\n ],\n [\n \"rule_id\" => \"my-rule2\",\n \"type\" => \"pinned\",\n \"criteria\" => array(\n [\n \"type\" => \"fuzzy\",\n \"metadata\" => \"user_query\",\n \"values\" => array(\n \"rescue dogs\",\n ),\n ],\n ),\n \"actions\" => [\n \"docs\" => array(\n [\n \"_index\" => \"index1\",\n \"_id\" => \"id3\",\n ],\n [\n \"_index\" => \"index2\",\n \"_id\" => \"id4\",\n ],\n ),\n ],\n ],\n ),\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"rules\":[{\"rule_id\":\"my-rule1\",\"type\":\"pinned\",\"criteria\":[{\"type\":\"contains\",\"metadata\":\"user_query\",\"values\":[\"pugs\",\"puggles\"]},{\"type\":\"exact\",\"metadata\":\"user_country\",\"values\":[\"us\"]}],\"actions\":{\"ids\":[\"id1\",\"id2\"]}},{\"rule_id\":\"my-rule2\",\"type\":\"pinned\",\"criteria\":[{\"type\":\"fuzzy\",\"metadata\":\"user_query\",\"values\":[\"rescue dogs\"]}],\"actions\":{\"docs\":[{\"_index\":\"index1\",\"_id\":\"id3\"},{\"_index\":\"index2\",\"_id\":\"id4\"}]}}]}' \"$ELASTICSEARCH_URL/_query_rules/my-ruleset\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.queryRules().putRuleset(p -> p\n .rules(List.of(QueryRule.queryRuleOf(q -> q\n .ruleId(\"my-rule1\")\n .type(QueryRuleType.Pinned)\n .criteria(List.of(QueryRuleCriteria.of(qu -> qu\n .type(QueryRuleCriteriaType.Contains)\n .metadata(\"user_query\")\n .values(List.of(JsonData.fromJson(\"\\\"pugs\\\"\"),JsonData.fromJson(\"\\\"puggles\\\"\")))),QueryRuleCriteria.of(qu -> qu\n .type(QueryRuleCriteriaType.Exact)\n .metadata(\"user_country\")\n .values(JsonData.fromJson(\"\\\"us\\\"\")))))\n .actions(a -> a\n .ids(List.of(\"id1\",\"id2\"))\n )),QueryRule.queryRuleOf(q -> q\n .ruleId(\"my-rule2\")\n .type(QueryRuleType.Pinned)\n .criteria(c -> c\n .type(QueryRuleCriteriaType.Fuzzy)\n .metadata(\"user_query\")\n .values(JsonData.fromJson(\"\\\"rescue dogs\\\"\"))\n )\n .actions(a -> a\n .docs(List.of(PinnedDoc.of(pi -> pi\n .id(\"id3\")\n .index(\"index1\")),PinnedDoc.of(pi -> pi\n .id(\"id4\")\n .index(\"index2\"))))\n ))))\n .rulesetId(\"my-ruleset\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/{index}/_rank_eval": {
+ "post": {
+ "tags": [
+ "search"
+ ],
+ "summary": "Evaluate ranked search results\n",
+ "description": "**All methods and paths for this operation:**\n\n\n GET\n /_rank_eval\n
\n \n POST\n /_rank_eval\n
\n \n GET\n /{index}/_rank_eval\n
\n \n POST\n /{index}/_rank_eval\n
\n \n\nEvaluate the quality of ranked search results over a set of typical search queries.\n\n## Required authorization\n\n* Index privileges: `read`\n",
+ "operationId": "rank-eval",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/rank_eval-index"
+ },
+ {
+ "$ref": "#/components/parameters/rank_eval-allow_no_indices"
+ },
+ {
+ "$ref": "#/components/parameters/rank_eval-expand_wildcards"
+ },
+ {
+ "$ref": "#/components/parameters/rank_eval-ignore_unavailable"
+ },
+ {
+ "$ref": "#/components/parameters/rank_eval-search_type"
+ }
+ ],
+ "requestBody": {
+ "$ref": "#/components/requestBodies/rank_eval"
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/rank_eval-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET /my-index-000001/_rank_eval\n{\n \"requests\": [\n {\n \"id\": \"JFK query\",\n \"request\": { \"query\": { \"match_all\": {} } },\n \"ratings\": []\n } ],\n \"metric\": {\n \"precision\": {\n \"k\": 20,\n \"relevant_rating_threshold\": 1,\n \"ignore_unlabeled\": false\n }\n }\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.rank_eval(\n index=\"my-index-000001\",\n requests=[\n {\n \"id\": \"JFK query\",\n \"request\": {\n \"query\": {\n \"match_all\": {}\n }\n },\n \"ratings\": []\n }\n ],\n metric={\n \"precision\": {\n \"k\": 20,\n \"relevant_rating_threshold\": 1,\n \"ignore_unlabeled\": False\n }\n },\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.rankEval({\n index: \"my-index-000001\",\n requests: [\n {\n id: \"JFK query\",\n request: {\n query: {\n match_all: {},\n },\n },\n ratings: [],\n },\n ],\n metric: {\n precision: {\n k: 20,\n relevant_rating_threshold: 1,\n ignore_unlabeled: false,\n },\n },\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.rank_eval(\n index: \"my-index-000001\",\n body: {\n \"requests\": [\n {\n \"id\": \"JFK query\",\n \"request\": {\n \"query\": {\n \"match_all\": {}\n }\n },\n \"ratings\": []\n }\n ],\n \"metric\": {\n \"precision\": {\n \"k\": 20,\n \"relevant_rating_threshold\": 1,\n \"ignore_unlabeled\": false\n }\n }\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->rankEval([\n \"index\" => \"my-index-000001\",\n \"body\" => [\n \"requests\" => array(\n [\n \"id\" => \"JFK query\",\n \"request\" => [\n \"query\" => [\n \"match_all\" => new ArrayObject([]),\n ],\n ],\n \"ratings\" => array(\n ),\n ],\n ),\n \"metric\" => [\n \"precision\" => [\n \"k\" => 20,\n \"relevant_rating_threshold\" => 1,\n \"ignore_unlabeled\" => false,\n ],\n ],\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"requests\":[{\"id\":\"JFK query\",\"request\":{\"query\":{\"match_all\":{}}},\"ratings\":[]}],\"metric\":{\"precision\":{\"k\":20,\"relevant_rating_threshold\":1,\"ignore_unlabeled\":false}}}' \"$ELASTICSEARCH_URL/my-index-000001/_rank_eval\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.rankEval(r -> r\n .index(\"my-index-000001\")\n .metric(m -> m\n .precision(p -> p\n .ignoreUnlabeled(false)\n .relevantRatingThreshold(1)\n .k(20)\n )\n )\n .requests(re -> re\n .id(\"JFK query\")\n .request(req -> req\n .query(q -> q\n .matchAll(m -> m)\n )\n )\n )\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_reindex": {
+ "post": {
+ "tags": [
+ "document"
+ ],
+ "summary": "Reindex documents",
+ "description": "Copy documents from a source to a destination.\nYou can copy all documents to the destination index or reindex a subset of the documents.\nThe source can be any existing index, alias, or data stream.\nThe destination must differ from the source.\nFor example, you cannot reindex a data stream into itself.\n\nIMPORTANT: Reindex requires `_source` to be enabled for all documents in the source.\nThe destination should be configured as wanted before calling the reindex API.\nReindex does not copy the settings from the source or its associated template.\nMappings, shard counts, and replicas, for example, must be configured ahead of time.\n\nIf the Elasticsearch security features are enabled, you must have the following security privileges:\n\n* The `read` index privilege for the source data stream, index, or alias.\n* The `write` index privilege for the destination data stream, index, or index alias.\n* To automatically create a data stream or index with a reindex API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege for the destination data stream, index, or alias.\n* If reindexing from a remote cluster, the `source.remote.user` must have the `monitor` cluster privilege and the `read` index privilege for the source data stream, index, or alias.\n\nIf reindexing from a remote cluster, you must explicitly allow the remote host in the `reindex.remote.whitelist` setting.\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nThe `dest` element can be configured like the index API to control optimistic concurrency control.\nOmitting `version_type` or setting it to `internal` causes Elasticsearch to blindly dump documents into the destination, overwriting any that happen to have the same ID.\n\nSetting `version_type` to `external` causes Elasticsearch to preserve the `version` from the source, create any documents that are missing, and update any documents that have an older version in the destination than they do in the source.\n\nSetting `op_type` to `create` causes the reindex API to create only missing documents in the destination.\nAll existing documents will cause a version conflict.\n\nIMPORTANT: Because data streams are append-only, any reindex request to a destination data stream must have an `op_type` of `create`.\nA reindex can only add new documents to a destination data stream.\nIt cannot update existing documents in a destination data stream.\n\nBy default, version conflicts abort the reindex process.\nTo continue reindexing if there are conflicts, set the `conflicts` request body property to `proceed`.\nIn this case, the response includes a count of the version conflicts that were encountered.\nNote that the handling of other error types is unaffected by the `conflicts` property.\nAdditionally, if you opt to count version conflicts, the operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query.\n\nIt's recommended to reindex on indices with a green status. Reindexing can fail when a node shuts down or crashes.\n* When requested with `wait_for_completion=true` (default), the request fails if the node shuts down.\n* When requested with `wait_for_completion=false`, a task id is returned, for use with the task management APIs. The task may disappear or fail if the node shuts down.\nWhen retrying a failed reindex operation, it might be necessary to set `conflicts=proceed` or to first delete the partial destination index.\nAdditionally, dry runs, checking disk space, and fetching index recovery information can help address the root cause.\n\nRefer to the linked documentation for examples of how to reindex documents.\n\n## Required authorization\n\n* Index privileges: `read`,`write`\n",
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/reindex-indices",
+ "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/docs-reindex.html"
+ },
+ "operationId": "reindex",
+ "parameters": [
+ {
+ "in": "query",
+ "name": "refresh",
+ "description": "If `true`, the request refreshes affected shards to make this operation visible to search.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "requests_per_second",
+ "description": "The throttle for this request in sub-requests per second.\nBy default, there is no throttle.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "scroll",
+ "description": "The period of time that a consistent view of the index should be maintained for scrolled search.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "slices",
+ "description": "The number of slices this task should be divided into.\nIt defaults to one slice, which means the task isn't sliced into subtasks.\n\nReindex supports sliced scroll to parallelize the reindexing process.\nThis parallelization can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nNOTE: Reindexing from remote clusters does not support manual or automatic slicing.\n\nIf set to `auto`, Elasticsearch chooses the number of slices to use.\nThis setting will use one slice per shard, up to a certain limit.\nIf there are multiple sources, it will choose the number of slices based on the index or backing index with the smallest number of shards.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Slices"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "max_docs",
+ "description": "The maximum number of documents to reindex.\nBy default, all documents are reindexed.\nIf it is a value less then or equal to `scroll_size`, a scroll will not be used to retrieve the results for the operation.\n\nIf `conflicts` is set to `proceed`, the reindex operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "timeout",
+ "description": "The period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards.\nBy default, Elasticsearch waits for at least one minute before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "wait_for_active_shards",
+ "description": "The number of shard copies that must be active before proceeding with the operation.\nSet it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe default value is one, which means it waits for each primary shard to be active.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.WaitForActiveShards"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "wait_for_completion",
+ "description": "If `true`, the request blocks until the operation is complete.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "require_alias",
+ "description": "If `true`, the destination must be an index alias.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "conflicts": {
+ "description": "Indicates whether to continue reindexing even when there are conflicts.\n\nSupported values include:\n - `abort`: Stop reindexing if there are conflicts.\n - `proceed`: Continue reindexing even if there are conflicts.\n\n",
+ "default": "abort",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Conflicts"
+ }
+ ]
+ },
+ "dest": {
+ "description": "The destination you are copying to.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.reindex.Destination"
+ }
+ ]
+ },
+ "max_docs": {
+ "description": "The maximum number of documents to reindex.\nBy default, all documents are reindexed.\nIf it is a value less then or equal to `scroll_size`, a scroll will not be used to retrieve the results for the operation.\n\nIf `conflicts` is set to `proceed`, the reindex operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query.",
+ "type": "number"
+ },
+ "script": {
+ "description": "The script to run to update the document source or metadata when reindexing.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "size": {
+ "type": "number"
+ },
+ "source": {
+ "description": "The source you are copying from.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.reindex.Source"
+ }
+ ]
+ }
+ },
+ "required": [
+ "dest",
+ "source"
+ ]
+ },
+ "examples": {
+ "ReindexRequestExample1": {
+ "summary": "Reindex multiple sources",
+ "description": "Run `POST _reindex` to reindex from multiple sources. The `index` attribute in source can be a list, which enables you to copy from lots of sources in one request. This example copies documents from the `my-index-000001` and `my-index-000002` indices.\n",
+ "value": "{\n \"source\": {\n \"index\": [\"my-index-000001\", \"my-index-000002\"]\n },\n \"dest\": {\n \"index\": \"my-new-index-000002\"\n }\n}"
+ },
+ "ReindexRequestExample10": {
+ "summary": "Reindex with Painless",
+ "description": "You can use Painless to reindex daily indices to apply a new template to the existing documents. The script extracts the date from the index name and creates a new index with `-1` appended. For example, all data from `metricbeat-2016.05.31` will be reindexed into `metricbeat-2016.05.31-1`.\n",
+ "value": "{\n \"source\": {\n \"index\": \"metricbeat-*\"\n },\n \"dest\": {\n \"index\": \"metricbeat\"\n },\n \"script\": {\n \"lang\": \"painless\",\n \"source\": \"ctx._index = 'metricbeat-' + (ctx._index.substring('metricbeat-'.length(), ctx._index.length())) + '-1'\"\n }\n}"
+ },
+ "ReindexRequestExample11": {
+ "summary": "Reindex a random subset",
+ "description": "Run `POST _reindex` to extract a random subset of the source for testing. You might need to adjust the `min_score` value depending on the relative amount of data extracted from source.\n",
+ "value": "{\n \"max_docs\": 10,\n \"source\": {\n \"index\": \"my-index-000001\",\n \"query\": {\n \"function_score\" : {\n \"random_score\" : {},\n \"min_score\" : 0.9\n }\n }\n },\n \"dest\": {\n \"index\": \"my-new-index-000001\"\n }\n}"
+ },
+ "ReindexRequestExample12": {
+ "summary": "Reindex modified documents",
+ "description": "Run `POST _reindex` to modify documents during reindexing. This example bumps the version of the source document.\n",
+ "value": "{\n \"source\": {\n \"index\": \"my-index-000001\"\n },\n \"dest\": {\n \"index\": \"my-new-index-000001\",\n \"version_type\": \"external\"\n },\n \"script\": {\n \"source\": \"if (ctx._source.foo == 'bar') {ctx._version++; ctx._source.remove('foo')}\",\n \"lang\": \"painless\"\n }\n}"
+ },
+ "ReindexRequestExample13": {
+ "summary": "Reindex from remote on Elastic Cloud",
+ "description": "When using Elastic Cloud, you can run `POST _reindex` and authenticate against a remote cluster with an API key.\n",
+ "value": "{\n \"source\": {\n \"remote\": {\n \"host\": \"http://otherhost:9200\",\n \"username\": \"user\",\n \"password\": \"pass\"\n },\n \"index\": \"my-index-000001\",\n \"query\": {\n \"match\": {\n \"test\": \"data\"\n }\n }\n },\n \"dest\": {\n \"index\": \"my-new-index-000001\"\n }\n}"
+ },
+ "ReindexRequestExample2": {
+ "summary": "Manual slicing",
+ "description": "Run `POST _reindex` to slice a reindex request manually. Provide a slice ID and total number of slices to each request.\n",
+ "value": "{\n \"source\": {\n \"index\": \"my-index-000001\",\n \"slice\": {\n \"id\": 0,\n \"max\": 2\n }\n },\n \"dest\": {\n \"index\": \"my-new-index-000001\"\n }\n}"
+ },
+ "ReindexRequestExample3": {
+ "summary": "Automatic slicing",
+ "description": "Run `POST _reindex?slices=5&refresh` to automatically parallelize using sliced scroll to slice on `_id`. The `slices` parameter specifies the number of slices to use.\n",
+ "value": "{\n \"source\": {\n \"index\": \"my-index-000001\"\n },\n \"dest\": {\n \"index\": \"my-new-index-000001\"\n }\n}"
+ },
+ "ReindexRequestExample4": {
+ "summary": "Routing",
+ "description": "By default if reindex sees a document with routing then the routing is preserved unless it's changed by the script. You can set `routing` on the `dest` request to change this behavior. In this example, run `POST _reindex` to copy all documents from the `source` with the company name `cat` into the `dest` with routing set to `cat`.\n",
+ "value": "{\n \"source\": {\n \"index\": \"source\",\n \"query\": {\n \"match\": {\n \"company\": \"cat\"\n }\n }\n },\n \"dest\": {\n \"index\": \"dest\",\n \"routing\": \"=cat\"\n }\n}"
+ },
+ "ReindexRequestExample5": {
+ "summary": "Ingest pipelines",
+ "description": "Run `POST _reindex` and use the ingest pipelines feature.",
+ "value": "{\n \"source\": {\n \"index\": \"source\"\n },\n \"dest\": {\n \"index\": \"dest\",\n \"pipeline\": \"some_ingest_pipeline\"\n }\n}"
+ },
+ "ReindexRequestExample6": {
+ "summary": "Reindex with a query",
+ "description": "Run `POST _reindex` and add a query to the `source` to limit the documents to reindex. For example, this request copies documents into `my-new-index-000001` only if they have a `user.id` of `kimchy`.\n",
+ "value": "{\n \"source\": {\n \"index\": \"my-index-000001\",\n \"query\": {\n \"term\": {\n \"user.id\": \"kimchy\"\n }\n }\n },\n \"dest\": {\n \"index\": \"my-new-index-000001\"\n }\n}"
+ },
+ "ReindexRequestExample7": {
+ "summary": "Reindex with max_docs",
+ "description": "You can limit the number of processed documents by setting `max_docs`. For example, run `POST _reindex` to copy a single document from `my-index-000001` to `my-new-index-000001`.\n",
+ "value": "{\n \"max_docs\": 1,\n \"source\": {\n \"index\": \"my-index-000001\"\n },\n \"dest\": {\n \"index\": \"my-new-index-000001\"\n }\n}"
+ },
+ "ReindexRequestExample8": {
+ "summary": "Reindex selected fields",
+ "description": "You can use source filtering to reindex a subset of the fields in the original documents. For example, run `POST _reindex` the reindex only the `user.id` and `_doc` fields of each document.\n",
+ "value": "{\n \"source\": {\n \"index\": \"my-index-000001\",\n \"_source\": [\"user.id\", \"_doc\"]\n },\n \"dest\": {\n \"index\": \"my-new-index-000001\"\n }\n}"
+ },
+ "ReindexRequestExample9": {
+ "summary": "Reindex new field names",
+ "description": "A reindex operation can build a copy of an index with renamed fields. If your index has documents with `text` and `flag` fields, you can change the latter field name to `tag` during the reindex.\n",
+ "value": "{\n \"source\": {\n \"index\": \"my-index-000001\"\n },\n \"dest\": {\n \"index\": \"my-new-index-000001\"\n },\n \"script\": {\n \"source\": \"ctx._source.tag = ctx._source.remove(\\\"flag\\\")\"\n }\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "batches": {
+ "description": "The number of scroll responses that were pulled back by the reindex.",
+ "type": "number"
+ },
+ "created": {
+ "description": "The number of documents that were successfully created.",
+ "type": "number"
+ },
+ "deleted": {
+ "description": "The number of documents that were successfully deleted.",
+ "type": "number"
+ },
+ "failures": {
+ "description": "If there were any unrecoverable errors during the process, it is an array of those failures.\nIf this array is not empty, the request ended because of those failures.\nReindex is implemented using batches and any failure causes the entire process to end but all failures in the current batch are collected into the array.\nYou can use the `conflicts` option to prevent the reindex from ending on version conflicts.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.BulkIndexByScrollFailure"
+ }
+ },
+ "noops": {
+ "description": "The number of documents that were ignored because the script used for the reindex returned a `noop` value for `ctx.op`.",
+ "type": "number"
+ },
+ "retries": {
+ "description": "The number of retries attempted by reindex.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Retries"
+ }
+ ]
+ },
+ "requests_per_second": {
+ "description": "The number of requests per second effectively run during the reindex.",
+ "type": "number"
+ },
+ "slice_id": {
+ "type": "number"
+ },
+ "task": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.TaskId"
+ }
+ ]
+ },
+ "throttled_millis": {
+ "description": "The number of milliseconds the request slept to conform to `requests_per_second`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "throttled_until_millis": {
+ "description": "This field should always be equal to zero in a reindex response.\nIt has meaning only when using the task API, where it indicates the next time (in milliseconds since epoch) that a throttled request will be run again in order to conform to `requests_per_second`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "timed_out": {
+ "description": "If any of the requests that ran during the reindex timed out, it is `true`.",
+ "type": "boolean"
+ },
+ "took": {
+ "description": "The total milliseconds the entire operation took.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitMillis"
+ }
+ ]
+ },
+ "total": {
+ "description": "The number of documents that were successfully processed.",
+ "type": "number"
+ },
+ "updated": {
+ "description": "The number of documents that were successfully updated.\nThat is to say, a document with the same ID already existed before the reindex updated it.",
+ "type": "number"
+ },
+ "version_conflicts": {
+ "description": "The number of version conflicts that occurred.",
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _reindex\n{\n \"source\": {\n \"index\": [\"my-index-000001\", \"my-index-000002\"]\n },\n \"dest\": {\n \"index\": \"my-new-index-000002\"\n }\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.reindex(\n source={\n \"index\": [\n \"my-index-000001\",\n \"my-index-000002\"\n ]\n },\n dest={\n \"index\": \"my-new-index-000002\"\n },\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.reindex({\n source: {\n index: [\"my-index-000001\", \"my-index-000002\"],\n },\n dest: {\n index: \"my-new-index-000002\",\n },\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.reindex(\n body: {\n \"source\": {\n \"index\": [\n \"my-index-000001\",\n \"my-index-000002\"\n ]\n },\n \"dest\": {\n \"index\": \"my-new-index-000002\"\n }\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->reindex([\n \"body\" => [\n \"source\" => [\n \"index\" => array(\n \"my-index-000001\",\n \"my-index-000002\",\n ),\n ],\n \"dest\" => [\n \"index\" => \"my-new-index-000002\",\n ],\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"source\":{\"index\":[\"my-index-000001\",\"my-index-000002\"]},\"dest\":{\"index\":\"my-new-index-000002\"}}' \"$ELASTICSEARCH_URL/_reindex\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.reindex(r -> r\n .dest(d -> d\n .index(\"my-new-index-000002\")\n )\n .source(s -> s\n .index(List.of(\"my-index-000001\",\"my-index-000002\"))\n )\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_render/template/{id}": {
+ "post": {
+ "tags": [
+ "search"
+ ],
+ "summary": "Render a search template\n",
+ "description": "**All methods and paths for this operation:**\n\n\n GET\n /_render/template\n
\n \n POST\n /_render/template\n
\n \n GET\n /_render/template/{id}\n
\n \n POST\n /_render/template/{id}\n
\n \n\nRender a search template as a search request body.\n\n## Required authorization\n\n* Index privileges: `read`\n",
+ "operationId": "render-search-template",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/render_search_template-id"
+ }
+ ],
+ "requestBody": {
+ "$ref": "#/components/requestBodies/render_search_template"
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/render_search_template-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _render/template\n{\n \"id\": \"my-search-template\",\n \"params\": {\n \"query_string\": \"hello world\",\n \"from\": 20,\n \"size\": 10\n }\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.render_search_template(\n id=\"my-search-template\",\n params={\n \"query_string\": \"hello world\",\n \"from\": 20,\n \"size\": 10\n },\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.renderSearchTemplate({\n id: \"my-search-template\",\n params: {\n query_string: \"hello world\",\n from: 20,\n size: 10,\n },\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.render_search_template(\n body: {\n \"id\": \"my-search-template\",\n \"params\": {\n \"query_string\": \"hello world\",\n \"from\": 20,\n \"size\": 10\n }\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->renderSearchTemplate([\n \"body\" => [\n \"id\" => \"my-search-template\",\n \"params\" => [\n \"query_string\" => \"hello world\",\n \"from\" => 20,\n \"size\" => 10,\n ],\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"id\":\"my-search-template\",\"params\":{\"query_string\":\"hello world\",\"from\":20,\"size\":10}}' \"$ELASTICSEARCH_URL/_render/template\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.renderSearchTemplate(r -> r\n .id(\"my-search-template\")\n .params(Map.of(\"size\", JsonData.fromJson(\"10\"),\"from\", JsonData.fromJson(\"20\"),\"query_string\", JsonData.fromJson(\"\\\"hello world\\\"\")))\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_scripts/painless/_execute": {
+ "post": {
+ "tags": [
+ "script"
+ ],
+ "summary": "Run a script\n",
+ "description": "**All methods and paths for this operation:**\n\n\n GET\n /_scripts/painless/_execute\n
\n \n POST\n /_scripts/painless/_execute\n
\n \n\nRuns a script and returns a result.\nUse this API to build and test scripts, such as when defining a script for a runtime field.\nThis API requires very few dependencies and is especially useful if you don't have permissions to write documents on a cluster.\n\nThe API uses several _contexts_, which control how scripts are run, what variables are available at runtime, and what the return type is.\n\nEach context requires a script, but additional parameters depend on the context you're using for that script.",
+ "operationId": "scripts-painless-execute",
+ "requestBody": {
+ "$ref": "#/components/requestBodies/scripts_painless_execute"
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/scripts_painless_execute-200"
+ }
+ },
+ "x-state": "Technical preview",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST /_scripts/painless/_execute\n{\n \"script\": {\n \"source\": \"params.count / params.total\",\n \"params\": {\n \"count\": 100.0,\n \"total\": 1000.0\n }\n }\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.scripts_painless_execute(\n script={\n \"source\": \"params.count / params.total\",\n \"params\": {\n \"count\": 100,\n \"total\": 1000\n }\n },\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.scriptsPainlessExecute({\n script: {\n source: \"params.count / params.total\",\n params: {\n count: 100,\n total: 1000,\n },\n },\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.scripts_painless_execute(\n body: {\n \"script\": {\n \"source\": \"params.count / params.total\",\n \"params\": {\n \"count\": 100,\n \"total\": 1000\n }\n }\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->scriptsPainlessExecute([\n \"body\" => [\n \"script\" => [\n \"source\" => \"params.count / params.total\",\n \"params\" => [\n \"count\" => 100,\n \"total\" => 1000,\n ],\n ],\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"script\":{\"source\":\"params.count / params.total\",\"params\":{\"count\":100,\"total\":1000}}}' \"$ELASTICSEARCH_URL/_scripts/painless/_execute\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.scriptsPainlessExecute(s -> s\n .script(sc -> sc\n .source(so -> so\n .scriptString(\"params.count / params.total\")\n )\n .params(Map.of(\"total\", JsonData.fromJson(\"1000\"),\"count\", JsonData.fromJson(\"100\")))\n )\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/{index}/_search": {
+ "post": {
+ "tags": [
+ "search"
+ ],
+ "summary": "Run a search\n",
+ "description": "**All methods and paths for this operation:**\n\n\n GET\n /_search\n
\n \n POST\n /_search\n
\n \n GET\n /{index}/_search\n
\n \n POST\n /{index}/_search\n
\n \n\nGet search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.\n\nIf the Elasticsearch security features are enabled, you must have the read index privilege for the target data stream, index, or alias. For cross-cluster search, refer to the documentation about configuring CCS privileges.\nTo search a point in time (PIT) for an alias, you must have the `read` index privilege for the alias's data streams or indices.\n\n**Search slicing**\n\nWhen paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently with the `slice` and `pit` properties.\nBy default the splitting is done first on the shards, then locally on each shard.\nThe local splitting partitions the shard into contiguous ranges based on Lucene document IDs.\n\nFor instance if the number of shards is equal to 2 and you request 4 slices, the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard.\n\nIMPORTANT: The same point-in-time ID should be used for all slices.\nIf different PIT IDs are used, slices can overlap and miss documents.\nThis situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.\n\n## Required authorization\n\n* Index privileges: `read`\n",
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/deploy-manage/remote-clusters/remote-clusters-cert#remote-clusters-privileges-ccs",
+ "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/search-search.html"
+ },
+ "operationId": "search",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/search-index"
+ },
+ {
+ "$ref": "#/components/parameters/search-allow_no_indices"
+ },
+ {
+ "$ref": "#/components/parameters/search-allow_partial_search_results"
+ },
+ {
+ "$ref": "#/components/parameters/search-analyzer"
+ },
+ {
+ "$ref": "#/components/parameters/search-analyze_wildcard"
+ },
+ {
+ "$ref": "#/components/parameters/search-batched_reduce_size"
+ },
+ {
+ "$ref": "#/components/parameters/search-ccs_minimize_roundtrips"
+ },
+ {
+ "$ref": "#/components/parameters/search-default_operator"
+ },
+ {
+ "$ref": "#/components/parameters/search-df"
+ },
+ {
+ "$ref": "#/components/parameters/search-docvalue_fields"
+ },
+ {
+ "$ref": "#/components/parameters/search-expand_wildcards"
+ },
+ {
+ "$ref": "#/components/parameters/search-explain"
+ },
+ {
+ "$ref": "#/components/parameters/search-ignore_throttled"
+ },
+ {
+ "$ref": "#/components/parameters/search-ignore_unavailable"
+ },
+ {
+ "$ref": "#/components/parameters/search-include_named_queries_score"
+ },
+ {
+ "$ref": "#/components/parameters/search-lenient"
+ },
+ {
+ "$ref": "#/components/parameters/search-max_concurrent_shard_requests"
+ },
+ {
+ "$ref": "#/components/parameters/search-preference"
+ },
+ {
+ "$ref": "#/components/parameters/search-pre_filter_shard_size"
+ },
+ {
+ "$ref": "#/components/parameters/search-request_cache"
+ },
+ {
+ "$ref": "#/components/parameters/search-routing"
+ },
+ {
+ "$ref": "#/components/parameters/search-scroll"
+ },
+ {
+ "$ref": "#/components/parameters/search-search_type"
+ },
+ {
+ "$ref": "#/components/parameters/search-stats"
+ },
+ {
+ "$ref": "#/components/parameters/search-stored_fields"
+ },
+ {
+ "$ref": "#/components/parameters/search-suggest_field"
+ },
+ {
+ "$ref": "#/components/parameters/search-suggest_mode"
+ },
+ {
+ "$ref": "#/components/parameters/search-suggest_size"
+ },
+ {
+ "$ref": "#/components/parameters/search-suggest_text"
+ },
+ {
+ "$ref": "#/components/parameters/search-terminate_after"
+ },
+ {
+ "$ref": "#/components/parameters/search-timeout"
+ },
+ {
+ "$ref": "#/components/parameters/search-track_total_hits"
+ },
+ {
+ "$ref": "#/components/parameters/search-track_scores"
+ },
+ {
+ "$ref": "#/components/parameters/search-typed_keys"
+ },
+ {
+ "$ref": "#/components/parameters/search-rest_total_hits_as_int"
+ },
+ {
+ "$ref": "#/components/parameters/search-version"
+ },
+ {
+ "$ref": "#/components/parameters/search-_source"
+ },
+ {
+ "$ref": "#/components/parameters/search-_source_excludes"
+ },
+ {
+ "$ref": "#/components/parameters/search-_source_exclude_vectors"
+ },
+ {
+ "$ref": "#/components/parameters/search-_source_includes"
+ },
+ {
+ "$ref": "#/components/parameters/search-seq_no_primary_term"
+ },
+ {
+ "$ref": "#/components/parameters/search-q"
+ },
+ {
+ "$ref": "#/components/parameters/search-size"
+ },
+ {
+ "$ref": "#/components/parameters/search-from"
+ },
+ {
+ "$ref": "#/components/parameters/search-sort"
+ }
+ ],
+ "requestBody": {
+ "$ref": "#/components/requestBodies/search"
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/search-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET /my-index-000001/_search?from=40&size=20\n{\n \"query\": {\n \"term\": {\n \"user.id\": \"kimchy\"\n }\n }\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.search(\n index=\"my-index-000001\",\n from=\"40\",\n size=\"20\",\n query={\n \"term\": {\n \"user.id\": \"kimchy\"\n }\n },\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.search({\n index: \"my-index-000001\",\n from: 40,\n size: 20,\n query: {\n term: {\n \"user.id\": \"kimchy\",\n },\n },\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.search(\n index: \"my-index-000001\",\n from: \"40\",\n size: \"20\",\n body: {\n \"query\": {\n \"term\": {\n \"user.id\": \"kimchy\"\n }\n }\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->search([\n \"index\" => \"my-index-000001\",\n \"from\" => \"40\",\n \"size\" => \"20\",\n \"body\" => [\n \"query\" => [\n \"term\" => [\n \"user.id\" => \"kimchy\",\n ],\n ],\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"query\":{\"term\":{\"user.id\":\"kimchy\"}}}' \"$ELASTICSEARCH_URL/my-index-000001/_search?from=40&size=20\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.search(s -> s\n .from(40)\n .index(\"my-index-000001\")\n .query(q -> q\n .term(t -> t\n .field(\"user.id\")\n .value(FieldValue.of(\"kimchy\"))\n )\n )\n .size(20)\n,Void.class);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_application/search_application/{name}": {
+ "get": {
+ "tags": [
+ "search_application"
+ ],
+ "summary": "Get search application details",
+ "description": "\n\n## Required authorization\n\n* Cluster privileges: `manage_search_application`\n",
+ "operationId": "search-application-get",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "name",
+ "description": "The name of the search application",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Name"
+ },
+ "style": "simple"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/search_application._types.SearchApplication"
+ },
+ "examples": {
+ "SearchApplicationGetResponseExample1": {
+ "description": "A sucessful response from `GET _application/search_application/my-app/`.",
+ "value": "{\n \"name\": \"my-app\",\n \"indices\": [ \"index1\", \"index2\" ],\n \"updated_at_millis\": 1682105622204,\n \"template\": {\n \"script\": {\n \"source\": {\n \"query\": {\n \"query_string\": {\n \"query\": \"{{query_string}}\",\n \"default_field\": \"{{default_field}}\"\n }\n }\n },\n \"lang\": \"mustache\",\n \"options\": {\n \"content_type\": \"application/json;charset=utf-8\"\n },\n \"params\": {\n \"query_string\": \"*\",\n \"default_field\": \"*\"\n }\n }\n }\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Beta",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET _application/search_application/my-app/\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.search_application.get(\n name=\"my-app\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.searchApplication.get({\n name: \"my-app\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.search_application.get(\n name: \"my-app\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->searchApplication()->get([\n \"name\" => \"my-app\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_application/search_application/my-app/\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.searchApplication().get(g -> g\n .name(\"my-app\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "search_application"
+ ],
+ "summary": "Create or update a search application",
+ "description": "\n\n## Required authorization\n\n* Index privileges: `manage`\n* Cluster privileges: `manage_search_application`\n",
+ "operationId": "search-application-put",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "name",
+ "description": "The name of the search application to be created or updated.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Name"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "create",
+ "description": "If `true`, this request cannot replace or update existing Search Applications.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/search_application._types.SearchApplicationParameters"
+ },
+ "examples": {
+ "SearchApplicationPutRequestExample1": {
+ "description": "Run `PUT _application/search_application/my-app` to create or update a search application called `my-app`. When the dictionary parameter is specified, the search application search API will perform the following parameter validation: it accepts only the `query_string` and `default_field` parameters; it verifies that `query_string` and `default_field` are both strings; it accepts `default_field` only if it takes the values title or description. If the parameters are not valid, the search application search API will return an error.\n",
+ "value": "{\n \"indices\": [ \"index1\", \"index2\" ],\n \"template\": {\n \"script\": {\n \"source\": {\n \"query\": {\n \"query_string\": {\n \"query\": \"{{query_string}}\",\n \"default_field\": \"{{default_field}}\"\n }\n }\n },\n \"params\": {\n \"query_string\": \"*\",\n \"default_field\": \"*\"\n }\n },\n \"dictionary\": {\n \"properties\": {\n \"query_string\": {\n \"type\": \"string\"\n },\n \"default_field\": {\n \"type\": \"string\",\n \"enum\": [\n \"title\",\n \"description\"\n ]\n },\n \"additionalProperties\": false\n },\n \"required\": [\n \"query_string\"\n ]\n }\n }\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "result": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Result"
+ }
+ ]
+ }
+ },
+ "required": [
+ "result"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Beta",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "PUT _application/search_application/my-app\n{\n \"indices\": [ \"index1\", \"index2\" ],\n \"template\": {\n \"script\": {\n \"source\": {\n \"query\": {\n \"query_string\": {\n \"query\": \"{{query_string}}\",\n \"default_field\": \"{{default_field}}\"\n }\n }\n },\n \"params\": {\n \"query_string\": \"*\",\n \"default_field\": \"*\"\n }\n },\n \"dictionary\": {\n \"properties\": {\n \"query_string\": {\n \"type\": \"string\"\n },\n \"default_field\": {\n \"type\": \"string\",\n \"enum\": [\n \"title\",\n \"description\"\n ]\n },\n \"additionalProperties\": false\n },\n \"required\": [\n \"query_string\"\n ]\n }\n }\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.search_application.put(\n name=\"my-app\",\n search_application={\n \"indices\": [\n \"index1\",\n \"index2\"\n ],\n \"template\": {\n \"script\": {\n \"source\": {\n \"query\": {\n \"query_string\": {\n \"query\": \"{{query_string}}\",\n \"default_field\": \"{{default_field}}\"\n }\n }\n },\n \"params\": {\n \"query_string\": \"*\",\n \"default_field\": \"*\"\n }\n },\n \"dictionary\": {\n \"properties\": {\n \"query_string\": {\n \"type\": \"string\"\n },\n \"default_field\": {\n \"type\": \"string\",\n \"enum\": [\n \"title\",\n \"description\"\n ]\n },\n \"additionalProperties\": False\n },\n \"required\": [\n \"query_string\"\n ]\n }\n }\n },\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.searchApplication.put({\n name: \"my-app\",\n search_application: {\n indices: [\"index1\", \"index2\"],\n template: {\n script: {\n source: {\n query: {\n query_string: {\n query: \"{{query_string}}\",\n default_field: \"{{default_field}}\",\n },\n },\n },\n params: {\n query_string: \"*\",\n default_field: \"*\",\n },\n },\n dictionary: {\n properties: {\n query_string: {\n type: \"string\",\n },\n default_field: {\n type: \"string\",\n enum: [\"title\", \"description\"],\n },\n additionalProperties: false,\n },\n required: [\"query_string\"],\n },\n },\n },\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.search_application.put(\n name: \"my-app\",\n body: {\n \"indices\": [\n \"index1\",\n \"index2\"\n ],\n \"template\": {\n \"script\": {\n \"source\": {\n \"query\": {\n \"query_string\": {\n \"query\": \"{{query_string}}\",\n \"default_field\": \"{{default_field}}\"\n }\n }\n },\n \"params\": {\n \"query_string\": \"*\",\n \"default_field\": \"*\"\n }\n },\n \"dictionary\": {\n \"properties\": {\n \"query_string\": {\n \"type\": \"string\"\n },\n \"default_field\": {\n \"type\": \"string\",\n \"enum\": [\n \"title\",\n \"description\"\n ]\n },\n \"additionalProperties\": false\n },\n \"required\": [\n \"query_string\"\n ]\n }\n }\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->searchApplication()->put([\n \"name\" => \"my-app\",\n \"body\" => [\n \"indices\" => array(\n \"index1\",\n \"index2\",\n ),\n \"template\" => [\n \"script\" => [\n \"source\" => [\n \"query\" => [\n \"query_string\" => [\n \"query\" => \"{{query_string}}\",\n \"default_field\" => \"{{default_field}}\",\n ],\n ],\n ],\n \"params\" => [\n \"query_string\" => \"*\",\n \"default_field\" => \"*\",\n ],\n ],\n \"dictionary\" => [\n \"properties\" => [\n \"query_string\" => [\n \"type\" => \"string\",\n ],\n \"default_field\" => [\n \"type\" => \"string\",\n \"enum\" => array(\n \"title\",\n \"description\",\n ),\n ],\n \"additionalProperties\" => false,\n ],\n \"required\" => array(\n \"query_string\",\n ),\n ],\n ],\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"indices\":[\"index1\",\"index2\"],\"template\":{\"script\":{\"source\":{\"query\":{\"query_string\":{\"query\":\"{{query_string}}\",\"default_field\":\"{{default_field}}\"}}},\"params\":{\"query_string\":\"*\",\"default_field\":\"*\"}},\"dictionary\":{\"properties\":{\"query_string\":{\"type\":\"string\"},\"default_field\":{\"type\":\"string\",\"enum\":[\"title\",\"description\"]},\"additionalProperties\":false},\"required\":[\"query_string\"]}}}' \"$ELASTICSEARCH_URL/_application/search_application/my-app\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.searchApplication().put(p -> p\n .name(\"my-app\")\n .searchApplication(s -> s\n .indices(List.of(\"index1\",\"index2\"))\n .template(t -> t\n .script(sc -> sc\n .source(so -> so\n .scriptTemplate(scr -> scr\n .query(q -> q\n .queryString(qu -> qu\n .defaultField(\"{{default_field}}\")\n .query(\"{{query_string}}\")\n )\n )\n )\n )\n .params(Map.of(\"default_field\", JsonData.fromJson(\"\\\"*\\\"\"),\"query_string\", JsonData.fromJson(\"\\\"*\\\"\")))\n )\n )\n )\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "search_application"
+ ],
+ "summary": "Delete a search application",
+ "description": "Remove a search application and its associated alias. Indices attached to the search application are not removed.\n\n## Required authorization\n\n* Index privileges: `manage`\n* Cluster privileges: `manage_search_application`\n",
+ "operationId": "search-application-delete",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "name",
+ "description": "The name of the search application to delete.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Name"
+ },
+ "style": "simple"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Beta",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "DELETE _application/search_application/my-app/\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.search_application.delete(\n name=\"my-app\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.searchApplication.delete({\n name: \"my-app\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.search_application.delete(\n name: \"my-app\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->searchApplication()->delete([\n \"name\" => \"my-app\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_application/search_application/my-app/\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.searchApplication().delete(d -> d\n .name(\"my-app\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_application/analytics/{name}": {
+ "get": {
+ "tags": [
+ "analytics"
+ ],
+ "summary": "Get behavioral analytics collections\n",
+ "description": "**All methods and paths for this operation:**\n\n\n GET\n /_application/analytics\n
\n \n GET\n /_application/analytics/{name}\n
",
+ "operationId": "search-application-get-behavioral-analytics",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/search_application.get_behavioral_analytics-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/search_application.get_behavioral_analytics-200"
+ }
+ },
+ "deprecated": true,
+ "x-state": "Technical preview",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET _application/analytics/my*\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.search_application.get_behavioral_analytics(\n name=\"my*\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.searchApplication.getBehavioralAnalytics({\n name: \"my*\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.search_application.get_behavioral_analytics(\n name: \"my*\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->searchApplication()->getBehavioralAnalytics([\n \"name\" => \"my*\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_application/analytics/my*\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.searchApplication().getBehavioralAnalytics(g -> g\n .name(\"my*\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "analytics"
+ ],
+ "summary": "Create a behavioral analytics collection",
+ "operationId": "search-application-put-behavioral-analytics",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "name",
+ "description": "The name of the analytics collection to be created or updated.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Name"
+ },
+ "style": "simple"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/search_application.put_behavioral_analytics.AnalyticsAcknowledgeResponseBase"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": true,
+ "x-state": "Technical preview",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "PUT _application/analytics/my_analytics_collection\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.search_application.put_behavioral_analytics(\n name=\"my_analytics_collection\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.searchApplication.putBehavioralAnalytics({\n name: \"my_analytics_collection\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.search_application.put_behavioral_analytics(\n name: \"my_analytics_collection\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->searchApplication()->putBehavioralAnalytics([\n \"name\" => \"my_analytics_collection\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_application/analytics/my_analytics_collection\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.searchApplication().putBehavioralAnalytics(p -> p\n .name(\"my_analytics_collection\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "analytics"
+ ],
+ "summary": "Delete a behavioral analytics collection",
+ "description": "The associated data stream is also deleted.",
+ "operationId": "search-application-delete-behavioral-analytics",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "name",
+ "description": "The name of the analytics collection to be deleted",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Name"
+ },
+ "style": "simple"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": true,
+ "x-state": "Technical preview",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "DELETE _application/analytics/my_analytics_collection/\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.search_application.delete_behavioral_analytics(\n name=\"my_analytics_collection\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.searchApplication.deleteBehavioralAnalytics({\n name: \"my_analytics_collection\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.search_application.delete_behavioral_analytics(\n name: \"my_analytics_collection\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->searchApplication()->deleteBehavioralAnalytics([\n \"name\" => \"my_analytics_collection\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_application/analytics/my_analytics_collection/\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.searchApplication().deleteBehavioralAnalytics(d -> d\n .name(\"my_analytics_collection\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_application/search_application": {
+ "get": {
+ "tags": [
+ "search_application"
+ ],
+ "summary": "Get search applications",
+ "description": "Get information about search applications.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_application`\n",
+ "operationId": "search-application-list",
+ "parameters": [
+ {
+ "in": "query",
+ "name": "q",
+ "description": "Query in the Lucene query string syntax.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "from",
+ "description": "Starting offset.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "size",
+ "description": "Specifies a max number of results to get.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number"
+ },
+ "results": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/search_application._types.SearchApplication"
+ }
+ }
+ },
+ "required": [
+ "count",
+ "results"
+ ]
+ },
+ "examples": {
+ "SearchApplicationsListResponseExample1": {
+ "description": "A succesful response from `GET _application/search_application?from=0&size=3&q=app*` returns the first three search applications whose names start with `app`.",
+ "value": "{\n \"count\": 2,\n \"results\": [\n {\n \"name\": \"app-1\",\n \"updated_at_millis\": 1690981129366\n },\n {\n \"name\": \"app-2\",\n \"updated_at_millis\": 1691501823939\n }\n ]\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Beta",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET _application/search_application?from=0&size=3&q=app*\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.search_application.list(\n from=\"0\",\n size=\"3\",\n q=\"app*\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.searchApplication.list({\n from: 0,\n size: 3,\n q: \"app*\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.search_application.list(\n from: \"0\",\n size: \"3\",\n q: \"app*\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->searchApplication()->list([\n \"from\" => \"0\",\n \"size\" => \"3\",\n \"q\" => \"app*\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_application/search_application?from=0&size=3&q=app*\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.searchApplication().list(l -> l\n .from(0)\n .q(\"app*\")\n .size(3)\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_application/search_application/{name}/_search": {
+ "post": {
+ "tags": [
+ "search_application"
+ ],
+ "summary": "Run a search application search\n",
+ "description": "**All methods and paths for this operation:**\n\n\n GET\n /_application/search_application/{name}/_search\n
\n \n POST\n /_application/search_application/{name}/_search\n
\n \n\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.",
+ "operationId": "search-application-search",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/search_application.search-name"
+ },
+ {
+ "$ref": "#/components/parameters/search_application.search-typed_keys"
+ }
+ ],
+ "requestBody": {
+ "$ref": "#/components/requestBodies/search_application.search"
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/search_application.search-200"
+ }
+ },
+ "x-state": "Beta",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _application/search_application/my-app/_search\n{\n \"params\": {\n \"query_string\": \"my first query\",\n \"text_fields\": [\n {\"name\": \"title\", \"boost\": 5},\n {\"name\": \"description\", \"boost\": 1}\n ]\n }\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.search_application.search(\n name=\"my-app\",\n params={\n \"query_string\": \"my first query\",\n \"text_fields\": [\n {\n \"name\": \"title\",\n \"boost\": 5\n },\n {\n \"name\": \"description\",\n \"boost\": 1\n }\n ]\n },\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.searchApplication.search({\n name: \"my-app\",\n params: {\n query_string: \"my first query\",\n text_fields: [\n {\n name: \"title\",\n boost: 5,\n },\n {\n name: \"description\",\n boost: 1,\n },\n ],\n },\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.search_application.search(\n name: \"my-app\",\n body: {\n \"params\": {\n \"query_string\": \"my first query\",\n \"text_fields\": [\n {\n \"name\": \"title\",\n \"boost\": 5\n },\n {\n \"name\": \"description\",\n \"boost\": 1\n }\n ]\n }\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->searchApplication()->search([\n \"name\" => \"my-app\",\n \"body\" => [\n \"params\" => [\n \"query_string\" => \"my first query\",\n \"text_fields\" => array(\n [\n \"name\" => \"title\",\n \"boost\" => 5,\n ],\n [\n \"name\" => \"description\",\n \"boost\" => 1,\n ],\n ),\n ],\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"params\":{\"query_string\":\"my first query\",\"text_fields\":[{\"name\":\"title\",\"boost\":5},{\"name\":\"description\",\"boost\":1}]}}' \"$ELASTICSEARCH_URL/_application/search_application/my-app/_search\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.searchApplication().search(s -> s\n .name(\"my-app\")\n .params(Map.of(\"text_fields\", JsonData.fromJson(\"[{\\\"name\\\":\\\"title\\\",\\\"boost\\\":5},{\\\"name\\\":\\\"description\\\",\\\"boost\\\":1}]\"),\"query_string\", JsonData.fromJson(\"\\\"my first query\\\"\")))\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/{index}/_mvt/{field}/{zoom}/{x}/{y}": {
+ "get": {
+ "tags": [
+ "search"
+ ],
+ "summary": "Search a vector tile\n",
+ "description": "**All methods and paths for this operation:**\n\n\n POST\n /{index}/_mvt/{field}/{zoom}/{x}/{y}\n
\n \n GET\n /{index}/_mvt/{field}/{zoom}/{x}/{y}\n
\n \n\nSearch a vector tile for geospatial values.\nBefore using this API, you should be familiar with the Mapbox vector tile specification.\nThe API returns results as a binary mapbox vector tile.\n\nInternally, Elasticsearch translates a vector tile search API request into a search containing:\n\n* A `geo_bounding_box` query on the ``. The query uses the `//` tile as a bounding box.\n* A `geotile_grid` or `geohex_grid` aggregation on the ``. The `grid_agg` parameter determines the aggregation type. The aggregation uses the `//` tile as a bounding box.\n* Optionally, a `geo_bounds` aggregation on the ``. The search only includes this aggregation if the `exact_bounds` parameter is `true`.\n* If the optional parameter `with_labels` is `true`, the internal search will include a dynamic runtime field that calls the `getLabelPosition` function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label.\n\nThe API returns results as a binary Mapbox vector tile.\nMapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers:\n\n* A `hits` layer containing a feature for each `` value matching the `geo_bounding_box` query.\n* An `aggs` layer containing a feature for each cell of the `geotile_grid` or `geohex_grid`. The layer only contains features for cells with matching data.\n* A meta layer containing:\n * A feature containing a bounding box. By default, this is the bounding box of the tile.\n * Value ranges for any sub-aggregations on the `geotile_grid` or `geohex_grid`.\n * Metadata for the search.\n\nThe API only returns features that can display at its zoom level.\nFor example, if a polygon feature has no area at its zoom level, the API omits it.\nThe API returns errors as UTF-8 encoded JSON.\n\nIMPORTANT: You can specify several options for this API as either a query parameter or request body parameter.\nIf you specify both parameters, the query parameter takes precedence.\n\n**Grid precision for geotile**\n\nFor a `grid_agg` of `geotile`, you can use cells in the `aggs` layer as tiles for lower zoom levels.\n`grid_precision` represents the additional zoom levels available through these cells. The final precision is computed by as follows: ` + grid_precision`.\nFor example, if `` is 7 and `grid_precision` is 8, then the `geotile_grid` aggregation will use a precision of 15.\nThe maximum final precision is 29.\nThe `grid_precision` also determines the number of cells for the grid as follows: `(2^grid_precision) x (2^grid_precision)`.\nFor example, a value of 8 divides the tile into a grid of 256 x 256 cells.\nThe `aggs` layer only contains features for cells with matching data.\n\n**Grid precision for geohex**\n\nFor a `grid_agg` of `geohex`, Elasticsearch uses `` and `grid_precision` to calculate a final precision as follows: ` + grid_precision`.\n\nThis precision determines the H3 resolution of the hexagonal cells produced by the `geohex` aggregation.\nThe following table maps the H3 resolution for each precision.\nFor example, if `` is 3 and `grid_precision` is 3, the precision is 6.\nAt a precision of 6, hexagonal cells have an H3 resolution of 2.\nIf `` is 3 and `grid_precision` is 4, the precision is 7.\nAt a precision of 7, hexagonal cells have an H3 resolution of 3.\n\n| Precision | Unique tile bins | H3 resolution | Unique hex bins |\tRatio |\n| --------- | ---------------- | ------------- | ----------------| ----- |\n| 1 | 4 | 0 | 122 | 30.5 |\n| 2 | 16 | 0 | 122 | 7.625 |\n| 3 | 64 | 1 | 842 | 13.15625 |\n| 4 | 256 | 1 | 842 | 3.2890625 |\n| 5 | 1024 | 2 | 5882 | 5.744140625 |\n| 6 | 4096 | 2 | 5882 | 1.436035156 |\n| 7 | 16384 | 3 | 41162 | 2.512329102 |\n| 8 | 65536 | 3 | 41162 | 0.6280822754 |\n| 9 | 262144 | 4 | 288122 | 1.099098206 |\n| 10 | 1048576 | 4 | 288122 | 0.2747745514 |\n| 11 | 4194304 | 5 | 2016842 | 0.4808526039 |\n| 12 | 16777216 | 6 | 14117882 | 0.8414913416 |\n| 13 | 67108864 | 6 | 14117882 | 0.2103728354 |\n| 14 | 268435456 | 7 | 98825162 | 0.3681524172 |\n| 15 | 1073741824 | 8 | 691776122 | 0.644266719 |\n| 16 | 4294967296 | 8 | 691776122 | 0.1610666797 |\n| 17 | 17179869184 | 9 | 4842432842 | 0.2818666889 |\n| 18 | 68719476736 | 10 | 33897029882 | 0.4932667053 |\n| 19 | 274877906944 | 11 | 237279209162 | 0.8632167343 |\n| 20 | 1099511627776 | 11 | 237279209162 | 0.2158041836 |\n| 21 | 4398046511104 | 12 | 1660954464122 | 0.3776573213 |\n| 22 | 17592186044416 | 13 | 11626681248842 | 0.6609003122 |\n| 23 | 70368744177664 | 13 | 11626681248842 | 0.165225078 |\n| 24 | 281474976710656 | 14 | 81386768741882 | 0.2891438866 |\n| 25 | 1125899906842620 | 15 | 569707381193162 | 0.5060018015 |\n| 26 | 4503599627370500 | 15 | 569707381193162 | 0.1265004504 |\n| 27 | 18014398509482000 | 15 | 569707381193162 | 0.03162511259 |\n| 28 | 72057594037927900 | 15 | 569707381193162 | 0.007906278149 |\n| 29 | 288230376151712000 | 15 | 569707381193162 | 0.001976569537 |\n\nHexagonal cells don't align perfectly on a vector tile.\nSome cells may intersect more than one vector tile.\nTo compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level.\nElasticsearch uses the H3 resolution that is closest to the corresponding geotile density.\n\nLearn how to use the vector tile search API with practical examples in the [Vector tile search examples](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/vector-tile-search) guide.\n\n## Required authorization\n\n* Index privileges: `read`\n",
+ "externalDocs": {
+ "url": "https://github.com/mapbox/vector-tile-spec/blob/master/README.md",
+ "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/search-vector-tile-api.html"
+ },
+ "operationId": "search-mvt",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/search_mvt-index"
+ },
+ {
+ "$ref": "#/components/parameters/search_mvt-field"
+ },
+ {
+ "$ref": "#/components/parameters/search_mvt-zoom"
+ },
+ {
+ "$ref": "#/components/parameters/search_mvt-x"
+ },
+ {
+ "$ref": "#/components/parameters/search_mvt-y"
+ },
+ {
+ "$ref": "#/components/parameters/search_mvt-exact_bounds"
+ },
+ {
+ "$ref": "#/components/parameters/search_mvt-extent"
+ },
+ {
+ "$ref": "#/components/parameters/search_mvt-grid_agg"
+ },
+ {
+ "$ref": "#/components/parameters/search_mvt-grid_precision"
+ },
+ {
+ "$ref": "#/components/parameters/search_mvt-grid_type"
+ },
+ {
+ "$ref": "#/components/parameters/search_mvt-size"
+ },
+ {
+ "$ref": "#/components/parameters/search_mvt-track_total_hits"
+ },
+ {
+ "$ref": "#/components/parameters/search_mvt-with_labels"
+ }
+ ],
+ "requestBody": {
+ "$ref": "#/components/requestBodies/search_mvt"
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/search_mvt-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET museums/_mvt/location/13/4207/2692\n{\n \"grid_agg\": \"geotile\",\n \"grid_precision\": 2,\n \"fields\": [\n \"name\",\n \"price\"\n ],\n \"query\": {\n \"term\": {\n \"included\": true\n }\n },\n \"aggs\": {\n \"min_price\": {\n \"min\": {\n \"field\": \"price\"\n }\n },\n \"max_price\": {\n \"max\": {\n \"field\": \"price\"\n }\n },\n \"avg_price\": {\n \"avg\": {\n \"field\": \"price\"\n }\n }\n }\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.search_mvt(\n index=\"museums\",\n field=\"location\",\n zoom=\"13\",\n x=\"4207\",\n y=\"2692\",\n grid_agg=\"geotile\",\n grid_precision=2,\n fields=[\n \"name\",\n \"price\"\n ],\n query={\n \"term\": {\n \"included\": True\n }\n },\n aggs={\n \"min_price\": {\n \"min\": {\n \"field\": \"price\"\n }\n },\n \"max_price\": {\n \"max\": {\n \"field\": \"price\"\n }\n },\n \"avg_price\": {\n \"avg\": {\n \"field\": \"price\"\n }\n }\n },\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.searchMvt({\n index: \"museums\",\n field: \"location\",\n zoom: 13,\n x: 4207,\n y: 2692,\n grid_agg: \"geotile\",\n grid_precision: 2,\n fields: [\"name\", \"price\"],\n query: {\n term: {\n included: true,\n },\n },\n aggs: {\n min_price: {\n min: {\n field: \"price\",\n },\n },\n max_price: {\n max: {\n field: \"price\",\n },\n },\n avg_price: {\n avg: {\n field: \"price\",\n },\n },\n },\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.search_mvt(\n index: \"museums\",\n field: \"location\",\n zoom: \"13\",\n x: \"4207\",\n y: \"2692\",\n body: {\n \"grid_agg\": \"geotile\",\n \"grid_precision\": 2,\n \"fields\": [\n \"name\",\n \"price\"\n ],\n \"query\": {\n \"term\": {\n \"included\": true\n }\n },\n \"aggs\": {\n \"min_price\": {\n \"min\": {\n \"field\": \"price\"\n }\n },\n \"max_price\": {\n \"max\": {\n \"field\": \"price\"\n }\n },\n \"avg_price\": {\n \"avg\": {\n \"field\": \"price\"\n }\n }\n }\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->searchMvt([\n \"index\" => \"museums\",\n \"field\" => \"location\",\n \"zoom\" => \"13\",\n \"x\" => \"4207\",\n \"y\" => \"2692\",\n \"body\" => [\n \"grid_agg\" => \"geotile\",\n \"grid_precision\" => 2,\n \"fields\" => array(\n \"name\",\n \"price\",\n ),\n \"query\" => [\n \"term\" => [\n \"included\" => true,\n ],\n ],\n \"aggs\" => [\n \"min_price\" => [\n \"min\" => [\n \"field\" => \"price\",\n ],\n ],\n \"max_price\" => [\n \"max\" => [\n \"field\" => \"price\",\n ],\n ],\n \"avg_price\" => [\n \"avg\" => [\n \"field\" => \"price\",\n ],\n ],\n ],\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"grid_agg\":\"geotile\",\"grid_precision\":2,\"fields\":[\"name\",\"price\"],\"query\":{\"term\":{\"included\":true}},\"aggs\":{\"min_price\":{\"min\":{\"field\":\"price\"}},\"max_price\":{\"max\":{\"field\":\"price\"}},\"avg_price\":{\"avg\":{\"field\":\"price\"}}}}' \"$ELASTICSEARCH_URL/museums/_mvt/location/13/4207/2692\""
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/{index}/_search/template": {
+ "post": {
+ "tags": [
+ "search"
+ ],
+ "summary": "Run a search with a search template\n",
+ "description": "**All methods and paths for this operation:**\n\n\n GET\n /_search/template\n
\n \n POST\n /_search/template\n
\n \n GET\n /{index}/_search/template\n
\n \n POST\n /{index}/_search/template\n
\n\n## Required authorization\n\n* Index privileges: `read`\n",
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/solutions/search/search-templates",
+ "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/search-template-api.html"
+ },
+ "operationId": "search-template",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/search_template-index"
+ },
+ {
+ "$ref": "#/components/parameters/search_template-allow_no_indices"
+ },
+ {
+ "$ref": "#/components/parameters/search_template-ccs_minimize_roundtrips"
+ },
+ {
+ "$ref": "#/components/parameters/search_template-expand_wildcards"
+ },
+ {
+ "$ref": "#/components/parameters/search_template-explain"
+ },
+ {
+ "$ref": "#/components/parameters/search_template-ignore_throttled"
+ },
+ {
+ "$ref": "#/components/parameters/search_template-ignore_unavailable"
+ },
+ {
+ "$ref": "#/components/parameters/search_template-preference"
+ },
+ {
+ "$ref": "#/components/parameters/search_template-profile"
+ },
+ {
+ "$ref": "#/components/parameters/search_template-routing"
+ },
+ {
+ "$ref": "#/components/parameters/search_template-scroll"
+ },
+ {
+ "$ref": "#/components/parameters/search_template-search_type"
+ },
+ {
+ "$ref": "#/components/parameters/search_template-rest_total_hits_as_int"
+ },
+ {
+ "$ref": "#/components/parameters/search_template-typed_keys"
+ }
+ ],
+ "requestBody": {
+ "$ref": "#/components/requestBodies/search_template"
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/search_template-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET my-index/_search/template\n{\n \"id\": \"my-search-template\",\n \"params\": {\n \"query_string\": \"hello world\",\n \"from\": 0,\n \"size\": 10\n }\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.search_template(\n index=\"my-index\",\n id=\"my-search-template\",\n params={\n \"query_string\": \"hello world\",\n \"from\": 0,\n \"size\": 10\n },\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.searchTemplate({\n index: \"my-index\",\n id: \"my-search-template\",\n params: {\n query_string: \"hello world\",\n from: 0,\n size: 10,\n },\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.search_template(\n index: \"my-index\",\n body: {\n \"id\": \"my-search-template\",\n \"params\": {\n \"query_string\": \"hello world\",\n \"from\": 0,\n \"size\": 10\n }\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->searchTemplate([\n \"index\" => \"my-index\",\n \"body\" => [\n \"id\" => \"my-search-template\",\n \"params\" => [\n \"query_string\" => \"hello world\",\n \"from\" => 0,\n \"size\" => 10,\n ],\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"id\":\"my-search-template\",\"params\":{\"query_string\":\"hello world\",\"from\":0,\"size\":10}}' \"$ELASTICSEARCH_URL/my-index/_search/template\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.searchTemplate(s -> s\n .id(\"my-search-template\")\n .index(\"my-index\")\n .params(Map.of(\"size\", JsonData.fromJson(\"10\"),\"from\", JsonData.fromJson(\"0\"),\"query_string\", JsonData.fromJson(\"\\\"hello world\\\"\")))\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_security/_authenticate": {
+ "get": {
+ "tags": [
+ "security"
+ ],
+ "summary": "Authenticate a user",
+ "description": "Authenticates a user and returns information about the authenticated user.\nInclude the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication).\nA successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user.\nIf the user cannot be authenticated, this API returns a 401 status code.",
+ "operationId": "security-authenticate",
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "api_key": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/security.authenticate.AuthenticateApiKey"
+ }
+ ]
+ },
+ "authentication_realm": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/security._types.RealmInfo"
+ }
+ ]
+ },
+ "email": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "full_name": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "lookup_realm": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/security._types.RealmInfo"
+ }
+ ]
+ },
+ "metadata": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ },
+ "roles": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "username": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Username"
+ }
+ ]
+ },
+ "enabled": {
+ "type": "boolean"
+ },
+ "authentication_type": {
+ "type": "string"
+ },
+ "token": {
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/security.authenticate.Token"
+ }
+ ]
+ }
+ },
+ "required": [
+ "authentication_realm",
+ "lookup_realm",
+ "metadata",
+ "roles",
+ "username",
+ "enabled",
+ "authentication_type"
+ ]
+ },
+ "examples": {
+ "SecurityAuthenticateResponseExample1": {
+ "description": "A successful response from `GET /_security/_authenticate`.",
+ "value": "{\n \"username\": \"rdeniro\",\n \"roles\": [\n \"admin\"\n ],\n \"full_name\": null,\n \"email\": null,\n \"metadata\": { },\n \"enabled\": true,\n \"authentication_realm\": {\n \"name\" : \"file\",\n \"type\" : \"file\"\n },\n \"lookup_realm\": {\n \"name\" : \"file\",\n \"type\" : \"file\"\n },\n \"authentication_type\": \"realm\"\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET /_security/_authenticate\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.security.authenticate()"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.security.authenticate();"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.security.authenticate"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->security()->authenticate();"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/_authenticate\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.security().authenticate();\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_security/api_key": {
+ "get": {
+ "tags": [
+ "security"
+ ],
+ "summary": "Get API key information",
+ "description": "Retrieves information for one or more API keys.\nNOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.\nIf you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.\n\n## Required authorization\n\n* Cluster privileges: `manage_own_api_key`,`read_security`\n",
+ "operationId": "security-get-api-key",
+ "parameters": [
+ {
+ "in": "query",
+ "name": "id",
+ "description": "An API key id.\nThis parameter cannot be used with any of `name`, `realm_name` or `username`.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "name",
+ "description": "An API key name.\nThis parameter cannot be used with any of `id`, `realm_name` or `username`.\nIt supports prefix search with wildcard.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Name"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "owner",
+ "description": "A boolean flag that can be used to query API keys owned by the currently authenticated user.\nThe `realm_name` or `username` parameters cannot be specified when this parameter is set to `true` as they are assumed to be the currently authenticated ones.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "realm_name",
+ "description": "The name of an authentication realm.\nThis parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Name"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "username",
+ "description": "The username of a user.\nThis parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Username"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "with_limited_by",
+ "description": "Return the snapshot of the owner user's role descriptors\nassociated with the API key. An API key's actual\npermission is the intersection of its assigned role\ndescriptors and the owner user's role descriptors.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "x-state": "Generally available",
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "active_only",
+ "description": "A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, nor expired at query time. You can specify this together with other parameters such as `owner` or `name`. If `active_only` is false, the response will include both active and inactive (expired or invalidated) keys.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "x-state": "Generally available",
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "with_profile_uid",
+ "description": "Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "x-state": "Generally available",
+ "style": "form"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "api_keys": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/security._types.ApiKey"
+ }
+ }
+ },
+ "required": [
+ "api_keys"
+ ]
+ },
+ "examples": {
+ "SecurityGetApiKeyResponseExample1": {
+ "summary": "Get a key by ID",
+ "description": "A successful response from `GET /_security/api_key?id=VuaCfGcBCdbkQm-e5aOx&with_limited_by=true`.",
+ "value": "{\n \"api_keys\": [ \n {\n \"id\": \"VuaCfGcBCdbkQm-e5aOx\", \n \"name\": \"my-api-key\", \n \"creation\": 1548550550158, \n \"expiration\": 1548551550158, \n \"invalidated\": false, \n \"username\": \"myuser\", \n \"realm\": \"native1\", \n \"realm_type\": \"native\",\n \"metadata\": { \n \"application\": \"myapp\"\n },\n \"role_descriptors\": { }, \n \"limited_by\": [ \n {\n \"role-power-user\": {\n \"cluster\": [\n \"monitor\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"*\"\n ],\n \"privileges\": [\n \"read\"\n ],\n \"allow_restricted_indices\": false\n }\n ],\n \"applications\": [ ],\n \"run_as\": [ ],\n \"metadata\": { },\n \"transient_metadata\": {\n \"enabled\": true\n }\n }\n }\n ]\n }\n ]\n}"
+ },
+ "SecurityGetApiKeyResponseExample2": {
+ "summary": "Get all keys for a user",
+ "description": "A successful response from `GET /_security/api_key?username=myuser&realm_name=native1`. The response contains all API keys for the user `myuser` in the `native1` realm.\n",
+ "value": "{\n \"api_keys\": [\n {\n \"id\": \"0GF5GXsBCXxz2eDxWwFN\",\n \"name\": \"hadoop_myuser_key\",\n \"creation\": 1548550550158,\n \"expiration\": 1548551550158,\n \"invalidated\": false,\n \"username\": \"myuser\",\n \"realm\": \"native1\",\n \"realm_type\": \"native\",\n \"metadata\": {\n \"application\": \"myapp\"\n },\n \"role_descriptors\": {\n \"role-a\": {\n \"cluster\": [\n \"monitor\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index-a\"\n ],\n \"privileges\": [\n \"read\"\n ],\n \"allow_restricted_indices\": false\n }\n ],\n \"applications\": [ ],\n \"run_as\": [ ],\n \"metadata\": { },\n \"transient_metadata\": {\n \"enabled\": true\n }\n }\n }\n },\n {\n \"id\": \"6wHJmcQpReKBa42EHV5SBw\",\n \"name\": \"api-key-name-2\",\n \"creation\": 1548550550158,\n \"invalidated\": false,\n \"username\": \"user-y\",\n \"realm\": \"realm-2\",\n \"metadata\": {},\n \"role_descriptors\": { }\n }\n ]\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET /_security/api_key?username=myuser&realm_name=native1\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.security.get_api_key(\n username=\"myuser\",\n realm_name=\"native1\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.security.getApiKey({\n username: \"myuser\",\n realm_name: \"native1\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.security.get_api_key(\n username: \"myuser\",\n realm_name: \"native1\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->security()->getApiKey([\n \"username\" => \"myuser\",\n \"realm_name\" => \"native1\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/api_key?username=myuser&realm_name=native1\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.security().getApiKey(g -> g\n .realmName(\"native1\")\n .username(\"myuser\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "security"
+ ],
+ "summary": "Create an API key\n",
+ "description": "**All methods and paths for this operation:**\n\n\n PUT\n /_security/api_key\n
\n \n POST\n /_security/api_key\n
\n \n\nCreate an API key for access without requiring basic authentication.\n\nIMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges.\nIf you specify privileges, the API returns an error.\n\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.\n\nThe API keys are created by the Elasticsearch API key service, which is automatically enabled.\nTo configure or turn off the API key service, refer to API key service setting documentation.\n\n## Required authorization\n\n* Cluster privileges: `manage_own_api_key`\n",
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/security-settings#api-key-service-settings",
+ "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-create-api-key.html"
+ },
+ "operationId": "security-create-api-key",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/security.create_api_key-refresh"
+ }
+ ],
+ "requestBody": {
+ "$ref": "#/components/requestBodies/security.create_api_key"
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/security.create_api_key-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST /_security/api_key\n{\n \"name\": \"my-api-key\",\n \"expiration\": \"1d\", \n \"role_descriptors\": { \n \"role-a\": {\n \"cluster\": [\"all\"],\n \"indices\": [\n {\n \"names\": [\"index-a*\"],\n \"privileges\": [\"read\"]\n }\n ]\n },\n \"role-b\": {\n \"cluster\": [\"all\"],\n \"indices\": [\n {\n \"names\": [\"index-b*\"],\n \"privileges\": [\"all\"]\n }\n ]\n }\n },\n \"metadata\": {\n \"application\": \"my-application\",\n \"environment\": {\n \"level\": 1,\n \"trusted\": true,\n \"tags\": [\"dev\", \"staging\"]\n }\n }\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.security.create_api_key(\n name=\"my-api-key\",\n expiration=\"1d\",\n role_descriptors={\n \"role-a\": {\n \"cluster\": [\n \"all\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index-a*\"\n ],\n \"privileges\": [\n \"read\"\n ]\n }\n ]\n },\n \"role-b\": {\n \"cluster\": [\n \"all\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index-b*\"\n ],\n \"privileges\": [\n \"all\"\n ]\n }\n ]\n }\n },\n metadata={\n \"application\": \"my-application\",\n \"environment\": {\n \"level\": 1,\n \"trusted\": True,\n \"tags\": [\n \"dev\",\n \"staging\"\n ]\n }\n },\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.security.createApiKey({\n name: \"my-api-key\",\n expiration: \"1d\",\n role_descriptors: {\n \"role-a\": {\n cluster: [\"all\"],\n indices: [\n {\n names: [\"index-a*\"],\n privileges: [\"read\"],\n },\n ],\n },\n \"role-b\": {\n cluster: [\"all\"],\n indices: [\n {\n names: [\"index-b*\"],\n privileges: [\"all\"],\n },\n ],\n },\n },\n metadata: {\n application: \"my-application\",\n environment: {\n level: 1,\n trusted: true,\n tags: [\"dev\", \"staging\"],\n },\n },\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.security.create_api_key(\n body: {\n \"name\": \"my-api-key\",\n \"expiration\": \"1d\",\n \"role_descriptors\": {\n \"role-a\": {\n \"cluster\": [\n \"all\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index-a*\"\n ],\n \"privileges\": [\n \"read\"\n ]\n }\n ]\n },\n \"role-b\": {\n \"cluster\": [\n \"all\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index-b*\"\n ],\n \"privileges\": [\n \"all\"\n ]\n }\n ]\n }\n },\n \"metadata\": {\n \"application\": \"my-application\",\n \"environment\": {\n \"level\": 1,\n \"trusted\": true,\n \"tags\": [\n \"dev\",\n \"staging\"\n ]\n }\n }\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->security()->createApiKey([\n \"body\" => [\n \"name\" => \"my-api-key\",\n \"expiration\" => \"1d\",\n \"role_descriptors\" => [\n \"role-a\" => [\n \"cluster\" => array(\n \"all\",\n ),\n \"indices\" => array(\n [\n \"names\" => array(\n \"index-a*\",\n ),\n \"privileges\" => array(\n \"read\",\n ),\n ],\n ),\n ],\n \"role-b\" => [\n \"cluster\" => array(\n \"all\",\n ),\n \"indices\" => array(\n [\n \"names\" => array(\n \"index-b*\",\n ),\n \"privileges\" => array(\n \"all\",\n ),\n ],\n ),\n ],\n ],\n \"metadata\" => [\n \"application\" => \"my-application\",\n \"environment\" => [\n \"level\" => 1,\n \"trusted\" => true,\n \"tags\" => array(\n \"dev\",\n \"staging\",\n ),\n ],\n ],\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"name\":\"my-api-key\",\"expiration\":\"1d\",\"role_descriptors\":{\"role-a\":{\"cluster\":[\"all\"],\"indices\":[{\"names\":[\"index-a*\"],\"privileges\":[\"read\"]}]},\"role-b\":{\"cluster\":[\"all\"],\"indices\":[{\"names\":[\"index-b*\"],\"privileges\":[\"all\"]}]}},\"metadata\":{\"application\":\"my-application\",\"environment\":{\"level\":1,\"trusted\":true,\"tags\":[\"dev\",\"staging\"]}}}' \"$ELASTICSEARCH_URL/_security/api_key\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.security().createApiKey(c -> c\n .expiration(e -> e\n .time(\"1d\")\n )\n .metadata(Map.of(\"environment\", JsonData.fromJson(\"{\\\"level\\\":1,\\\"trusted\\\":true,\\\"tags\\\":[\\\"dev\\\",\\\"staging\\\"]}\"),\"application\", JsonData.fromJson(\"\\\"my-application\\\"\")))\n .name(\"my-api-key\")\n .roleDescriptors(Map.of(\"role-b\", RoleDescriptor.of(r -> r\n .cluster(\"all\")\n .indices(i -> i\n .names(\"index-b*\")\n .privileges(\"all\")\n )),\"role-a\", RoleDescriptor.of(r -> r\n .cluster(\"all\")\n .indices(i -> i\n .names(\"index-a*\")\n .privileges(\"read\")\n ))))\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "security"
+ ],
+ "summary": "Invalidate API keys",
+ "description": "This API invalidates API keys created by the create API key or grant API key APIs.\nInvalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted.\n\nTo use this API, you must have at least the `manage_security`, `manage_api_key`, or `manage_own_api_key` cluster privileges.\nThe `manage_security` privilege allows deleting any API key, including both REST and cross cluster API keys.\nThe `manage_api_key` privilege allows deleting any REST API key, but not cross cluster API keys.\nThe `manage_own_api_key` only allows deleting REST API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user's identity.\n- Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the `ids` field.\n\n## Required authorization\n\n* Cluster privileges: `manage_api_key`,`manage_own_api_key`\n",
+ "operationId": "security-invalidate-api-key",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "ids": {
+ "description": "A list of API key ids.\nThis parameter cannot be used with any of `name`, `realm_name`, or `username`.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ },
+ "name": {
+ "description": "An API key name.\nThis parameter cannot be used with any of `ids`, `realm_name` or `username`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "owner": {
+ "description": "Query API keys owned by the currently authenticated user.\nThe `realm_name` or `username` parameters cannot be specified when this parameter is set to `true` as they are assumed to be the currently authenticated ones.\n\nNOTE: At least one of `ids`, `name`, `username`, and `realm_name` must be specified if `owner` is `false`.",
+ "default": false,
+ "type": "boolean"
+ },
+ "realm_name": {
+ "description": "The name of an authentication realm.\nThis parameter cannot be used with either `ids` or `name`, or when `owner` flag is set to `true`.",
+ "type": "string"
+ },
+ "username": {
+ "description": "The username of a user.\nThis parameter cannot be used with either `ids` or `name` or when `owner` flag is set to `true`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Username"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "SecurityInvalidateApiKeyRequestExample1": {
+ "summary": "API keys by ID",
+ "description": "Run `DELETE /_security/api_key` to invalidate the API keys identified by ID.",
+ "value": "{\n \"ids\" : [ \"VuaCfGcBCdbkQm-e5aOx\" ]\n}"
+ },
+ "SecurityInvalidateApiKeyRequestExample2": {
+ "summary": "API keys by name",
+ "description": "Run `DELETE /_security/api_key` to invalidate the API keys identified by name.",
+ "value": "{\n \"name\" : \"my-api-key\"\n}"
+ },
+ "SecurityInvalidateApiKeyRequestExample3": {
+ "summary": "API keys by realm",
+ "description": "Run `DELETE /_security/api_key` to invalidate all API keys for the `native1` realm.",
+ "value": "{\n \"realm_name\" : \"native1\"\n}"
+ },
+ "SecurityInvalidateApiKeyRequestExample4": {
+ "summary": "API keys by user",
+ "description": "Run `DELETE /_security/api_key` to invalidate all API keys for the user `myuser` in all realms.",
+ "value": "{\n \"username\" : \"myuser\"\n}"
+ },
+ "SecurityInvalidateApiKeyRequestExample5": {
+ "summary": "API keys by ID and owner",
+ "description": "Run `DELETE /_security/api_key` to invalidate the API keys identified by ID if they are owned by the currently authenticated user.",
+ "value": "{\n \"ids\" : [\"VuaCfGcBCdbkQm-e5aOx\"],\n \"owner\" : \"true\"\n}"
+ },
+ "SecurityInvalidateApiKeyRequestExample6": {
+ "summary": "API keys by user and realm",
+ "description": "Run `DELETE /_security/api_key` to invalidate all API keys for the user `myuser` in the `native1` realm .",
+ "value": "{\n \"username\" : \"myuser\",\n \"realm_name\" : \"native1\"\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error_count": {
+ "description": "The number of errors that were encountered when invalidating the API keys.",
+ "type": "number"
+ },
+ "error_details": {
+ "description": "Details about the errors.\nThis field is not present in the response when `error_count` is `0`.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.ErrorCause"
+ }
+ },
+ "invalidated_api_keys": {
+ "description": "The IDs of the API keys that were invalidated as part of this request.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "previously_invalidated_api_keys": {
+ "description": "The IDs of the API keys that were already invalidated.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "error_count",
+ "invalidated_api_keys",
+ "previously_invalidated_api_keys"
+ ]
+ },
+ "examples": {
+ "SecurityInvalidateApiKeyResponseExample1": {
+ "description": "A successful response from `DELETE /_security/api_key`.\n",
+ "value": "{\n \"invalidated_api_keys\": [ \n \"api-key-id-1\"\n ],\n \"previously_invalidated_api_keys\": [ \n \"api-key-id-2\",\n \"api-key-id-3\"\n ],\n \"error_count\": 2, \n \"error_details\": [ \n {\n \"type\": \"exception\",\n \"reason\": \"error occurred while invalidating api keys\",\n \"caused_by\": {\n \"type\": \"illegal_argument_exception\",\n \"reason\": \"invalid api key id\"\n }\n },\n {\n \"type\": \"exception\",\n \"reason\": \"error occurred while invalidating api keys\",\n \"caused_by\": {\n \"type\": \"illegal_argument_exception\",\n \"reason\": \"invalid api key id\"\n }\n }\n ]\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "DELETE /_security/api_key\n{\n \"ids\" : [ \"VuaCfGcBCdbkQm-e5aOx\" ]\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.security.invalidate_api_key(\n ids=[\n \"VuaCfGcBCdbkQm-e5aOx\"\n ],\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.security.invalidateApiKey({\n ids: [\"VuaCfGcBCdbkQm-e5aOx\"],\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.security.invalidate_api_key(\n body: {\n \"ids\": [\n \"VuaCfGcBCdbkQm-e5aOx\"\n ]\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->security()->invalidateApiKey([\n \"body\" => [\n \"ids\" => array(\n \"VuaCfGcBCdbkQm-e5aOx\",\n ),\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"ids\":[\"VuaCfGcBCdbkQm-e5aOx\"]}' \"$ELASTICSEARCH_URL/_security/api_key\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.security().invalidateApiKey(i -> i\n .ids(\"VuaCfGcBCdbkQm-e5aOx\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_security/role/{name}": {
+ "get": {
+ "tags": [
+ "security"
+ ],
+ "summary": "Get roles\n",
+ "description": "**All methods and paths for this operation:**\n\n\n GET\n /_security/role\n
\n \n GET\n /_security/role/{name}\n
\n \n\nGet roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe get roles API cannot retrieve roles that are defined in roles files.\n\n## Required authorization\n\n* Cluster privileges: `read_security`\n",
+ "operationId": "security-get-role",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/security.get_role-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/security.get_role-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET /_security/role/my_admin_role\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.security.get_role(\n name=\"my_admin_role\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.security.getRole({\n name: \"my_admin_role\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.security.get_role(\n name: \"my_admin_role\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->security()->getRole([\n \"name\" => \"my_admin_role\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/role/my_admin_role\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.security().getRole(g -> g\n .name(\"my_admin_role\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "security"
+ ],
+ "summary": "Create or update roles\n",
+ "description": "**All methods and paths for this operation:**\n\n\n PUT\n /_security/role/{name}\n
\n \n POST\n /_security/role/{name}\n
\n \n\nThe role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management.\nThe create or update roles API cannot update roles that are defined in roles files.\nFile-based role management is not available in Elastic Serverless.\n\n## Required authorization\n\n* Cluster privileges: `manage_security`\n",
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/defining-roles",
+ "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-put-role.html"
+ },
+ "operationId": "security-put-role",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/security.put_role-name"
+ },
+ {
+ "$ref": "#/components/parameters/security.put_role-refresh"
+ }
+ ],
+ "requestBody": {
+ "$ref": "#/components/requestBodies/security.put_role"
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/security.put_role-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST /_security/role/my_admin_role\n{\n \"description\": \"Grants full access to all management features within the cluster.\",\n \"cluster\": [\"all\"],\n \"indices\": [\n {\n \"names\": [ \"index1\", \"index2\" ],\n \"privileges\": [\"all\"],\n \"field_security\" : { // optional\n \"grant\" : [ \"title\", \"body\" ]\n },\n \"query\": \"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\" // optional\n }\n ],\n \"applications\": [\n {\n \"application\": \"myapp\",\n \"privileges\": [ \"admin\", \"read\" ],\n \"resources\": [ \"*\" ]\n }\n ],\n \"run_as\": [ \"other_user\" ], // optional\n \"metadata\" : { // optional\n \"version\" : 1\n }\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.security.put_role(\n name=\"my_admin_role\",\n description=\"Grants full access to all management features within the cluster.\",\n cluster=[\n \"all\"\n ],\n indices=[\n {\n \"names\": [\n \"index1\",\n \"index2\"\n ],\n \"privileges\": [\n \"all\"\n ],\n \"field_security\": {\n \"grant\": [\n \"title\",\n \"body\"\n ]\n },\n \"query\": \"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\"\n }\n ],\n applications=[\n {\n \"application\": \"myapp\",\n \"privileges\": [\n \"admin\",\n \"read\"\n ],\n \"resources\": [\n \"*\"\n ]\n }\n ],\n run_as=[\n \"other_user\"\n ],\n metadata={\n \"version\": 1\n },\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.security.putRole({\n name: \"my_admin_role\",\n description:\n \"Grants full access to all management features within the cluster.\",\n cluster: [\"all\"],\n indices: [\n {\n names: [\"index1\", \"index2\"],\n privileges: [\"all\"],\n field_security: {\n grant: [\"title\", \"body\"],\n },\n query: '{\"match\": {\"title\": \"foo\"}}',\n },\n ],\n applications: [\n {\n application: \"myapp\",\n privileges: [\"admin\", \"read\"],\n resources: [\"*\"],\n },\n ],\n run_as: [\"other_user\"],\n metadata: {\n version: 1,\n },\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.security.put_role(\n name: \"my_admin_role\",\n body: {\n \"description\": \"Grants full access to all management features within the cluster.\",\n \"cluster\": [\n \"all\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index1\",\n \"index2\"\n ],\n \"privileges\": [\n \"all\"\n ],\n \"field_security\": {\n \"grant\": [\n \"title\",\n \"body\"\n ]\n },\n \"query\": \"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\"\n }\n ],\n \"applications\": [\n {\n \"application\": \"myapp\",\n \"privileges\": [\n \"admin\",\n \"read\"\n ],\n \"resources\": [\n \"*\"\n ]\n }\n ],\n \"run_as\": [\n \"other_user\"\n ],\n \"metadata\": {\n \"version\": 1\n }\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->security()->putRole([\n \"name\" => \"my_admin_role\",\n \"body\" => [\n \"description\" => \"Grants full access to all management features within the cluster.\",\n \"cluster\" => array(\n \"all\",\n ),\n \"indices\" => array(\n [\n \"names\" => array(\n \"index1\",\n \"index2\",\n ),\n \"privileges\" => array(\n \"all\",\n ),\n \"field_security\" => [\n \"grant\" => array(\n \"title\",\n \"body\",\n ),\n ],\n \"query\" => \"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\",\n ],\n ),\n \"applications\" => array(\n [\n \"application\" => \"myapp\",\n \"privileges\" => array(\n \"admin\",\n \"read\",\n ),\n \"resources\" => array(\n \"*\",\n ),\n ],\n ),\n \"run_as\" => array(\n \"other_user\",\n ),\n \"metadata\" => [\n \"version\" => 1,\n ],\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"description\":\"Grants full access to all management features within the cluster.\",\"cluster\":[\"all\"],\"indices\":[{\"names\":[\"index1\",\"index2\"],\"privileges\":[\"all\"],\"field_security\":{\"grant\":[\"title\",\"body\"]},\"query\":\"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\"}],\"applications\":[{\"application\":\"myapp\",\"privileges\":[\"admin\",\"read\"],\"resources\":[\"*\"]}],\"run_as\":[\"other_user\"],\"metadata\":{\"version\":1}}' \"$ELASTICSEARCH_URL/_security/role/my_admin_role\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.security().putRole(p -> p\n .applications(a -> a\n .application(\"myapp\")\n .privileges(List.of(\"admin\",\"read\"))\n .resources(\"*\")\n )\n .cluster(\"all\")\n .description(\"Grants full access to all management features within the cluster.\")\n .indices(i -> i\n .fieldSecurity(f -> f\n .grant(List.of(\"title\",\"body\"))\n )\n .names(List.of(\"index1\",\"index2\"))\n .privileges(\"all\")\n .query(q -> q\n .match(m -> m\n .field(\"title\")\n .query(FieldValue.of(\"foo\"))\n )\n )\n )\n .metadata(\"version\", JsonData.fromJson(\"1\"))\n .name(\"my_admin_role\")\n .runAs(\"other_user\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "security"
+ ],
+ "summary": "Delete roles",
+ "description": "Delete roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe delete roles API cannot remove roles that are defined in roles files.\n\n## Required authorization\n\n* Cluster privileges: `manage_security`\n",
+ "operationId": "security-delete-role",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "name",
+ "description": "The name of the role.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Name"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "refresh",
+ "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Refresh"
+ },
+ "style": "form"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "found": {
+ "description": "If the role is successfully deleted, `found` is `true`.\nOtherwise, `found` is `false`.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "found"
+ ]
+ },
+ "examples": {
+ "SecurityDeleteRoleResponseExample1": {
+ "description": "A successful response from `DELETE /_security/role/my_admin_role`. If the role is successfully deleted, `found` is set to `true`.\n",
+ "value": "{\n \"found\" : true\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "DELETE /_security/role/my_admin_role\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.security.delete_role(\n name=\"my_admin_role\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.security.deleteRole({\n name: \"my_admin_role\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.security.delete_role(\n name: \"my_admin_role\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->security()->deleteRole([\n \"name\" => \"my_admin_role\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/role/my_admin_role\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.security().deleteRole(d -> d\n .name(\"my_admin_role\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_security/privilege/_builtin": {
+ "get": {
+ "tags": [
+ "security"
+ ],
+ "summary": "Get builtin privileges",
+ "description": "Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch.\n\n## Required authorization\n\n* Cluster privileges: `manage_security`\n",
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges",
+ "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-get-builtin-privileges.html"
+ },
+ "operationId": "security-get-builtin-privileges",
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "cluster": {
+ "description": "The list of cluster privileges that are understood by this version of Elasticsearch.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/security._types.ClusterPrivilege"
+ }
+ },
+ "index": {
+ "description": "The list of index privileges that are understood by this version of Elasticsearch.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ }
+ },
+ "required": [
+ "cluster",
+ "index"
+ ]
+ },
+ "examples": {
+ "SecurityGetBuiltinPrivilegesResponseExample1": {
+ "description": "A successful response from `GET /_security/privilege/_builtin`.",
+ "value": "{\n \"cluster\" : [\n \"all\",\n \"cancel_task\",\n \"create_snapshot\",\n \"cross_cluster_replication\",\n \"cross_cluster_search\",\n \"delegate_pki\",\n \"grant_api_key\",\n \"manage\",\n \"manage_api_key\",\n \"manage_autoscaling\",\n \"manage_behavioral_analytics\",\n \"manage_ccr\",\n \"manage_connector\",\n \"manage_data_frame_transforms\",\n \"manage_data_stream_global_retention\",\n \"manage_enrich\",\n \"manage_ilm\",\n \"manage_index_templates\",\n \"manage_inference\",\n \"manage_ingest_pipelines\",\n \"manage_logstash_pipelines\",\n \"manage_ml\",\n \"manage_oidc\",\n \"manage_own_api_key\",\n \"manage_pipeline\",\n \"manage_rollup\",\n \"manage_saml\",\n \"manage_search_application\",\n \"manage_search_query_rules\",\n \"manage_search_synonyms\",\n \"manage_security\",\n \"manage_service_account\",\n \"manage_slm\",\n \"manage_token\",\n \"manage_transform\",\n \"manage_user_profile\",\n \"manage_watcher\",\n \"monitor\",\n \"monitor_connector\",\n \"monitor_data_frame_transforms\",\n \"monitor_data_stream_global_retention\",\n \"monitor_enrich\",\n \"monitor_inference\",\n \"monitor_ml\",\n \"monitor_rollup\",\n \"monitor_snapshot\",\n \"monitor_stats\",\n \"monitor_text_structure\",\n \"monitor_transform\",\n \"monitor_watcher\",\n \"none\",\n \"post_behavioral_analytics_event\",\n \"read_ccr\",\n \"read_connector_secrets\",\n \"read_fleet_secrets\",\n \"read_ilm\",\n \"read_pipeline\",\n \"read_security\",\n \"read_slm\",\n \"transport_client\",\n \"write_connector_secrets\",\n \"write_fleet_secrets\"\n ],\n \"index\" : [\n \"all\",\n \"auto_configure\",\n \"create\",\n \"create_doc\",\n \"create_index\",\n \"cross_cluster_replication\",\n \"cross_cluster_replication_internal\",\n \"delete\",\n \"delete_index\",\n \"index\",\n \"maintenance\",\n \"manage\",\n \"manage_data_stream_lifecycle\",\n \"manage_follow_index\",\n \"manage_ilm\",\n \"manage_leader_index\",\n \"monitor\",\n \"none\",\n \"read\",\n \"read_cross_cluster\",\n \"view_index_metadata\",\n \"write\"\n ],\n \"remote_cluster\" : [\n \"monitor_enrich\",\n \"monitor_stats\"\n ]\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET /_security/privilege/_builtin\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.security.get_builtin_privileges()"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.security.getBuiltinPrivileges();"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.security.get_builtin_privileges"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->security()->getBuiltinPrivileges();"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_security/privilege/_builtin\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.security().getBuiltinPrivileges();\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_security/user/{user}/_has_privileges": {
+ "post": {
+ "tags": [
+ "security"
+ ],
+ "summary": "Check user privileges\n",
+ "description": "**All methods and paths for this operation:**\n\n\n GET\n /_security/user/_has_privileges\n
\n \n POST\n /_security/user/_has_privileges\n
\n \n GET\n /_security/user/{user}/_has_privileges\n
\n \n POST\n /_security/user/{user}/_has_privileges\n
\n \n\nDetermine whether the specified user has a specified list of privileges.\nAll users can use this API, but only to determine their own privileges.\nTo check the privileges of other users, you must use the run as feature.",
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges",
+ "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-has-privileges.html"
+ },
+ "operationId": "security-has-privileges",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/security.has_privileges-user"
+ }
+ ],
+ "requestBody": {
+ "$ref": "#/components/requestBodies/security.has_privileges"
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/security.has_privileges-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET /_security/user/_has_privileges\n{\n \"cluster\": [ \"monitor\", \"manage\" ],\n \"index\" : [\n {\n \"names\": [ \"suppliers\", \"products\" ],\n \"privileges\": [ \"read\" ]\n },\n {\n \"names\": [ \"inventory\" ],\n \"privileges\" : [ \"read\", \"write\" ]\n }\n ],\n \"application\": [\n {\n \"application\": \"inventory_manager\",\n \"privileges\" : [ \"read\", \"data:write/inventory\" ],\n \"resources\" : [ \"product/1852563\" ]\n }\n ]\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.security.has_privileges(\n cluster=[\n \"monitor\",\n \"manage\"\n ],\n index=[\n {\n \"names\": [\n \"suppliers\",\n \"products\"\n ],\n \"privileges\": [\n \"read\"\n ]\n },\n {\n \"names\": [\n \"inventory\"\n ],\n \"privileges\": [\n \"read\",\n \"write\"\n ]\n }\n ],\n application=[\n {\n \"application\": \"inventory_manager\",\n \"privileges\": [\n \"read\",\n \"data:write/inventory\"\n ],\n \"resources\": [\n \"product/1852563\"\n ]\n }\n ],\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.security.hasPrivileges({\n cluster: [\"monitor\", \"manage\"],\n index: [\n {\n names: [\"suppliers\", \"products\"],\n privileges: [\"read\"],\n },\n {\n names: [\"inventory\"],\n privileges: [\"read\", \"write\"],\n },\n ],\n application: [\n {\n application: \"inventory_manager\",\n privileges: [\"read\", \"data:write/inventory\"],\n resources: [\"product/1852563\"],\n },\n ],\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.security.has_privileges(\n body: {\n \"cluster\": [\n \"monitor\",\n \"manage\"\n ],\n \"index\": [\n {\n \"names\": [\n \"suppliers\",\n \"products\"\n ],\n \"privileges\": [\n \"read\"\n ]\n },\n {\n \"names\": [\n \"inventory\"\n ],\n \"privileges\": [\n \"read\",\n \"write\"\n ]\n }\n ],\n \"application\": [\n {\n \"application\": \"inventory_manager\",\n \"privileges\": [\n \"read\",\n \"data:write/inventory\"\n ],\n \"resources\": [\n \"product/1852563\"\n ]\n }\n ]\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->security()->hasPrivileges([\n \"body\" => [\n \"cluster\" => array(\n \"monitor\",\n \"manage\",\n ),\n \"index\" => array(\n [\n \"names\" => array(\n \"suppliers\",\n \"products\",\n ),\n \"privileges\" => array(\n \"read\",\n ),\n ],\n [\n \"names\" => array(\n \"inventory\",\n ),\n \"privileges\" => array(\n \"read\",\n \"write\",\n ),\n ],\n ),\n \"application\" => array(\n [\n \"application\" => \"inventory_manager\",\n \"privileges\" => array(\n \"read\",\n \"data:write/inventory\",\n ),\n \"resources\" => array(\n \"product/1852563\",\n ),\n ],\n ),\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"cluster\":[\"monitor\",\"manage\"],\"index\":[{\"names\":[\"suppliers\",\"products\"],\"privileges\":[\"read\"]},{\"names\":[\"inventory\"],\"privileges\":[\"read\",\"write\"]}],\"application\":[{\"application\":\"inventory_manager\",\"privileges\":[\"read\",\"data:write/inventory\"],\"resources\":[\"product/1852563\"]}]}' \"$ELASTICSEARCH_URL/_security/user/_has_privileges\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.security().hasPrivileges(h -> h\n .application(a -> a\n .application(\"inventory_manager\")\n .privileges(List.of(\"read\",\"data:write/inventory\"))\n .resources(\"product/1852563\")\n )\n .cluster(List.of(\"monitor\",\"manage\"))\n .index(List.of(IndexPrivilegesCheck.of(i -> i\n .names(List.of(\"suppliers\",\"products\"))\n .privileges(\"read\")),IndexPrivilegesCheck.of(i -> i\n .names(\"inventory\")\n .privileges(List.of(\"read\",\"write\")))))\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_security/_query/api_key": {
+ "post": {
+ "tags": [
+ "security"
+ ],
+ "summary": "Find API keys with a query\n",
+ "description": "**All methods and paths for this operation:**\n\n\n GET\n /_security/_query/api_key\n
\n \n POST\n /_security/_query/api_key\n
\n \n\nGet a paginated list of API keys and their information.\nYou can optionally filter the results with a query.\n\nTo use this API, you must have at least the `manage_own_api_key` or the `read_security` cluster privileges.\nIf you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.\nIf you have the `read_security`, `manage_api_key`, or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.\nRefer to the linked documentation for examples of how to find API keys:\n\n## Required authorization\n\n* Cluster privileges: `manage_own_api_key`,`read_security`\n",
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/query-api-keys",
+ "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-query-api-key.html"
+ },
+ "operationId": "security-query-api-keys",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/security.query_api_keys-with_limited_by"
+ },
+ {
+ "$ref": "#/components/parameters/security.query_api_keys-with_profile_uid"
+ },
+ {
+ "$ref": "#/components/parameters/security.query_api_keys-typed_keys"
+ }
+ ],
+ "requestBody": {
+ "$ref": "#/components/requestBodies/security.query_api_keys"
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/security.query_api_keys-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET /_security/_query/api_key?with_limited_by=true\n{\n \"query\": {\n \"ids\": {\n \"values\": [\n \"VuaCfGcBCdbkQm-e5aOx\"\n ]\n }\n }\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.security.query_api_keys(\n with_limited_by=True,\n query={\n \"ids\": {\n \"values\": [\n \"VuaCfGcBCdbkQm-e5aOx\"\n ]\n }\n },\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.security.queryApiKeys({\n with_limited_by: \"true\",\n query: {\n ids: {\n values: [\"VuaCfGcBCdbkQm-e5aOx\"],\n },\n },\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.security.query_api_keys(\n with_limited_by: \"true\",\n body: {\n \"query\": {\n \"ids\": {\n \"values\": [\n \"VuaCfGcBCdbkQm-e5aOx\"\n ]\n }\n }\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->security()->queryApiKeys([\n \"with_limited_by\" => \"true\",\n \"body\" => [\n \"query\" => [\n \"ids\" => [\n \"values\" => array(\n \"VuaCfGcBCdbkQm-e5aOx\",\n ),\n ],\n ],\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"query\":{\"ids\":{\"values\":[\"VuaCfGcBCdbkQm-e5aOx\"]}}}' \"$ELASTICSEARCH_URL/_security/_query/api_key?with_limited_by=true\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.security().queryApiKeys(q -> q\n .query(qu -> qu\n .ids(i -> i\n .values(\"VuaCfGcBCdbkQm-e5aOx\")\n )\n )\n .withLimitedBy(true)\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_security/_query/role": {
+ "post": {
+ "tags": [
+ "security"
+ ],
+ "summary": "Find roles with a query\n",
+ "description": "**All methods and paths for this operation:**\n\n\n GET\n /_security/_query/role\n
\n \n POST\n /_security/_query/role\n
\n \n\nGet roles in a paginated manner.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe query roles API does not retrieve roles that are defined in roles files, nor built-in ones.\nYou can optionally filter the results with a query.\nAlso, the results can be paginated and sorted.\n\n## Required authorization\n\n* Cluster privileges: `read_security`\n",
+ "operationId": "security-query-role",
+ "requestBody": {
+ "$ref": "#/components/requestBodies/security.query_role"
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/security.query_role-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST /_security/_query/role\n{\n \"sort\": [\"name\"]\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.security.query_role(\n sort=[\n \"name\"\n ],\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.security.queryRole({\n sort: [\"name\"],\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.security.query_role(\n body: {\n \"sort\": [\n \"name\"\n ]\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->security()->queryRole([\n \"body\" => [\n \"sort\" => array(\n \"name\",\n ),\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"sort\":[\"name\"]}' \"$ELASTICSEARCH_URL/_security/_query/role\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.security().queryRole(q -> q\n .sort(s -> s\n .field(f -> f\n .field(\"name\")\n )\n )\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_security/api_key/{id}": {
+ "put": {
+ "tags": [
+ "security"
+ ],
+ "summary": "Update an API key",
+ "description": "Update attributes of an existing API key.\nThis API supports updates to an API key's access scope, expiration, and metadata.\n\nTo use this API, you must have at least the `manage_own_api_key` cluster privilege.\nUsers can only update API keys that they created or that were granted to them.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\n\nIMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required.\n\nUse this API to update API keys created by the create API key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead.\nIt's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API.\n\nThe access scope of an API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request.\nThe snapshot of the owner's permissions is updated automatically on every call.\n\nIMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change the API key's access scope.\nThis change can occur if the owner user's permissions have changed since the API key was created or last modified.\n\n## Required authorization\n\n* Cluster privileges: `manage_own_api_key`\n",
+ "operationId": "security-update-api-key",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "id",
+ "description": "The ID of the API key to update.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "role_descriptors": {
+ "description": "The role descriptors to assign to this API key.\nThe API key's effective permissions are an intersection of its assigned privileges and the point in time snapshot of permissions of the owner user.\nYou can assign new privileges by specifying them in this parameter.\nTo remove assigned privileges, you can supply an empty `role_descriptors` parameter, that is to say, an empty object `{}`.\nIf an API key has no assigned privileges, it inherits the owner user's full permissions.\nThe snapshot of the owner's permissions is always updated, whether you supply the `role_descriptors` parameter or not.\nThe structure of a role descriptor is the same as the request for the create API keys API.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/security._types.RoleDescriptor"
+ }
+ },
+ "metadata": {
+ "description": "Arbitrary metadata that you want to associate with the API key.\nIt supports a nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.\nWhen specified, this value fully replaces the metadata previously associated with the API key.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ },
+ "expiration": {
+ "description": "The expiration time for the API key.\nBy default, API keys never expire.\nThis property can be omitted to leave the expiration unchanged.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "UpdateApiKeyRequestExample1": {
+ "summary": "Update role and metadata",
+ "description": "Run `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx` to assign new role descriptors and metadata to an API key.\n",
+ "value": "{\n \"role_descriptors\": {\n \"role-a\": {\n \"indices\": [\n {\n \"names\": [\"*\"],\n \"privileges\": [\"write\"]\n }\n ]\n }\n },\n \"metadata\": {\n \"environment\": {\n \"level\": 2,\n \"trusted\": true,\n \"tags\": [\"production\"]\n }\n }\n}"
+ },
+ "UpdateApiKeyRequestExample2": {
+ "summary": "Remove permissions",
+ "description": "Run `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx` to remove the API key's previously assigned permissions. It will inherit the owner user's full permissions.\n",
+ "value": "{\n \"role_descriptors\": {}\n}"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "updated": {
+ "description": "If `true`, the API key was updated.\nIf `false`, the API key didn't change because no change was detected.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "updated"
+ ]
+ },
+ "examples": {
+ "UpdateApiKeyResponseExample1": {
+ "summary": "Update role and metadata",
+ "description": "A successful response from `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx`. The API key's effective permissions after the update will be the intersection of the supplied role descriptors and the owner user's permissions.\n",
+ "value": "{\n \"updated\": true\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx\n{\n \"role_descriptors\": {\n \"role-a\": {\n \"indices\": [\n {\n \"names\": [\"*\"],\n \"privileges\": [\"write\"]\n }\n ]\n }\n },\n \"metadata\": {\n \"environment\": {\n \"level\": 2,\n \"trusted\": true,\n \"tags\": [\"production\"]\n }\n }\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.security.update_api_key(\n id=\"VuaCfGcBCdbkQm-e5aOx\",\n role_descriptors={\n \"role-a\": {\n \"indices\": [\n {\n \"names\": [\n \"*\"\n ],\n \"privileges\": [\n \"write\"\n ]\n }\n ]\n }\n },\n metadata={\n \"environment\": {\n \"level\": 2,\n \"trusted\": True,\n \"tags\": [\n \"production\"\n ]\n }\n },\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.security.updateApiKey({\n id: \"VuaCfGcBCdbkQm-e5aOx\",\n role_descriptors: {\n \"role-a\": {\n indices: [\n {\n names: [\"*\"],\n privileges: [\"write\"],\n },\n ],\n },\n },\n metadata: {\n environment: {\n level: 2,\n trusted: true,\n tags: [\"production\"],\n },\n },\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.security.update_api_key(\n id: \"VuaCfGcBCdbkQm-e5aOx\",\n body: {\n \"role_descriptors\": {\n \"role-a\": {\n \"indices\": [\n {\n \"names\": [\n \"*\"\n ],\n \"privileges\": [\n \"write\"\n ]\n }\n ]\n }\n },\n \"metadata\": {\n \"environment\": {\n \"level\": 2,\n \"trusted\": true,\n \"tags\": [\n \"production\"\n ]\n }\n }\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->security()->updateApiKey([\n \"id\" => \"VuaCfGcBCdbkQm-e5aOx\",\n \"body\" => [\n \"role_descriptors\" => [\n \"role-a\" => [\n \"indices\" => array(\n [\n \"names\" => array(\n \"*\",\n ),\n \"privileges\" => array(\n \"write\",\n ),\n ],\n ),\n ],\n ],\n \"metadata\" => [\n \"environment\" => [\n \"level\" => 2,\n \"trusted\" => true,\n \"tags\" => array(\n \"production\",\n ),\n ],\n ],\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"role_descriptors\":{\"role-a\":{\"indices\":[{\"names\":[\"*\"],\"privileges\":[\"write\"]}]}},\"metadata\":{\"environment\":{\"level\":2,\"trusted\":true,\"tags\":[\"production\"]}}}' \"$ELASTICSEARCH_URL/_security/api_key/VuaCfGcBCdbkQm-e5aOx\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.security().updateApiKey(u -> u\n .id(\"VuaCfGcBCdbkQm-e5aOx\")\n .metadata(\"environment\", JsonData.fromJson(\"{\\\"level\\\":2,\\\"trusted\\\":true,\\\"tags\\\":[\\\"production\\\"]}\"))\n .roleDescriptors(\"role-a\", r -> r\n .indices(i -> i\n .names(\"*\")\n .privileges(\"write\")\n )\n )\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_sql/close": {
+ "post": {
+ "tags": [
+ "sql"
+ ],
+ "summary": "Clear an SQL search cursor",
+ "operationId": "sql-clear-cursor",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "cursor": {
+ "description": "Cursor to clear.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "cursor"
+ ]
+ },
+ "examples": {
+ "ClearSqlCursorRequestExample1": {
+ "description": "Run `POST _sql/close` to clear an SQL search cursor.",
+ "value": "{\n \"cursor\": \"sDXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAAEWYUpOYklQMHhRUEtld3RsNnFtYU1hQQ==:BAFmBGRhdGUBZgVsaWtlcwFzB21lc3NhZ2UBZgR1c2Vy9f///w8=\"\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "succeeded": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "succeeded"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _sql/close\n{\n \"cursor\": \"sDXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAAEWYUpOYklQMHhRUEtld3RsNnFtYU1hQQ==:BAFmBGRhdGUBZgVsaWtlcwFzB21lc3NhZ2UBZgR1c2Vy9f///w8=\"\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.sql.clear_cursor(\n cursor=\"sDXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAAEWYUpOYklQMHhRUEtld3RsNnFtYU1hQQ==:BAFmBGRhdGUBZgVsaWtlcwFzB21lc3NhZ2UBZgR1c2Vy9f///w8=\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.sql.clearCursor({\n cursor:\n \"sDXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAAEWYUpOYklQMHhRUEtld3RsNnFtYU1hQQ==:BAFmBGRhdGUBZgVsaWtlcwFzB21lc3NhZ2UBZgR1c2Vy9f///w8=\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.sql.clear_cursor(\n body: {\n \"cursor\": \"sDXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAAEWYUpOYklQMHhRUEtld3RsNnFtYU1hQQ==:BAFmBGRhdGUBZgVsaWtlcwFzB21lc3NhZ2UBZgR1c2Vy9f///w8=\"\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->sql()->clearCursor([\n \"body\" => [\n \"cursor\" => \"sDXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAAEWYUpOYklQMHhRUEtld3RsNnFtYU1hQQ==:BAFmBGRhdGUBZgVsaWtlcwFzB21lc3NhZ2UBZgR1c2Vy9f///w8=\",\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"cursor\":\"sDXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAAEWYUpOYklQMHhRUEtld3RsNnFtYU1hQQ==:BAFmBGRhdGUBZgVsaWtlcwFzB21lc3NhZ2UBZgR1c2Vy9f///w8=\"}' \"$ELASTICSEARCH_URL/_sql/close\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.sql().clearCursor(c -> c\n .cursor(\"sDXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAAEWYUpOYklQMHhRUEtld3RsNnFtYU1hQQ==:BAFmBGRhdGUBZgVsaWtlcwFzB21lc3NhZ2UBZgR1c2Vy9f///w8=\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_sql/async/delete/{id}": {
+ "delete": {
+ "tags": [
+ "sql"
+ ],
+ "summary": "Delete an async SQL search",
+ "description": "Delete an async SQL search or a stored synchronous SQL search.\nIf the search is still running, the API cancels it.\n\nIf the Elasticsearch security features are enabled, only the following users can use this API to delete a search:\n\n* Users with the `cancel_task` cluster privilege.\n* The user who first submitted the search.\n\n## Required authorization\n\n* Cluster privileges: `cancel_task`\n",
+ "operationId": "sql-delete-async",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "id",
+ "description": "The identifier for the search.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "DELETE _sql/async/delete/FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.sql.delete_async(\n id=\"FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.sql.deleteAsync({\n id: \"FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.sql.delete_async(\n id: \"FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->sql()->deleteAsync([\n \"id\" => \"FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_sql/async/delete/FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.sql().deleteAsync(d -> d\n .id(\"FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_sql/async/{id}": {
+ "get": {
+ "tags": [
+ "sql"
+ ],
+ "summary": "Get async SQL search results",
+ "description": "Get the current status and available results for an async SQL search or stored synchronous SQL search.\n\nIf the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API.",
+ "operationId": "sql-get-async",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "id",
+ "description": "The identifier for the search.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "delimiter",
+ "description": "The separator for CSV results.\nThe API supports this parameter only for CSV responses.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "format",
+ "description": "The format for the response.\nYou must specify a format using this parameter or the `Accept` HTTP header.\nIf you specify both, the API uses this parameter.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "keep_alive",
+ "description": "The retention period for the search and its results.\nIt defaults to the `keep_alive` period for the original SQL search.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "wait_for_completion_timeout",
+ "description": "The period to wait for complete results.\nIt defaults to no timeout, meaning the request waits for complete search results.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Identifier for the search.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-ID` HTTP header.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "is_running": {
+ "description": "If `true`, the search is still running.\nIf `false`, the search has finished.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.",
+ "type": "boolean"
+ },
+ "is_partial": {
+ "description": "If `true`, the response does not contain complete search results.\nIf `is_partial` is `true` and `is_running` is `true`, the search is still running.\nIf `is_partial` is `true` but `is_running` is `false`, the results are partial due to a failure or timeout.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.",
+ "type": "boolean"
+ },
+ "columns": {
+ "description": "Column headings for the search results. Each object is a column.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/sql._types.Column"
+ }
+ },
+ "cursor": {
+ "description": "The cursor for the next set of paginated results.\nFor CSV, TSV, and TXT responses, this value is returned in the `Cursor` HTTP header.",
+ "type": "string"
+ },
+ "rows": {
+ "description": "The values for the search results.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/sql._types.Row"
+ }
+ }
+ },
+ "required": [
+ "id",
+ "is_running",
+ "is_partial",
+ "rows"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET _sql/async/FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=?wait_for_completion_timeout=2s&format=json\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.sql.get_async(\n id=\"FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\",\n wait_for_completion_timeout=\"2s\",\n format=\"json\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.sql.getAsync({\n id: \"FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\",\n wait_for_completion_timeout: \"2s\",\n format: \"json\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.sql.get_async(\n id: \"FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\",\n wait_for_completion_timeout: \"2s\",\n format: \"json\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->sql()->getAsync([\n \"id\" => \"FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\",\n \"wait_for_completion_timeout\" => \"2s\",\n \"format\" => \"json\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_sql/async/FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=?wait_for_completion_timeout=2s&format=json\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.sql().getAsync(g -> g\n .format(\"json\")\n .id(\"FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\")\n .waitForCompletionTimeout(w -> w\n .offset(2)\n )\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_sql/async/status/{id}": {
+ "get": {
+ "tags": [
+ "sql"
+ ],
+ "summary": "Get the async SQL search status",
+ "description": "Get the current status of an async SQL search or a stored synchronous SQL search.\n\n## Required authorization\n\n* Cluster privileges: `monitor`\n",
+ "operationId": "sql-get-async-status",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "id",
+ "description": "The identifier for the search.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "expiration_time_in_millis": {
+ "description": "The timestamp, in milliseconds since the Unix epoch, when Elasticsearch will delete the search and its results, even if the search is still running.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "id": {
+ "description": "The identifier for the search.",
+ "type": "string"
+ },
+ "is_running": {
+ "description": "If `true`, the search is still running.\nIf `false`, the search has finished.",
+ "type": "boolean"
+ },
+ "is_partial": {
+ "description": "If `true`, the response does not contain complete search results.\nIf `is_partial` is `true` and `is_running` is `true`, the search is still running.\nIf `is_partial` is `true` but `is_running` is `false`, the results are partial due to a failure or timeout.",
+ "type": "boolean"
+ },
+ "start_time_in_millis": {
+ "description": "The timestamp, in milliseconds since the Unix epoch, when the search started.\nThe API returns this property only for running searches.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "completion_status": {
+ "description": "The HTTP status code for the search.\nThe API returns this property only for completed searches.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.uint"
+ }
+ ]
+ }
+ },
+ "required": [
+ "expiration_time_in_millis",
+ "id",
+ "is_running",
+ "is_partial",
+ "start_time_in_millis"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET _sql/async/status/FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.sql.get_async_status(\n id=\"FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.sql.getAsyncStatus({\n id: \"FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.sql.get_async_status(\n id: \"FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->sql()->getAsyncStatus([\n \"id\" => \"FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_sql/async/status/FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.sql().getAsyncStatus(g -> g\n .id(\"FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_sql": {
+ "get": {
+ "tags": [
+ "sql"
+ ],
+ "summary": "Get SQL search results\n",
+ "description": "**All methods and paths for this operation:**\n\n\n POST\n /_sql\n
\n \n GET\n /_sql\n
\n \n\nRun an SQL request.\n\n## Required authorization\n\n* Index privileges: `read`\n",
+ "operationId": "sql-query",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/sql.query-format"
+ }
+ ],
+ "requestBody": {
+ "$ref": "#/components/requestBodies/sql.query"
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/sql.query-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _sql?format=txt\n{\n \"query\": \"SELECT * FROM library ORDER BY page_count DESC LIMIT 5\"\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.sql.query(\n format=\"txt\",\n query=\"SELECT * FROM library ORDER BY page_count DESC LIMIT 5\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.sql.query({\n format: \"txt\",\n query: \"SELECT * FROM library ORDER BY page_count DESC LIMIT 5\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.sql.query(\n format: \"txt\",\n body: {\n \"query\": \"SELECT * FROM library ORDER BY page_count DESC LIMIT 5\"\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->sql()->query([\n \"format\" => \"txt\",\n \"body\" => [\n \"query\" => \"SELECT * FROM library ORDER BY page_count DESC LIMIT 5\",\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"query\":\"SELECT * FROM library ORDER BY page_count DESC LIMIT 5\"}' \"$ELASTICSEARCH_URL/_sql?format=txt\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.sql().query(q -> q\n .format(SqlFormat.Txt)\n .query(\"SELECT * FROM library ORDER BY page_count DESC LIMIT 5\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_sql/translate": {
+ "get": {
+ "tags": [
+ "sql"
+ ],
+ "summary": "Translate SQL into Elasticsearch queries\n",
+ "description": "**All methods and paths for this operation:**\n\n\n POST\n /_sql/translate\n
\n \n GET\n /_sql/translate\n
\n \n\nTranslate an SQL search into a search API request containing Query DSL.\nIt accepts the same request body parameters as the SQL search API, excluding `cursor`.\n\n## Required authorization\n\n* Index privileges: `read`\n",
+ "operationId": "sql-translate",
+ "requestBody": {
+ "$ref": "#/components/requestBodies/sql.translate"
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/sql.translate-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _sql/translate\n{\n \"query\": \"SELECT * FROM library ORDER BY page_count DESC\",\n \"fetch_size\": 10\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.sql.translate(\n query=\"SELECT * FROM library ORDER BY page_count DESC\",\n fetch_size=10,\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.sql.translate({\n query: \"SELECT * FROM library ORDER BY page_count DESC\",\n fetch_size: 10,\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.sql.translate(\n body: {\n \"query\": \"SELECT * FROM library ORDER BY page_count DESC\",\n \"fetch_size\": 10\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->sql()->translate([\n \"body\" => [\n \"query\" => \"SELECT * FROM library ORDER BY page_count DESC\",\n \"fetch_size\" => 10,\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"query\":\"SELECT * FROM library ORDER BY page_count DESC\",\"fetch_size\":10}' \"$ELASTICSEARCH_URL/_sql/translate\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.sql().translate(t -> t\n .fetchSize(10)\n .query(\"SELECT * FROM library ORDER BY page_count DESC\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_synonyms/{id}": {
+ "get": {
+ "tags": [
+ "synonyms"
+ ],
+ "summary": "Get a synonym set",
+ "description": "\n\n## Required authorization\n\n* Cluster privileges: `manage_search_synonyms`\n",
+ "operationId": "synonyms-get-synonym",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "id",
+ "description": "The synonyms set identifier to retrieve.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "from",
+ "description": "The starting offset for query rules to retrieve.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "size",
+ "description": "The max number of query rules to retrieve.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "description": "The total number of synonyms rules that the synonyms set contains.",
+ "type": "number"
+ },
+ "synonyms_set": {
+ "description": "Synonym rule details.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/synonyms._types.SynonymRuleRead"
+ }
+ }
+ },
+ "required": [
+ "count",
+ "synonyms_set"
+ ]
+ },
+ "examples": {
+ "SynonymsGetResponseExample1": {
+ "description": "A successful response from `GET _synonyms/my-synonyms-set`.",
+ "value": "{\n \"count\": 3,\n \"synonyms_set\": [\n {\n \"id\": \"test-1\",\n \"synonyms\": \"hello, hi\"\n },\n {\n \"id\": \"test-2\",\n \"synonyms\": \"bye, goodbye\"\n },\n {\n \"id\": \"test-3\",\n \"synonyms\": \"test => check\"\n }\n ]\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET _synonyms/my-synonyms-set\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.synonyms.get_synonym(\n id=\"my-synonyms-set\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.synonyms.getSynonym({\n id: \"my-synonyms-set\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.synonyms.get_synonym(\n id: \"my-synonyms-set\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->synonyms()->getSynonym([\n \"id\" => \"my-synonyms-set\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_synonyms/my-synonyms-set\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.synonyms().getSynonym(g -> g\n .id(\"my-synonyms-set\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "synonyms"
+ ],
+ "summary": "Create or update a synonym set",
+ "description": "Synonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.\n\nFor practical examples of how to create or update a synonyms set, refer to the External documentation.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_synonyms`\n",
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/solutions/search/full-text/create-update-synonyms-api-example",
+ "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/put-synonyms-set.html"
+ },
+ "operationId": "synonyms-put-synonym",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "id",
+ "description": "The ID of the synonyms set to be created or updated.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "synonyms_set": {
+ "description": "The synonym rules definitions for the synonyms set.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/synonyms._types.SynonymRule"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/synonyms._types.SynonymRule"
+ }
+ }
+ ]
+ }
+ },
+ "required": [
+ "synonyms_set"
+ ]
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "result": {
+ "description": "The update operation result.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Result"
+ }
+ ]
+ },
+ "reload_analyzers_details": {
+ "description": "Updating a synonyms set can reload the associated analyzers in case refresh is set to true.\nThis information is the analyzers reloading result.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices.reload_search_analyzers.ReloadResult"
+ }
+ ]
+ }
+ },
+ "required": [
+ "result"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "PUT _synonyms/my-synonyms-set\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.synonyms.put_synonym(\n id=\"my-synonyms-set\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.synonyms.putSynonym({\n id: \"my-synonyms-set\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.synonyms.put_synonym(\n id: \"my-synonyms-set\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->synonyms()->putSynonym([\n \"id\" => \"my-synonyms-set\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_synonyms/my-synonyms-set\""
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "synonyms"
+ ],
+ "summary": "Delete a synonym set",
+ "description": "You can only delete a synonyms set that is not in use by any index analyzer.\n\nSynonyms sets can be used in synonym graph token filters and synonym token filters.\nThese synonym filters can be used as part of search analyzers.\n\nAnalyzers need to be loaded when an index is restored (such as when a node starts, or the index becomes open).\nEven if the analyzer is not used on any field mapping, it still needs to be loaded on the index recovery phase.\n\nIf any analyzers cannot be loaded, the index becomes unavailable and the cluster status becomes red or yellow as index shards are not available.\nTo prevent that, synonyms sets that are used in analyzers can't be deleted.\nA delete request in this case will return a 400 response code.\n\nTo remove a synonyms set, you must first remove all indices that contain analyzers using it.\nYou can migrate an index by creating a new index that does not contain the token filter with the synonyms set, and use the reindex API in order to copy over the index data.\nOnce finished, you can delete the index.\nWhen the synonyms set is not used in analyzers, you will be able to delete it.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_synonyms`\n",
+ "operationId": "synonyms-delete-synonym",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "id",
+ "description": "The synonyms set identifier to delete.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "DELETE _synonyms/my-synonyms-set\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.synonyms.delete_synonym(\n id=\"my-synonyms-set\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.synonyms.deleteSynonym({\n id: \"my-synonyms-set\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.synonyms.delete_synonym(\n id: \"my-synonyms-set\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->synonyms()->deleteSynonym([\n \"id\" => \"my-synonyms-set\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_synonyms/my-synonyms-set\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.synonyms().deleteSynonym(d -> d\n .id(\"my-synonyms-set\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_synonyms/{set_id}/{rule_id}": {
+ "get": {
+ "tags": [
+ "synonyms"
+ ],
+ "summary": "Get a synonym rule",
+ "description": "Get a synonym rule from a synonym set.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_synonyms`\n",
+ "operationId": "synonyms-get-synonym-rule",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "set_id",
+ "description": "The ID of the synonym set to retrieve the synonym rule from.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "path",
+ "name": "rule_id",
+ "description": "The ID of the synonym rule to retrieve.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/synonyms._types.SynonymRuleRead"
+ },
+ "examples": {
+ "SynonymRuleGetResponseExample1": {
+ "description": "A successful response from `GET _synonyms/my-synonyms-set/test-1`.",
+ "value": "{\n \"id\": \"test-1\",\n \"synonyms\": \"hello, hi\"\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET _synonyms/my-synonyms-set/test-1\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.synonyms.get_synonym_rule(\n set_id=\"my-synonyms-set\",\n rule_id=\"test-1\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.synonyms.getSynonymRule({\n set_id: \"my-synonyms-set\",\n rule_id: \"test-1\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.synonyms.get_synonym_rule(\n set_id: \"my-synonyms-set\",\n rule_id: \"test-1\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->synonyms()->getSynonymRule([\n \"set_id\" => \"my-synonyms-set\",\n \"rule_id\" => \"test-1\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_synonyms/my-synonyms-set/test-1\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.synonyms().getSynonymRule(g -> g\n .ruleId(\"test-1\")\n .setId(\"my-synonyms-set\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "synonyms"
+ ],
+ "summary": "Create or update a synonym rule",
+ "description": "Create or update a synonym rule in a synonym set.\n\nIf any of the synonym rules included is invalid, the API returns an error.\n\nWhen you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_synonyms`\n",
+ "operationId": "synonyms-put-synonym-rule",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "set_id",
+ "description": "The ID of the synonym set.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "path",
+ "name": "rule_id",
+ "description": "The ID of the synonym rule to be updated or created.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "synonyms": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/text-analysis/analysis-synonym-graph-tokenfilter#analysis-synonym-graph-define-synonyms"
+ },
+ "description": "The synonym rule information definition, which must be in Solr format.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/synonyms._types.SynonymString"
+ }
+ ]
+ }
+ },
+ "required": [
+ "synonyms"
+ ]
+ },
+ "examples": {
+ "SynonymRulePutRequestExample1": {
+ "summary": "synonyms/apis/put-synonym-rule.asciidoc:107",
+ "description": "",
+ "value": "{\n \"synonyms\": \"hello, hi, howdy\"\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/synonyms._types.SynonymsUpdateResult"
+ },
+ "examples": {
+ "SynonymRuleResponseExample1": {
+ "description": "A successful response from `PUT _synonyms/my-synonyms-set/test-1`.\n",
+ "value": "{\n \"result\": \"updated\",\n \"reload_analyzers_details\": {\n \"_shards\": {\n \"total\": 2,\n \"successful\": 1,\n \"failed\": 0\n },\n \"reload_details\": [\n {\n \"index\": \"test-index\",\n \"reloaded_analyzers\": [\n \"my_search_analyzer\"\n ],\n \"reloaded_node_ids\": [\n \"1wYFZzq8Sxeu_Jvt9mlbkg\"\n ]\n }\n ]\n }\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "PUT _synonyms/my-synonyms-set/test-1\n{\n \"synonyms\": \"hello, hi, howdy\"\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.synonyms.put_synonym_rule(\n set_id=\"my-synonyms-set\",\n rule_id=\"test-1\",\n synonyms=\"hello, hi, howdy\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.synonyms.putSynonymRule({\n set_id: \"my-synonyms-set\",\n rule_id: \"test-1\",\n synonyms: \"hello, hi, howdy\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.synonyms.put_synonym_rule(\n set_id: \"my-synonyms-set\",\n rule_id: \"test-1\",\n body: {\n \"synonyms\": \"hello, hi, howdy\"\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->synonyms()->putSynonymRule([\n \"set_id\" => \"my-synonyms-set\",\n \"rule_id\" => \"test-1\",\n \"body\" => [\n \"synonyms\" => \"hello, hi, howdy\",\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"synonyms\":\"hello, hi, howdy\"}' \"$ELASTICSEARCH_URL/_synonyms/my-synonyms-set/test-1\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.synonyms().putSynonymRule(p -> p\n .ruleId(\"test-1\")\n .setId(\"my-synonyms-set\")\n .synonyms(\"hello, hi, howdy\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "synonyms"
+ ],
+ "summary": "Delete a synonym rule",
+ "description": "Delete a synonym rule from a synonym set.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_synonyms`\n",
+ "operationId": "synonyms-delete-synonym-rule",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "set_id",
+ "description": "The ID of the synonym set to update.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "path",
+ "name": "rule_id",
+ "description": "The ID of the synonym rule to delete.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/synonyms._types.SynonymsUpdateResult"
+ },
+ "examples": {
+ "SynonymRuleDeleteResponseExample1": {
+ "description": "A successful response from `DELETE _synonyms/my-synonyms-set/test-1`. All analyzers using this synonyms set will be reloaded automatically to reflect the rule being deleted.\n",
+ "value": "{\n \"result\": \"deleted\",\n \"reload_analyzers_details\": {\n \"_shards\": {\n \"total\": 2,\n \"successful\": 1,\n \"failed\": 0\n },\n \"reload_details\": [\n {\n \"index\": \"test-index\",\n \"reloaded_analyzers\": [\n \"my_search_analyzer\"\n ],\n \"reloaded_node_ids\": [\n \"1wYFZzq8Sxeu_Jvt9mlbkg\"\n ]\n }\n ]\n }\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "DELETE _synonyms/my-synonyms-set/test-1\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.synonyms.delete_synonym_rule(\n set_id=\"my-synonyms-set\",\n rule_id=\"test-1\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.synonyms.deleteSynonymRule({\n set_id: \"my-synonyms-set\",\n rule_id: \"test-1\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.synonyms.delete_synonym_rule(\n set_id: \"my-synonyms-set\",\n rule_id: \"test-1\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->synonyms()->deleteSynonymRule([\n \"set_id\" => \"my-synonyms-set\",\n \"rule_id\" => \"test-1\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_synonyms/my-synonyms-set/test-1\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.synonyms().deleteSynonymRule(d -> d\n .ruleId(\"test-1\")\n .setId(\"my-synonyms-set\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_synonyms": {
+ "get": {
+ "tags": [
+ "synonyms"
+ ],
+ "summary": "Get all synonym sets",
+ "description": "Get a summary of all defined synonym sets.\n\n## Required authorization\n\n* Cluster privileges: `manage_search_synonyms`\n",
+ "operationId": "synonyms-get-synonyms-sets",
+ "parameters": [
+ {
+ "in": "query",
+ "name": "from",
+ "description": "The starting offset for synonyms sets to retrieve.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "size",
+ "description": "The maximum number of synonyms sets to retrieve.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "description": "The total number of synonyms sets defined.",
+ "type": "number"
+ },
+ "results": {
+ "description": "The identifier and total number of defined synonym rules for each synonyms set.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/synonyms.get_synonyms_sets.SynonymsSetItem"
+ }
+ }
+ },
+ "required": [
+ "count",
+ "results"
+ ]
+ },
+ "examples": {
+ "SynonymsSetsGetResponseExample1": {
+ "description": "A successful response from `GET _synonyms`.",
+ "value": "{\n \"count\": 3,\n \"results\": [\n {\n \"synonyms_set\": \"ecommerce-synonyms\",\n \"count\": 2\n },\n {\n \"synonyms_set\": \"my-synonyms-set\",\n \"count\": 3\n },\n {\n \"synonyms_set\": \"new-ecommerce-synonyms\",\n \"count\": 1\n }\n ]\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET _synonyms\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.synonyms.get_synonyms_sets()"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.synonyms.getSynonymsSets();"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.synonyms.get_synonyms_sets"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->synonyms()->getSynonymsSets();"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_synonyms\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.synonyms().getSynonymsSets(g -> g);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_tasks/{task_id}": {
+ "get": {
+ "tags": [
+ "tasks"
+ ],
+ "summary": "Get task information",
+ "description": "Get information about a task currently running in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nIf the task identifier is not found, a 404 response code indicates that there are no resources that match the request.\n\n## Required authorization\n\n* Cluster privileges: `monitor`\n",
+ "operationId": "tasks-get",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "task_id",
+ "description": "The task identifier.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "timeout",
+ "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "wait_for_completion",
+ "description": "If `true`, the request blocks until the task has completed.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "completed": {
+ "type": "boolean"
+ },
+ "task": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/tasks._types.TaskInfo"
+ }
+ ]
+ },
+ "response": {
+ "type": "object"
+ },
+ "error": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ErrorCause"
+ }
+ ]
+ }
+ },
+ "required": [
+ "completed",
+ "task"
+ ]
+ },
+ "examples": {
+ "GetTaskResponseExample1": {
+ "summary": "Get cluster actions",
+ "description": "A successful response from `GET _tasks?actions=cluster:*`, which retrieves all cluster-related tasks.\n",
+ "value": "{\n \"nodes\" : {\n \"oTUltX4IQMOUUVeiohTt8A\" : {\n \"name\" : \"H5dfFeA\",\n \"transport_address\" : \"127.0.0.1:9300\",\n \"host\" : \"127.0.0.1\",\n \"ip\" : \"127.0.0.1:9300\",\n \"tasks\" : {\n \"oTUltX4IQMOUUVeiohTt8A:124\" : {\n \"node\" : \"oTUltX4IQMOUUVeiohTt8A\",\n \"id\" : 124,\n \"type\" : \"direct\",\n \"action\" : \"cluster:monitor/tasks/lists[n]\",\n \"start_time_in_millis\" : 1458585884904,\n \"running_time_in_nanos\" : 47402,\n \"cancellable\" : false,\n \"parent_task_id\" : \"oTUltX4IQMOUUVeiohTt8A:123\"\n },\n \"oTUltX4IQMOUUVeiohTt8A:123\" : {\n \"node\" : \"oTUltX4IQMOUUVeiohTt8A\",\n \"id\" : 123,\n \"type\" : \"transport\",\n \"action\" : \"cluster:monitor/tasks/lists\",\n \"start_time_in_millis\" : 1458585884904,\n \"running_time_in_nanos\" : 236042,\n \"cancellable\" : false\n }\n }\n }\n }\n}"
+ },
+ "GetTaskResponseExample2": {
+ "summary": "Get details about a delete by query",
+ "description": "A successful response from `GET _tasks?detailed=true&actions=*/delete/byquery`, which gets the status of a delete by query operation. The `status` object contains the actual status. `total` is the total number of operations that the reindex expects to perform. You can estimate the progress by adding the `updated`, `created`, and `deleted` fields. The request will finish when their sum is equal to the `total` field.\n",
+ "value": "{\n \"nodes\" : {\n \"r1A2WoRbTwKZ516z6NEs5A\" : {\n \"name\" : \"r1A2WoR\",\n \"transport_address\" : \"127.0.0.1:9300\",\n \"host\" : \"127.0.0.1\",\n \"ip\" : \"127.0.0.1:9300\",\n \"attributes\" : {\n \"testattr\" : \"test\",\n \"portsfile\" : \"true\"\n },\n \"tasks\" : {\n \"r1A2WoRbTwKZ516z6NEs5A:36619\" : {\n \"node\" : \"r1A2WoRbTwKZ516z6NEs5A\",\n \"id\" : 36619,\n \"type\" : \"transport\",\n \"action\" : \"indices:data/write/delete/byquery\",\n \"status\" : { \n \"total\" : 6154,\n \"updated\" : 0,\n \"created\" : 0,\n \"deleted\" : 3500,\n \"batches\" : 36,\n \"version_conflicts\" : 0,\n \"noops\" : 0,\n \"retries\": 0,\n \"throttled_millis\": 0\n },\n \"description\" : \"\"\n }\n }\n }\n }\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Technical preview",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET _tasks?detailed=true&actions=*/delete/byquery\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.tasks.list(\n detailed=True,\n actions=\"*/delete/byquery\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.tasks.list({\n detailed: \"true\",\n actions: \"*/delete/byquery\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.tasks.list(\n detailed: \"true\",\n actions: \"*/delete/byquery\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->tasks()->list([\n \"detailed\" => \"true\",\n \"actions\" => \"*/delete/byquery\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_tasks?detailed=true&actions=*/delete/byquery\""
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/{index}/_terms_enum": {
+ "post": {
+ "tags": [
+ "search"
+ ],
+ "summary": "Get terms in an index\n",
+ "description": "**All methods and paths for this operation:**\n\n\n GET\n /{index}/_terms_enum\n
\n \n POST\n /{index}/_terms_enum\n
\n \n\nDiscover terms that match a partial string in an index.\nThis API is designed for low-latency look-ups used in auto-complete scenarios.\n\n> info\n> The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.",
+ "operationId": "terms-enum",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/terms_enum-index"
+ }
+ ],
+ "requestBody": {
+ "$ref": "#/components/requestBodies/terms_enum"
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/terms_enum-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST stackoverflow/_terms_enum\n{\n \"field\" : \"tags\",\n \"string\" : \"kiba\"\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.terms_enum(\n index=\"stackoverflow\",\n field=\"tags\",\n string=\"kiba\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.termsEnum({\n index: \"stackoverflow\",\n field: \"tags\",\n string: \"kiba\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.terms_enum(\n index: \"stackoverflow\",\n body: {\n \"field\": \"tags\",\n \"string\": \"kiba\"\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->termsEnum([\n \"index\" => \"stackoverflow\",\n \"body\" => [\n \"field\" => \"tags\",\n \"string\" => \"kiba\",\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"field\":\"tags\",\"string\":\"kiba\"}' \"$ELASTICSEARCH_URL/stackoverflow/_terms_enum\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.termsEnum(t -> t\n .field(\"tags\")\n .index(\"stackoverflow\")\n .string(\"kiba\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/{index}/_termvectors/{id}": {
+ "post": {
+ "tags": [
+ "document"
+ ],
+ "summary": "Get term vector information\n",
+ "description": "**All methods and paths for this operation:**\n\n\n GET\n /{index}/_termvectors\n
\n \n POST\n /{index}/_termvectors\n
\n \n GET\n /{index}/_termvectors/{id}\n
\n \n POST\n /{index}/_termvectors/{id}\n
\n \n\nGet information and statistics about terms in the fields of a particular document.\n\nYou can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request.\nYou can specify the fields you are interested in through the `fields` parameter or by adding the fields to the request body.\nFor example:\n\n```\nGET /my-index-000001/_termvectors/1?fields=message\n```\n\nFields can be specified using wildcards, similar to the multi match query.\n\nTerm vectors are real-time by default, not near real-time.\nThis can be changed by setting `realtime` parameter to `false`.\n\nYou can request three types of values: _term information_, _term statistics_, and _field statistics_.\nBy default, all term information and field statistics are returned for all fields but term statistics are excluded.\n\n**Term information**\n\n* term frequency in the field (always returned)\n* term positions (`positions: true`)\n* start and end offsets (`offsets: true`)\n* term payloads (`payloads: true`), as base64 encoded bytes\n\nIf the requested information wasn't stored in the index, it will be computed on the fly if possible.\nAdditionally, term vectors could be computed for documents not even existing in the index, but instead provided by the user.\n\n> warn\n> Start and end offsets assume UTF-16 encoding is being used. If you want to use these offsets in order to get the original text that produced this token, you should make sure that the string you are taking a sub-string of is also encoded using UTF-16.\n\n**Behaviour**\n\nThe term and field statistics are not accurate.\nDeleted documents are not taken into account.\nThe information is only retrieved for the shard the requested document resides in.\nThe term and field statistics are therefore only useful as relative measures whereas the absolute numbers have no meaning in this context.\nBy default, when requesting term vectors of artificial documents, a shard to get the statistics from is randomly selected.\nUse `routing` only to hit a particular shard.\nRefer to the linked documentation for detailed examples of how to use this API.\n\n## Required authorization\n\n* Index privileges: `read`\n",
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/term-vectors-examples",
+ "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/docs-termvectors.html"
+ },
+ "operationId": "termvectors",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/termvectors-index"
+ },
+ {
+ "$ref": "#/components/parameters/termvectors-id"
+ },
+ {
+ "$ref": "#/components/parameters/termvectors-fields"
+ },
+ {
+ "$ref": "#/components/parameters/termvectors-field_statistics"
+ },
+ {
+ "$ref": "#/components/parameters/termvectors-offsets"
+ },
+ {
+ "$ref": "#/components/parameters/termvectors-payloads"
+ },
+ {
+ "$ref": "#/components/parameters/termvectors-positions"
+ },
+ {
+ "$ref": "#/components/parameters/termvectors-preference"
+ },
+ {
+ "$ref": "#/components/parameters/termvectors-realtime"
+ },
+ {
+ "$ref": "#/components/parameters/termvectors-routing"
+ },
+ {
+ "$ref": "#/components/parameters/termvectors-term_statistics"
+ },
+ {
+ "$ref": "#/components/parameters/termvectors-version"
+ },
+ {
+ "$ref": "#/components/parameters/termvectors-version_type"
+ }
+ ],
+ "requestBody": {
+ "$ref": "#/components/requestBodies/termvectors"
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/termvectors-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET /my-index-000001/_termvectors/1\n{\n \"fields\" : [\"text\"],\n \"offsets\" : true,\n \"payloads\" : true,\n \"positions\" : true,\n \"term_statistics\" : true,\n \"field_statistics\" : true\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.termvectors(\n index=\"my-index-000001\",\n id=\"1\",\n fields=[\n \"text\"\n ],\n offsets=True,\n payloads=True,\n positions=True,\n term_statistics=True,\n field_statistics=True,\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.termvectors({\n index: \"my-index-000001\",\n id: 1,\n fields: [\"text\"],\n offsets: true,\n payloads: true,\n positions: true,\n term_statistics: true,\n field_statistics: true,\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.termvectors(\n index: \"my-index-000001\",\n id: \"1\",\n body: {\n \"fields\": [\n \"text\"\n ],\n \"offsets\": true,\n \"payloads\": true,\n \"positions\": true,\n \"term_statistics\": true,\n \"field_statistics\": true\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->termvectors([\n \"index\" => \"my-index-000001\",\n \"id\" => \"1\",\n \"body\" => [\n \"fields\" => array(\n \"text\",\n ),\n \"offsets\" => true,\n \"payloads\" => true,\n \"positions\" => true,\n \"term_statistics\" => true,\n \"field_statistics\" => true,\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"fields\":[\"text\"],\"offsets\":true,\"payloads\":true,\"positions\":true,\"term_statistics\":true,\"field_statistics\":true}' \"$ELASTICSEARCH_URL/my-index-000001/_termvectors/1\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.termvectors(t -> t\n .fieldStatistics(true)\n .fields(\"text\")\n .id(\"1\")\n .index(\"my-index-000001\")\n .offsets(true)\n .payloads(true)\n .positions(true)\n .termStatistics(true)\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_transform/{transform_id}": {
+ "get": {
+ "tags": [
+ "transform"
+ ],
+ "summary": "Get transforms\n",
+ "description": "**All methods and paths for this operation:**\n\n\n GET\n /_transform\n
\n \n GET\n /_transform/{transform_id}\n
\n \n\nGet configuration information for transforms.\n\n## Required authorization\n\n* Cluster privileges: `monitor_transform`\n",
+ "operationId": "transform-get-transform",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/transform.get_transform-transform_id"
+ },
+ {
+ "$ref": "#/components/parameters/transform.get_transform-allow_no_match"
+ },
+ {
+ "$ref": "#/components/parameters/transform.get_transform-from"
+ },
+ {
+ "$ref": "#/components/parameters/transform.get_transform-size"
+ },
+ {
+ "$ref": "#/components/parameters/transform.get_transform-exclude_generated"
+ }
+ ],
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/transform.get_transform-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET _transform?size=10\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.transform.get_transform(\n size=\"10\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.transform.getTransform({\n size: 10,\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.transform.get_transform(\n size: \"10\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->transform()->getTransform([\n \"size\" => \"10\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_transform?size=10\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.transform().getTransform(g -> g\n .size(10)\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "transform"
+ ],
+ "summary": "Create a transform",
+ "description": "Creates 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.\n\n## Required authorization\n\n* Index privileges: `create_index`,`read`,`index`,`view_index_metadata`\n* Cluster privileges: `manage_transform`\n",
+ "operationId": "transform-put-transform",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "transform_id",
+ "description": "Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "defer_validation",
+ "description": "When the transform is created, a series of validations occur to ensure its success. For example, there is a\ncheck for the existence of the source indices and a check that the destination index is not part of the source\nindex pattern. You can use this parameter to skip the checks, for example when the source index does not exist\nuntil after the transform is created. The validations are always run when you start the transform, however, with\nthe exception of privilege checks.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "timeout",
+ "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "dest": {
+ "description": "The destination for the transform.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.Destination"
+ }
+ ]
+ },
+ "description": {
+ "description": "Free text description of the transform.",
+ "type": "string"
+ },
+ "frequency": {
+ "description": "The interval between checks for changes in the source indices when the transform is running continuously. Also\ndetermines the retry interval in the event of transient failures while the transform is searching or indexing.\nThe minimum value is `1s` and the maximum is `1h`.",
+ "default": "1m",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "latest": {
+ "description": "The latest method transforms the data by finding the latest document for each unique key.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.Latest"
+ }
+ ]
+ },
+ "_meta": {
+ "description": "Defines optional transform metadata.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ },
+ "pivot": {
+ "description": "The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields\nand the aggregation to reduce the data.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.Pivot"
+ }
+ ]
+ },
+ "retention_policy": {
+ "description": "Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the\ndestination index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.RetentionPolicyContainer"
+ }
+ ]
+ },
+ "settings": {
+ "description": "Defines optional transform settings.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.Settings"
+ }
+ ]
+ },
+ "source": {
+ "description": "The source of the data for the transform.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.Source"
+ }
+ ]
+ },
+ "sync": {
+ "description": "Defines the properties transforms require to run continuously.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.SyncContainer"
+ }
+ ]
+ }
+ },
+ "required": [
+ "dest",
+ "source"
+ ]
+ },
+ "examples": {
+ "PutTransformRequestExample1": {
+ "summary": "A pivot transform",
+ "description": "Run `PUT _transform/ecommerce_transform1` to create a transform that uses the pivot method.",
+ "value": "{\n \"source\": {\n \"index\": \"kibana_sample_data_ecommerce\",\n \"query\": {\n \"term\": {\n \"geoip.continent_name\": {\n \"value\": \"Asia\"\n }\n }\n }\n },\n \"pivot\": {\n \"group_by\": {\n \"customer_id\": {\n \"terms\": {\n \"field\": \"customer_id\",\n \"missing_bucket\": true\n }\n }\n },\n \"aggregations\": {\n \"max_price\": {\n \"max\": {\n \"field\": \"taxful_total_price\"\n }\n }\n }\n },\n \"description\": \"Maximum priced ecommerce data by customer_id in Asia\",\n \"dest\": {\n \"index\": \"kibana_sample_data_ecommerce_transform1\",\n \"pipeline\": \"add_timestamp_pipeline\"\n },\n \"frequency\": \"5m\",\n \"sync\": {\n \"time\": {\n \"field\": \"order_date\",\n \"delay\": \"60s\"\n }\n },\n \"retention_policy\": {\n \"time\": {\n \"field\": \"order_date\",\n \"max_age\": \"30d\"\n }\n }\n}"
+ },
+ "PutTransformRequestExample2": {
+ "summary": "A latest transform",
+ "description": "Run `PUT _transform/ecommerce_transform2` to create a transform that uses the latest method.",
+ "value": "{\n \"source\": {\n \"index\": \"kibana_sample_data_ecommerce\"\n },\n \"latest\": {\n \"unique_key\": [\n \"customer_id\"\n ],\n \"sort\": \"order_date\"\n },\n \"description\": \"Latest order for each customer\",\n \"dest\": {\n \"index\": \"kibana_sample_data_ecommerce_transform2\"\n },\n \"frequency\": \"5m\",\n \"sync\": {\n \"time\": {\n \"field\": \"order_date\",\n \"delay\": \"60s\"\n }\n }\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
+ },
+ "examples": {
+ "PutTransformResponseExample1": {
+ "description": "A successful response when creating a transform.",
+ "value": "{\n \"acknowledged\": true\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "PUT _transform/ecommerce_transform1\n{\n \"source\": {\n \"index\": \"kibana_sample_data_ecommerce\",\n \"query\": {\n \"term\": {\n \"geoip.continent_name\": {\n \"value\": \"Asia\"\n }\n }\n }\n },\n \"pivot\": {\n \"group_by\": {\n \"customer_id\": {\n \"terms\": {\n \"field\": \"customer_id\",\n \"missing_bucket\": true\n }\n }\n },\n \"aggregations\": {\n \"max_price\": {\n \"max\": {\n \"field\": \"taxful_total_price\"\n }\n }\n }\n },\n \"description\": \"Maximum priced ecommerce data by customer_id in Asia\",\n \"dest\": {\n \"index\": \"kibana_sample_data_ecommerce_transform1\",\n \"pipeline\": \"add_timestamp_pipeline\"\n },\n \"frequency\": \"5m\",\n \"sync\": {\n \"time\": {\n \"field\": \"order_date\",\n \"delay\": \"60s\"\n }\n },\n \"retention_policy\": {\n \"time\": {\n \"field\": \"order_date\",\n \"max_age\": \"30d\"\n }\n }\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.transform.put_transform(\n transform_id=\"ecommerce_transform1\",\n source={\n \"index\": \"kibana_sample_data_ecommerce\",\n \"query\": {\n \"term\": {\n \"geoip.continent_name\": {\n \"value\": \"Asia\"\n }\n }\n }\n },\n pivot={\n \"group_by\": {\n \"customer_id\": {\n \"terms\": {\n \"field\": \"customer_id\",\n \"missing_bucket\": True\n }\n }\n },\n \"aggregations\": {\n \"max_price\": {\n \"max\": {\n \"field\": \"taxful_total_price\"\n }\n }\n }\n },\n description=\"Maximum priced ecommerce data by customer_id in Asia\",\n dest={\n \"index\": \"kibana_sample_data_ecommerce_transform1\",\n \"pipeline\": \"add_timestamp_pipeline\"\n },\n frequency=\"5m\",\n sync={\n \"time\": {\n \"field\": \"order_date\",\n \"delay\": \"60s\"\n }\n },\n retention_policy={\n \"time\": {\n \"field\": \"order_date\",\n \"max_age\": \"30d\"\n }\n },\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.transform.putTransform({\n transform_id: \"ecommerce_transform1\",\n source: {\n index: \"kibana_sample_data_ecommerce\",\n query: {\n term: {\n \"geoip.continent_name\": {\n value: \"Asia\",\n },\n },\n },\n },\n pivot: {\n group_by: {\n customer_id: {\n terms: {\n field: \"customer_id\",\n missing_bucket: true,\n },\n },\n },\n aggregations: {\n max_price: {\n max: {\n field: \"taxful_total_price\",\n },\n },\n },\n },\n description: \"Maximum priced ecommerce data by customer_id in Asia\",\n dest: {\n index: \"kibana_sample_data_ecommerce_transform1\",\n pipeline: \"add_timestamp_pipeline\",\n },\n frequency: \"5m\",\n sync: {\n time: {\n field: \"order_date\",\n delay: \"60s\",\n },\n },\n retention_policy: {\n time: {\n field: \"order_date\",\n max_age: \"30d\",\n },\n },\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.transform.put_transform(\n transform_id: \"ecommerce_transform1\",\n body: {\n \"source\": {\n \"index\": \"kibana_sample_data_ecommerce\",\n \"query\": {\n \"term\": {\n \"geoip.continent_name\": {\n \"value\": \"Asia\"\n }\n }\n }\n },\n \"pivot\": {\n \"group_by\": {\n \"customer_id\": {\n \"terms\": {\n \"field\": \"customer_id\",\n \"missing_bucket\": true\n }\n }\n },\n \"aggregations\": {\n \"max_price\": {\n \"max\": {\n \"field\": \"taxful_total_price\"\n }\n }\n }\n },\n \"description\": \"Maximum priced ecommerce data by customer_id in Asia\",\n \"dest\": {\n \"index\": \"kibana_sample_data_ecommerce_transform1\",\n \"pipeline\": \"add_timestamp_pipeline\"\n },\n \"frequency\": \"5m\",\n \"sync\": {\n \"time\": {\n \"field\": \"order_date\",\n \"delay\": \"60s\"\n }\n },\n \"retention_policy\": {\n \"time\": {\n \"field\": \"order_date\",\n \"max_age\": \"30d\"\n }\n }\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->transform()->putTransform([\n \"transform_id\" => \"ecommerce_transform1\",\n \"body\" => [\n \"source\" => [\n \"index\" => \"kibana_sample_data_ecommerce\",\n \"query\" => [\n \"term\" => [\n \"geoip.continent_name\" => [\n \"value\" => \"Asia\",\n ],\n ],\n ],\n ],\n \"pivot\" => [\n \"group_by\" => [\n \"customer_id\" => [\n \"terms\" => [\n \"field\" => \"customer_id\",\n \"missing_bucket\" => true,\n ],\n ],\n ],\n \"aggregations\" => [\n \"max_price\" => [\n \"max\" => [\n \"field\" => \"taxful_total_price\",\n ],\n ],\n ],\n ],\n \"description\" => \"Maximum priced ecommerce data by customer_id in Asia\",\n \"dest\" => [\n \"index\" => \"kibana_sample_data_ecommerce_transform1\",\n \"pipeline\" => \"add_timestamp_pipeline\",\n ],\n \"frequency\" => \"5m\",\n \"sync\" => [\n \"time\" => [\n \"field\" => \"order_date\",\n \"delay\" => \"60s\",\n ],\n ],\n \"retention_policy\" => [\n \"time\" => [\n \"field\" => \"order_date\",\n \"max_age\" => \"30d\",\n ],\n ],\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X PUT -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"source\":{\"index\":\"kibana_sample_data_ecommerce\",\"query\":{\"term\":{\"geoip.continent_name\":{\"value\":\"Asia\"}}}},\"pivot\":{\"group_by\":{\"customer_id\":{\"terms\":{\"field\":\"customer_id\",\"missing_bucket\":true}}},\"aggregations\":{\"max_price\":{\"max\":{\"field\":\"taxful_total_price\"}}}},\"description\":\"Maximum priced ecommerce data by customer_id in Asia\",\"dest\":{\"index\":\"kibana_sample_data_ecommerce_transform1\",\"pipeline\":\"add_timestamp_pipeline\"},\"frequency\":\"5m\",\"sync\":{\"time\":{\"field\":\"order_date\",\"delay\":\"60s\"}},\"retention_policy\":{\"time\":{\"field\":\"order_date\",\"max_age\":\"30d\"}}}' \"$ELASTICSEARCH_URL/_transform/ecommerce_transform1\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.transform().putTransform(p -> p\n .description(\"Maximum priced ecommerce data by customer_id in Asia\")\n .dest(d -> d\n .index(\"kibana_sample_data_ecommerce_transform1\")\n .pipeline(\"add_timestamp_pipeline\")\n )\n .frequency(f -> f\n .time(\"5m\")\n )\n .pivot(pi -> pi\n .aggregations(\"max_price\", a -> a\n .max(m -> m\n .field(\"taxful_total_price\")\n )\n )\n .groupBy(\"customer_id\", g -> g\n .terms(t -> t\n .field(\"customer_id\")\n .missingBucket(true)\n )\n )\n )\n .retentionPolicy(r -> r\n .time(t -> t\n .field(\"order_date\")\n .maxAge(m -> m\n .time(\"30d\")\n )\n )\n )\n .source(s -> s\n .index(\"kibana_sample_data_ecommerce\")\n .query(q -> q\n .term(te -> te\n .field(\"geoip.continent_name\")\n .value(FieldValue.of(\"Asia\"))\n )\n )\n )\n .sync(sy -> sy\n .time(ti -> ti\n .delay(d -> d\n .time(\"60s\")\n )\n .field(\"order_date\")\n )\n )\n .transformId(\"ecommerce_transform1\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "transform"
+ ],
+ "summary": "Delete a transform",
+ "description": "\n\n## Required authorization\n\n* Cluster privileges: `manage_transform`\n",
+ "operationId": "transform-delete-transform",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "transform_id",
+ "description": "Identifier for the transform.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "force",
+ "description": "If this value is false, the transform must be stopped before it can be deleted. If true, the transform is\ndeleted regardless of its current state.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "delete_dest_index",
+ "description": "If this value is true, the destination index is deleted together with the transform. If false, the destination\nindex will not be deleted",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "timeout",
+ "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
+ },
+ "examples": {
+ "DeleteTransformResponseExample1": {
+ "description": "A successful response when the transform is deleted.",
+ "value": "{\n \"acknowledged\": true\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "DELETE _transform/ecommerce_transform\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.transform.delete_transform(\n transform_id=\"ecommerce_transform\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.transform.deleteTransform({\n transform_id: \"ecommerce_transform\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.transform.delete_transform(\n transform_id: \"ecommerce_transform\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->transform()->deleteTransform([\n \"transform_id\" => \"ecommerce_transform\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X DELETE -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_transform/ecommerce_transform\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.transform().deleteTransform(d -> d\n .transformId(\"ecommerce_transform\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_transform/{transform_id}/_stats": {
+ "get": {
+ "tags": [
+ "transform"
+ ],
+ "summary": "Get transform stats",
+ "description": "Get usage information for transforms.\n\n## Required authorization\n\n* Index privileges: `read`,`view_index_metadata`\n* Cluster privileges: `monitor_transform`\n",
+ "operationId": "transform-get-transform-stats",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "transform_id",
+ "description": "Identifier for the transform. It can be a transform identifier or a\nwildcard expression. You can get information for all transforms by using\n`_all`, by specifying `*` as the ``, or by omitting the\n``.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Names"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "allow_no_match",
+ "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no transforms that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf this parameter is false, the request returns a 404 status code when\nthere are no matches or only partial matches.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "from",
+ "description": "Skips the specified number of transforms.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "size",
+ "description": "Specifies the maximum number of transforms to obtain.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "timeout",
+ "description": "Controls the time to wait for the stats",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number"
+ },
+ "transforms": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/transform.get_transform_stats.TransformStats"
+ }
+ }
+ },
+ "required": [
+ "count",
+ "transforms"
+ ]
+ },
+ "examples": {
+ "GetTransformStatsResponseExample1": {
+ "description": "A successful response that contains usage information for a transform.",
+ "value": "{\n \"count\": 1,\n \"transforms\": [\n {\n \"id\": \"ecommerce-customer-transform\",\n \"state\": \"started\",\n \"node\": {\n \"id\": \"cpTIGMsVQ8Gqwqlxxxxxxx\",\n \"name\": \"my.home\",\n \"ephemeral_id\": \"5-L21nFsQxxxxxxxxxx-xx\",\n \"transport_address\": \"127.0.0.1:9300\",\n \"attributes\": {}\n },\n \"stats\": {\n \"pages_processed\": 78,\n \"documents_processed\": 6027,\n \"documents_indexed\": 68,\n \"documents_deleted\": 22,\n \"delete_time_in_ms\": 214,\n \"trigger_count\": 168,\n \"index_time_in_ms\": 412,\n \"index_total\": 20,\n \"index_failures\": 0,\n \"search_time_in_ms\": 353,\n \"search_total\": 78,\n \"search_failures\": 0,\n \"processing_time_in_ms\": 8,\n \"processing_total\": 78,\n \"exponential_avg_checkpoint_duration_ms\": 97.30637923893185,\n \"exponential_avg_documents_indexed\": 2.2064915040974062,\n \"exponential_avg_documents_processed\": 179.89419945785045\n },\n \"checkpointing\": {\n \"last\": {\n \"checkpoint\": 20,\n \"timestamp_millis\": 1585344558220,\n \"time_upper_bound_millis\": 1585344498220\n },\n \"changes_last_detected_at\": 1585344558219\n },\n \"health\": {\n \"status\": \"green\"\n }\n }\n ]\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "GET _transform/ecommerce-customer-transform/_stats\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.transform.get_transform_stats(\n transform_id=\"ecommerce-customer-transform\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.transform.getTransformStats({\n transform_id: \"ecommerce-customer-transform\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.transform.get_transform_stats(\n transform_id: \"ecommerce-customer-transform\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->transform()->getTransformStats([\n \"transform_id\" => \"ecommerce-customer-transform\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_transform/ecommerce-customer-transform/_stats\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.transform().getTransformStats(g -> g\n .transformId(\"ecommerce-customer-transform\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_transform/{transform_id}/_preview": {
+ "post": {
+ "tags": [
+ "transform"
+ ],
+ "summary": "Preview a transform\n",
+ "description": "**All methods and paths for this operation:**\n\n\n GET\n /_transform/_preview\n
\n \n POST\n /_transform/_preview\n
\n \n GET\n /_transform/{transform_id}/_preview\n
\n \n POST\n /_transform/{transform_id}/_preview\n
\n \n\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.\n\n## Required authorization\n\n* Index privileges: `read`,`view_index_metadata`\n* Cluster privileges: `manage_transform`\n",
+ "operationId": "transform-preview-transform",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/transform.preview_transform-transform_id"
+ },
+ {
+ "$ref": "#/components/parameters/transform.preview_transform-timeout"
+ }
+ ],
+ "requestBody": {
+ "$ref": "#/components/requestBodies/transform.preview_transform"
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/transform.preview_transform-200"
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _transform/_preview\n{\n \"source\": {\n \"index\": \"kibana_sample_data_ecommerce\"\n },\n \"pivot\": {\n \"group_by\": {\n \"customer_id\": {\n \"terms\": {\n \"field\": \"customer_id\",\n \"missing_bucket\": true\n }\n }\n },\n \"aggregations\": {\n \"max_price\": {\n \"max\": {\n \"field\": \"taxful_total_price\"\n }\n }\n }\n }\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.transform.preview_transform(\n source={\n \"index\": \"kibana_sample_data_ecommerce\"\n },\n pivot={\n \"group_by\": {\n \"customer_id\": {\n \"terms\": {\n \"field\": \"customer_id\",\n \"missing_bucket\": True\n }\n }\n },\n \"aggregations\": {\n \"max_price\": {\n \"max\": {\n \"field\": \"taxful_total_price\"\n }\n }\n }\n },\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.transform.previewTransform({\n source: {\n index: \"kibana_sample_data_ecommerce\",\n },\n pivot: {\n group_by: {\n customer_id: {\n terms: {\n field: \"customer_id\",\n missing_bucket: true,\n },\n },\n },\n aggregations: {\n max_price: {\n max: {\n field: \"taxful_total_price\",\n },\n },\n },\n },\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.transform.preview_transform(\n body: {\n \"source\": {\n \"index\": \"kibana_sample_data_ecommerce\"\n },\n \"pivot\": {\n \"group_by\": {\n \"customer_id\": {\n \"terms\": {\n \"field\": \"customer_id\",\n \"missing_bucket\": true\n }\n }\n },\n \"aggregations\": {\n \"max_price\": {\n \"max\": {\n \"field\": \"taxful_total_price\"\n }\n }\n }\n }\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->transform()->previewTransform([\n \"body\" => [\n \"source\" => [\n \"index\" => \"kibana_sample_data_ecommerce\",\n ],\n \"pivot\" => [\n \"group_by\" => [\n \"customer_id\" => [\n \"terms\" => [\n \"field\" => \"customer_id\",\n \"missing_bucket\" => true,\n ],\n ],\n ],\n \"aggregations\" => [\n \"max_price\" => [\n \"max\" => [\n \"field\" => \"taxful_total_price\",\n ],\n ],\n ],\n ],\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"source\":{\"index\":\"kibana_sample_data_ecommerce\"},\"pivot\":{\"group_by\":{\"customer_id\":{\"terms\":{\"field\":\"customer_id\",\"missing_bucket\":true}}},\"aggregations\":{\"max_price\":{\"max\":{\"field\":\"taxful_total_price\"}}}}}' \"$ELASTICSEARCH_URL/_transform/_preview\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.transform().previewTransform(p -> p\n .pivot(pi -> pi\n .aggregations(\"max_price\", a -> a\n .max(m -> m\n .field(\"taxful_total_price\")\n )\n )\n .groupBy(\"customer_id\", g -> g\n .terms(t -> t\n .field(\"customer_id\")\n .missingBucket(true)\n )\n )\n )\n .source(s -> s\n .index(\"kibana_sample_data_ecommerce\")\n )\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_transform/{transform_id}/_reset": {
+ "post": {
+ "tags": [
+ "transform"
+ ],
+ "summary": "Reset a transform",
+ "description": "Before 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.\n\n## Required authorization\n\n* Cluster privileges: `manage_transform`\n",
+ "operationId": "transform-reset-transform",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "transform_id",
+ "description": "Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "force",
+ "description": "If this value is `true`, the transform is reset regardless of its current state. If it's `false`, the transform\nmust be stopped before it can be reset.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "timeout",
+ "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
+ },
+ "examples": {
+ "ResetTransformResponseExample1": {
+ "description": "A successful response when the transform is reset.",
+ "value": "{\n \"acknowledged\": true\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _transform/ecommerce_transform/_reset\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.transform.reset_transform(\n transform_id=\"ecommerce_transform\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.transform.resetTransform({\n transform_id: \"ecommerce_transform\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.transform.reset_transform(\n transform_id: \"ecommerce_transform\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->transform()->resetTransform([\n \"transform_id\" => \"ecommerce_transform\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_transform/ecommerce_transform/_reset\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.transform().resetTransform(r -> r\n .transformId(\"ecommerce_transform\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_transform/{transform_id}/_schedule_now": {
+ "post": {
+ "tags": [
+ "transform"
+ ],
+ "summary": "Schedule a transform to start now",
+ "description": "Instantly run a transform to process data.\nIf you run this API, the transform will process the new data instantly,\nwithout waiting for the configured frequency interval. After the API is called,\nthe transform will be processed again at `now + frequency` unless the API\nis called again in the meantime.\n\n## Required authorization\n\n* Cluster privileges: `manage_transform`\n",
+ "operationId": "transform-schedule-now-transform",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "transform_id",
+ "description": "Identifier for the transform.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "timeout",
+ "description": "Controls the time to wait for the scheduling to take place",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
+ },
+ "examples": {
+ "ScheduleNowTransformResponseExample1": {
+ "description": "A successful response when the transform is scheduled to run now.",
+ "value": "{\n \"acknowledged\": true\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _transform/ecommerce_transform/_schedule_now\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.transform.schedule_now_transform(\n transform_id=\"ecommerce_transform\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.transform.scheduleNowTransform({\n transform_id: \"ecommerce_transform\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.transform.schedule_now_transform(\n transform_id: \"ecommerce_transform\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->transform()->scheduleNowTransform([\n \"transform_id\" => \"ecommerce_transform\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_transform/ecommerce_transform/_schedule_now\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.transform().scheduleNowTransform(s -> s\n .transformId(\"ecommerce_transform\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_transform/{transform_id}/_start": {
+ "post": {
+ "tags": [
+ "transform"
+ ],
+ "summary": "Start a transform",
+ "description": "When 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.\n\n## Required authorization\n\n* Index privileges: `read`,`view_index_metadata`\n* Cluster privileges: `manage_transform`\n",
+ "operationId": "transform-start-transform",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "transform_id",
+ "description": "Identifier for the transform.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "timeout",
+ "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "from",
+ "description": "Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
+ },
+ "examples": {
+ "StartTransformResponseExample1": {
+ "description": "A successful response when a transform starts.",
+ "value": "{\n \"acknowledged\": true\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _transform/ecommerce-customer-transform/_start\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.transform.start_transform(\n transform_id=\"ecommerce-customer-transform\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.transform.startTransform({\n transform_id: \"ecommerce-customer-transform\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.transform.start_transform(\n transform_id: \"ecommerce-customer-transform\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->transform()->startTransform([\n \"transform_id\" => \"ecommerce-customer-transform\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_transform/ecommerce-customer-transform/_start\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.transform().startTransform(s -> s\n .transformId(\"ecommerce-customer-transform\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_transform/{transform_id}/_stop": {
+ "post": {
+ "tags": [
+ "transform"
+ ],
+ "summary": "Stop transforms",
+ "description": "Stops one or more transforms.\n\n## Required authorization\n\n* Cluster privileges: `manage_transform`\n",
+ "operationId": "transform-stop-transform",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "transform_id",
+ "description": "Identifier for the transform. To stop multiple transforms, use a comma-separated list or a wildcard expression.\nTo stop all transforms, use `_all` or `*` as the identifier.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Name"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "allow_no_match",
+ "description": "Specifies what to do when the request: contains wildcard expressions and there are no transforms that match;\ncontains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there\nare only partial matches.\n\nIf it is true, the API returns a successful acknowledgement message when there are no matches. When there are\nonly partial matches, the API stops the appropriate transforms.\n\nIf it is false, the request returns a 404 status code when there are no matches or only partial matches.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "force",
+ "description": "If it is true, the API forcefully stops the transforms.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "timeout",
+ "description": "Period to wait for a response when `wait_for_completion` is `true`. If no response is received before the\ntimeout expires, the request returns a timeout exception. However, the request continues processing and\neventually moves the transform to a STOPPED state.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "wait_for_checkpoint",
+ "description": "If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false,\nthe transform stops as soon as possible.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "wait_for_completion",
+ "description": "If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns\nimmediately and the indexer is stopped asynchronously in the background.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
+ },
+ "examples": {
+ "StopTransformResponseExample1": {
+ "description": "A successful response when a transform stops.",
+ "value": "{\n \"acknowledged\": true\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _transform/ecommerce_transform/_stop\n"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.transform.stop_transform(\n transform_id=\"ecommerce_transform\",\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.transform.stopTransform({\n transform_id: \"ecommerce_transform\",\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.transform.stop_transform(\n transform_id: \"ecommerce_transform\"\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->transform()->stopTransform([\n \"transform_id\" => \"ecommerce_transform\",\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_transform/ecommerce_transform/_stop\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.transform().stopTransform(s -> s\n .transformId(\"ecommerce_transform\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/_transform/{transform_id}/_update": {
+ "post": {
+ "tags": [
+ "transform"
+ ],
+ "summary": "Update a transform",
+ "description": "Updates 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.\n\n## Required authorization\n\n* Index privileges: `read`,`index`,`view_index_metadata`\n* Cluster privileges: `manage_transform`\n",
+ "operationId": "transform-update-transform",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "transform_id",
+ "description": "Identifier for the transform.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "defer_validation",
+ "description": "When true, deferrable validations are not run. This behavior may be\ndesired if the source index does not exist until after the transform is\ncreated.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "timeout",
+ "description": "Period to wait for a response. If no response is received before the\ntimeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "dest": {
+ "description": "The destination for the transform.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.Destination"
+ }
+ ]
+ },
+ "description": {
+ "description": "Free text description of the transform.",
+ "type": "string"
+ },
+ "frequency": {
+ "description": "The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is 1s and the maximum is 1h.",
+ "default": "1m",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "_meta": {
+ "description": "Defines optional transform metadata.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ },
+ "source": {
+ "description": "The source of the data for the transform.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.Source"
+ }
+ ]
+ },
+ "settings": {
+ "description": "Defines optional transform settings.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.Settings"
+ }
+ ]
+ },
+ "sync": {
+ "description": "Defines the properties transforms require to run continuously.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.SyncContainer"
+ }
+ ]
+ },
+ "retention_policy": {
+ "description": "Defines a retention policy for the transform. Data that meets the defined\ncriteria is deleted from the destination index.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.RetentionPolicyContainer"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "UpdateTransformRequestExample1": {
+ "description": "Run `POST _transform/simple-kibana-ecomm-pivot/_update` to update a transform that uses the pivot method.",
+ "value": "{\n \"source\": {\n \"index\": \"kibana_sample_data_ecommerce\",\n \"query\": {\n \"term\": {\n \"geoip.continent_name\": {\n \"value\": \"Asia\"\n }\n }\n }\n },\n \"description\": \"Maximum priced ecommerce data by customer_id in Asia\",\n \"dest\": {\n \"index\": \"kibana_sample_data_ecommerce_transform_v2\",\n \"pipeline\": \"add_timestamp_pipeline\"\n },\n \"frequency\": \"15m\",\n \"sync\": {\n \"time\": {\n \"field\": \"order_date\",\n \"delay\": \"120s\"\n }\n }\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "authorization": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TransformAuthorization"
+ }
+ ]
+ },
+ "create_time": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "dest": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.reindex.Destination"
+ }
+ ]
+ },
+ "frequency": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "latest": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.Latest"
+ }
+ ]
+ },
+ "pivot": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.Pivot"
+ }
+ ]
+ },
+ "retention_policy": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.RetentionPolicyContainer"
+ }
+ ]
+ },
+ "settings": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.Settings"
+ }
+ ]
+ },
+ "source": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.reindex.Source"
+ }
+ ]
+ },
+ "sync": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.SyncContainer"
+ }
+ ]
+ },
+ "version": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ },
+ "_meta": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ }
+ },
+ "required": [
+ "create_time",
+ "description",
+ "dest",
+ "id",
+ "settings",
+ "source",
+ "version"
+ ]
+ },
+ "examples": {
+ "UpdateTransformResponseExample1": {
+ "description": "A successful response when creating a transform.",
+ "value": "{\n \"id\": \"simple-kibana-ecomm-pivot\",\n \"authorization\": {\n \"roles\": [\n \"superuser\"\n ]\n },\n \"version\": \"10.0.0\",\n \"create_time\": 1712951576767,\n \"source\": {\n \"index\": [\n \"kibana_sample_data_ecommerce\"\n ],\n \"query\": {\n \"term\": {\n \"geoip.continent_name\": {\n \"value\": \"Asia\"\n }\n }\n }\n },\n \"dest\": {\n \"index\": \"kibana_sample_data_ecommerce_transform_v2\",\n \"pipeline\": \"add_timestamp_pipeline\"\n },\n \"frequency\": \"15m\",\n \"sync\": {\n \"time\": {\n \"field\": \"order_date\",\n \"delay\": \"120s\"\n }\n },\n \"pivot\": {\n \"group_by\": {\n \"customer_id\": {\n \"terms\": {\n \"field\": \"customer_id\",\n \"missing_bucket\": true\n }\n }\n },\n \"aggregations\": {\n \"max_price\": {\n \"max\": {\n \"field\": \"taxful_total_price\"\n }\n }\n }\n },\n \"description\": \"Maximum priced ecommerce data by customer_id in Asia\",\n \"settings\": {},\n \"retention_policy\": {\n \"time\": {\n \"field\": \"order_date\",\n \"max_age\": \"30d\"\n }\n }\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST _transform/simple-kibana-ecomm-pivot/_update\n{\n \"source\": {\n \"index\": \"kibana_sample_data_ecommerce\",\n \"query\": {\n \"term\": {\n \"geoip.continent_name\": {\n \"value\": \"Asia\"\n }\n }\n }\n },\n \"description\": \"Maximum priced ecommerce data by customer_id in Asia\",\n \"dest\": {\n \"index\": \"kibana_sample_data_ecommerce_transform_v2\",\n \"pipeline\": \"add_timestamp_pipeline\"\n },\n \"frequency\": \"15m\",\n \"sync\": {\n \"time\": {\n \"field\": \"order_date\",\n \"delay\": \"120s\"\n }\n }\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.transform.update_transform(\n transform_id=\"simple-kibana-ecomm-pivot\",\n source={\n \"index\": \"kibana_sample_data_ecommerce\",\n \"query\": {\n \"term\": {\n \"geoip.continent_name\": {\n \"value\": \"Asia\"\n }\n }\n }\n },\n description=\"Maximum priced ecommerce data by customer_id in Asia\",\n dest={\n \"index\": \"kibana_sample_data_ecommerce_transform_v2\",\n \"pipeline\": \"add_timestamp_pipeline\"\n },\n frequency=\"15m\",\n sync={\n \"time\": {\n \"field\": \"order_date\",\n \"delay\": \"120s\"\n }\n },\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.transform.updateTransform({\n transform_id: \"simple-kibana-ecomm-pivot\",\n source: {\n index: \"kibana_sample_data_ecommerce\",\n query: {\n term: {\n \"geoip.continent_name\": {\n value: \"Asia\",\n },\n },\n },\n },\n description: \"Maximum priced ecommerce data by customer_id in Asia\",\n dest: {\n index: \"kibana_sample_data_ecommerce_transform_v2\",\n pipeline: \"add_timestamp_pipeline\",\n },\n frequency: \"15m\",\n sync: {\n time: {\n field: \"order_date\",\n delay: \"120s\",\n },\n },\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.transform.update_transform(\n transform_id: \"simple-kibana-ecomm-pivot\",\n body: {\n \"source\": {\n \"index\": \"kibana_sample_data_ecommerce\",\n \"query\": {\n \"term\": {\n \"geoip.continent_name\": {\n \"value\": \"Asia\"\n }\n }\n }\n },\n \"description\": \"Maximum priced ecommerce data by customer_id in Asia\",\n \"dest\": {\n \"index\": \"kibana_sample_data_ecommerce_transform_v2\",\n \"pipeline\": \"add_timestamp_pipeline\"\n },\n \"frequency\": \"15m\",\n \"sync\": {\n \"time\": {\n \"field\": \"order_date\",\n \"delay\": \"120s\"\n }\n }\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->transform()->updateTransform([\n \"transform_id\" => \"simple-kibana-ecomm-pivot\",\n \"body\" => [\n \"source\" => [\n \"index\" => \"kibana_sample_data_ecommerce\",\n \"query\" => [\n \"term\" => [\n \"geoip.continent_name\" => [\n \"value\" => \"Asia\",\n ],\n ],\n ],\n ],\n \"description\" => \"Maximum priced ecommerce data by customer_id in Asia\",\n \"dest\" => [\n \"index\" => \"kibana_sample_data_ecommerce_transform_v2\",\n \"pipeline\" => \"add_timestamp_pipeline\",\n ],\n \"frequency\" => \"15m\",\n \"sync\" => [\n \"time\" => [\n \"field\" => \"order_date\",\n \"delay\" => \"120s\",\n ],\n ],\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"source\":{\"index\":\"kibana_sample_data_ecommerce\",\"query\":{\"term\":{\"geoip.continent_name\":{\"value\":\"Asia\"}}}},\"description\":\"Maximum priced ecommerce data by customer_id in Asia\",\"dest\":{\"index\":\"kibana_sample_data_ecommerce_transform_v2\",\"pipeline\":\"add_timestamp_pipeline\"},\"frequency\":\"15m\",\"sync\":{\"time\":{\"field\":\"order_date\",\"delay\":\"120s\"}}}' \"$ELASTICSEARCH_URL/_transform/simple-kibana-ecomm-pivot/_update\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.transform().updateTransform(u -> u\n .description(\"Maximum priced ecommerce data by customer_id in Asia\")\n .dest(d -> d\n .index(\"kibana_sample_data_ecommerce_transform1\")\n .pipeline(\"add_timestamp_pipeline\")\n )\n .frequency(f -> f\n .time(\"5m\")\n )\n .retentionPolicy(r -> r\n .time(t -> t\n .field(\"order_date\")\n .maxAge(m -> m\n .time(\"30d\")\n )\n )\n )\n .source(s -> s\n .index(\"kibana_sample_data_ecommerce\")\n .query(q -> q\n .term(te -> te\n .field(\"geoip.continent_name\")\n .value(FieldValue.of(\"Asia\"))\n )\n )\n )\n .sync(sy -> sy\n .time(ti -> ti\n .delay(d -> d\n .time(\"60s\")\n )\n .field(\"order_date\")\n )\n )\n .transformId(\"simple-kibana-ecomm-pivot\")\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/{index}/_update/{id}": {
+ "post": {
+ "tags": [
+ "document"
+ ],
+ "summary": "Update a document",
+ "description": "Update a document by running a script or passing a partial document.\n\nIf the Elasticsearch security features are enabled, you must have the `index` or `write` index privilege for the target index or index alias.\n\nThe script can update, delete, or skip modifying the document.\nThe API also supports passing a partial document, which is merged into the existing document.\nTo fully replace an existing document, use the index API.\nThis operation:\n\n* Gets the document (collocated with the shard) from the index.\n* Runs the specified script.\n* Indexes the result.\n\nThe document must still be reindexed, but using this API removes some network roundtrips and reduces chances of version conflicts between the GET and the index operation.\n\nThe `_source` field must be enabled to use this API.\nIn addition to `_source`, you can access the following variables through the `ctx` map: `_index`, `_type`, `_id`, `_version`, `_routing`, and `_now` (the current timestamp).\nFor usage examples such as partial updates, upserts, and scripted updates, see the External documentation.\n\n## Required authorization\n\n* Index privileges: `write`\n",
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/update-document",
+ "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/docs-update.html"
+ },
+ "operationId": "update",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "index",
+ "description": "The name of the target index.\nBy default, the index is created automatically if it doesn't exist.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.IndexName"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "path",
+ "name": "id",
+ "description": "A unique identifier for the document to be updated.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "if_primary_term",
+ "description": "Only perform the operation if the document has this primary term.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "if_seq_no",
+ "description": "Only perform the operation if the document has this sequence number.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.SequenceNumber"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "include_source_on_error",
+ "description": "True or false if to include the document source in the error message in case of parsing errors.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "lang",
+ "description": "The script language.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "refresh",
+ "description": "If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf 'wait_for', it waits for a refresh to make this operation visible to search.\nIf 'false', it does nothing with refreshes.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Refresh"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "require_alias",
+ "description": "If `true`, the destination must be an index alias.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "retry_on_conflict",
+ "description": "The number of times the operation should be retried when a conflict occurs.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "routing",
+ "description": "A custom value used to route operations to a specific shard.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Routing"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "timeout",
+ "description": "The period to wait for the following operations: dynamic mapping updates and waiting for active shards.\nElasticsearch waits for at least the timeout period before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "wait_for_active_shards",
+ "description": "The number of copies of each shard that must be active before proceeding with the operation.\nSet to 'all' or any positive integer up to the total number of shards in the index (`number_of_replicas`+1).\nThe default value of `1` means it waits for each primary shard to be active.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.WaitForActiveShards"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "_source",
+ "description": "If `false`, source retrieval is turned off.\nYou can also specify a comma-separated list of the fields you want to retrieve.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_global.search._types.SourceConfigParam"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "_source_excludes",
+ "description": "The source fields you want to exclude.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Fields"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "_source_includes",
+ "description": "The source fields you want to retrieve.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Fields"
+ },
+ "style": "form"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "detect_noop": {
+ "description": "If `true`, the `result` in the response is set to `noop` (no operation) when there are no changes to the document.",
+ "default": true,
+ "type": "boolean"
+ },
+ "doc": {
+ "description": "A partial update to an existing document.\nIf both `doc` and `script` are specified, `doc` is ignored.",
+ "type": "object"
+ },
+ "doc_as_upsert": {
+ "description": "If `true`, use the contents of 'doc' as the value of 'upsert'.\nNOTE: Using ingest pipelines with `doc_as_upsert` is not supported.",
+ "default": false,
+ "type": "boolean"
+ },
+ "script": {
+ "description": "The script to run to update the document.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "scripted_upsert": {
+ "description": "If `true`, run the script whether or not the document exists.",
+ "default": false,
+ "type": "boolean"
+ },
+ "_source": {
+ "description": "If `false`, turn off source retrieval.\nYou can also specify a comma-separated list of the fields you want to retrieve.",
+ "default": "true",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.SourceConfig"
+ }
+ ]
+ },
+ "upsert": {
+ "description": "If the document does not already exist, the contents of 'upsert' are inserted as a new document.\nIf the document exists, the 'script' is run.",
+ "type": "object"
+ }
+ }
+ },
+ "examples": {
+ "UpdateRequestExample1": {
+ "summary": "Update a counter with a script",
+ "description": "Run `POST test/_update/1` to increment a counter by using a script.",
+ "value": "{\n \"script\" : {\n \"source\": \"ctx._source.counter += params.count\",\n \"lang\": \"painless\",\n \"params\" : {\n \"count\" : 4\n }\n }\n}"
+ },
+ "UpdateRequestExample10": {
+ "summary": "Scripted upsert",
+ "description": "Run `POST test/_update/1` to perform a scripted upsert. When `scripted_upsert` is `true`, the script runs whether or not the document exists.\n",
+ "value": "{\n \"scripted_upsert\": true,\n \"script\": {\n \"source\": \"\"\"\n if ( ctx.op == 'create' ) {\n ctx._source.counter = params.count\n } else {\n ctx._source.counter += params.count\n }\n \"\"\",\n \"params\": {\n \"count\": 4\n }\n },\n \"upsert\": {}\n}"
+ },
+ "UpdateRequestExample11": {
+ "summary": "Doc as upsert",
+ "description": "Run `POST test/_update/1` to perform a doc as upsert. Instead of sending a partial `doc` plus an `upsert` doc, you can set `doc_as_upsert` to `true` to use the contents of `doc` as the `upsert` value.\n",
+ "value": "{\n \"doc\": {\n \"name\": \"new_name\"\n },\n \"doc_as_upsert\": true\n}"
+ },
+ "UpdateRequestExample2": {
+ "summary": "Add a tag with a script",
+ "description": "Run `POST test/_update/1` to use a script to add a tag to a list of tags. In this example, it is just a list, so the tag is added even it exists.\n",
+ "value": "{\n \"script\": {\n \"source\": \"ctx._source.tags.add(params.tag)\",\n \"lang\": \"painless\",\n \"params\": {\n \"tag\": \"blue\"\n }\n }\n}"
+ },
+ "UpdateRequestExample3": {
+ "summary": "Remove a tag with a script",
+ "description": "Run `POST test/_update/1` to use a script to remove a tag from a list of tags. The Painless function to remove a tag takes the array index of the element you want to remove. To avoid a possible runtime error, you first need to make sure the tag exists. If the list contains duplicates of the tag, this script just removes one occurrence.\n",
+ "value": "{\n \"script\": {\n \"source\": \"if (ctx._source.tags.contains(params.tag)) { ctx._source.tags.remove(ctx._source.tags.indexOf(params.tag)) }\",\n \"lang\": \"painless\",\n \"params\": {\n \"tag\": \"blue\"\n }\n }\n}"
+ },
+ "UpdateRequestExample4": {
+ "summary": "Add fields with a script",
+ "description": "Run `POST test/_update/1` to use a script to add a field `new_field` to the document.\n",
+ "value": "{\n \"script\" : \"ctx._source.new_field = 'value_of_new_field'\"\n}"
+ },
+ "UpdateRequestExample5": {
+ "summary": "Remove fields with a script",
+ "description": "Run `POST test/_update/1` to use a script to remove a field `new_field` from the document.\n",
+ "value": "{\n \"script\" : \"ctx._source.remove('new_field')\"\n}"
+ },
+ "UpdateRequestExample6": {
+ "summary": "Remove subfields with a script",
+ "description": "Run `POST test/_update/1` to use a script to remove a subfield from an object field.\n",
+ "value": "{\n \"script\": \"ctx._source['my-object'].remove('my-subfield')\"\n}"
+ },
+ "UpdateRequestExample7": {
+ "summary": "Change the operation with a script",
+ "description": "Run `POST test/_update/1` to change the operation that runs from within the script. For example, this request deletes the document if the `tags` field contains `green`, otherwise it does nothing (`noop`).\n",
+ "value": "{\n \"script\": {\n \"source\": \"if (ctx._source.tags.contains(params.tag)) { ctx.op = 'delete' } else { ctx.op = 'noop' }\",\n \"lang\": \"painless\",\n \"params\": {\n \"tag\": \"green\"\n }\n }\n}"
+ },
+ "UpdateRequestExample8": {
+ "summary": "Update part of a document",
+ "description": "Run `POST test/_update/1` to do a partial update that adds a new field to the existing document.\n",
+ "value": "{\n \"doc\": {\n \"name\": \"new_name\"\n }\n}"
+ },
+ "UpdateRequestExample9": {
+ "summary": "Upsert",
+ "description": "Run `POST test/_update/1` to perfom an upsert. If the document does not already exist, the contents of the upsert element are inserted as a new document. If the document exists, the script is run.\n",
+ "value": "{\n \"script\": {\n \"source\": \"ctx._source.counter += params.count\",\n \"lang\": \"painless\",\n \"params\": {\n \"count\": 4\n }\n },\n \"upsert\": {\n \"counter\": 1\n }\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_global.update.UpdateWriteResponseBase"
+ },
+ "examples": {
+ "UpdateResponseExample1": {
+ "summary": "Detect noop updates",
+ "description": "By default updates that don't change anything detect that they don't change anything and return `\"result\": \"noop\"`.\n",
+ "value": "{\n \"_shards\": {\n \"total\": 0,\n \"successful\": 0,\n \"failed\": 0\n },\n \"_index\": \"test\",\n \"_id\": \"1\",\n \"_version\": 2,\n \"_primary_term\": 1,\n \"_seq_no\": 1,\n \"result\": \"noop\"\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST test/_update/1\n{\n \"script\" : {\n \"source\": \"ctx._source.counter += params.count\",\n \"lang\": \"painless\",\n \"params\" : {\n \"count\" : 4\n }\n }\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.update(\n index=\"test\",\n id=\"1\",\n script={\n \"source\": \"ctx._source.counter += params.count\",\n \"lang\": \"painless\",\n \"params\": {\n \"count\": 4\n }\n },\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.update({\n index: \"test\",\n id: 1,\n script: {\n source: \"ctx._source.counter += params.count\",\n lang: \"painless\",\n params: {\n count: 4,\n },\n },\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.update(\n index: \"test\",\n id: \"1\",\n body: {\n \"script\": {\n \"source\": \"ctx._source.counter += params.count\",\n \"lang\": \"painless\",\n \"params\": {\n \"count\": 4\n }\n }\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->update([\n \"index\" => \"test\",\n \"id\" => \"1\",\n \"body\" => [\n \"script\" => [\n \"source\" => \"ctx._source.counter += params.count\",\n \"lang\" => \"painless\",\n \"params\" => [\n \"count\" => 4,\n ],\n ],\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"script\":{\"source\":\"ctx._source.counter += params.count\",\"lang\":\"painless\",\"params\":{\"count\":4}}}' \"$ELASTICSEARCH_URL/test/_update/1\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.update(u -> u\n .id(\"1\")\n .index(\"test\")\n .script(s -> s\n .source(so -> so\n .scriptString(\"ctx._source.counter += params.count\")\n )\n .params(\"count\", JsonData.fromJson(\"4\"))\n .lang(\"painless\")\n )\n,Void.class);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ },
+ "/{index}/_update_by_query": {
+ "post": {
+ "tags": [
+ "document"
+ ],
+ "summary": "Update documents",
+ "description": "Updates documents that match the specified query.\nIf no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias:\n\n* `read`\n* `index` or `write`\n\nYou can specify the query criteria in the request URI or the request body using the same syntax as the search API.\n\nWhen you submit an update by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and updates matching documents using internal versioning.\nWhen the versions match, the document is updated and the version number is incremented.\nIf a document changes between the time that the snapshot is taken and the update operation is processed, it results in a version conflict and the operation fails.\nYou can opt to count version conflicts instead of halting and returning by setting `conflicts` to `proceed`.\nNote that if you opt to count version conflicts, the operation could attempt to update more documents from the source than `max_docs` until it has successfully updated `max_docs` documents or it has gone through every document in the source query.\n\nNOTE: Documents with a version equal to 0 cannot be updated using update by query because internal versioning does not support 0 as a valid version number.\n\nWhile processing an update by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents.\nA bulk update request is performed for each batch of matching documents.\nAny query or update failures cause the update by query request to fail and the failures are shown in the response.\nAny update requests that completed successfully still stick, they are not rolled back.\n\n**Refreshing shards**\n\nSpecifying the `refresh` parameter refreshes all shards once the request completes.\nThis is different to the update API's `refresh` parameter, which causes only the shard\nthat received the request to be refreshed. Unlike the update API, it does not support\n`wait_for`.\n\n**Running update by query asynchronously**\n\nIf the request contains `wait_for_completion=false`, Elasticsearch\nperforms some preflight checks, launches the request, and returns a\n[task](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks) you can use to cancel or get the status of the task.\nElasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`.\n\n**Waiting for active shards**\n\n`wait_for_active_shards` controls how many copies of a shard must be active\nbefore proceeding with the request. See [`wait_for_active_shards`](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create#operation-create-wait_for_active_shards)\nfor details. `timeout` controls how long each write request waits for unavailable\nshards to become available. Both work exactly the way they work in the\n[Bulk API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk). Update by query uses scrolled searches, so you can also\nspecify the `scroll` parameter to control how long it keeps the search context\nalive, for example `?scroll=10m`. The default is 5 minutes.\n\n**Throttling update requests**\n\nTo control the rate at which update by query issues batches of update operations, you can set `requests_per_second` to any positive decimal number.\nThis pads each batch with a wait time to throttle the rate.\nSet `requests_per_second` to `-1` to turn off throttling.\n\nThrottling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account.\nThe padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing.\nBy default the batch size is 1000, so if `requests_per_second` is set to `500`:\n\n```\ntarget_time = 1000 / 500 per second = 2 seconds\nwait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds\n```\n\nSince the batch is issued as a single _bulk request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set.\nThis is \"bursty\" instead of \"smooth\".\n\n**Slicing**\n\nUpdate by query supports sliced scroll to parallelize the update process.\nThis can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nSetting `slices` to `auto` chooses a reasonable number for most data streams and indices.\nThis setting will use one slice per shard, up to a certain limit.\nIf there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards.\n\nAdding `slices` to `_update_by_query` just automates the manual process of creating sub-requests, which means it has some quirks:\n\n* You can see these requests in the tasks APIs. These sub-requests are \"child\" tasks of the task for the request with slices.\n* Fetching the status of the task for the request with `slices` only contains the status of completed slices.\n* These sub-requests are individually addressable for things like cancellation and rethrottling.\n* Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally.\n* Canceling the request with slices will cancel each sub-request.\n* Due to the nature of slices each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution.\n* Parameters like `requests_per_second` and `max_docs` on a request with slices are distributed proportionally to each sub-request. Combine that with the point above about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being updated.\n* Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time.\n\nIf you're slicing manually or otherwise tuning automatic slicing, keep in mind that:\n\n* Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many slices hurts performance. Setting slices higher than the number of shards generally does not improve efficiency and adds overhead.\n* Update performance scales linearly across available resources with the number of slices.\n\nWhether query or update performance dominates the runtime depends on the documents being reindexed and cluster resources.\nRefer to the linked documentation for examples of how to update documents using the `_update_by_query` API:\n\n## Required authorization\n\n* Index privileges: `read`,`write`\n",
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/update-by-query-api",
+ "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/docs-update-by-query.html"
+ },
+ "operationId": "update-by-query",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "index",
+ "description": "A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams or indices, omit this parameter or use `*` or `_all`.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ {
+ "in": "query",
+ "name": "allow_no_indices",
+ "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`.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "analyzer",
+ "description": "The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "analyze_wildcard",
+ "description": "If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "conflicts",
+ "description": "The preferred behavior when update by query hits version conflicts: `abort` or `proceed`.\n\nSupported values include:\n - `abort`: Stop reindexing if there are conflicts.\n - `proceed`: Continue reindexing even if there are conflicts.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Conflicts"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "default_operator",
+ "description": "The default operator for query string query: `AND` or `OR`.\nThis parameter can be used only when the `q` query string parameter is specified.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.query_dsl.Operator"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "df",
+ "description": "The field to use as default where no field prefix is given in the query string.\nThis parameter can be used only when the `q` query string parameter is specified.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "expand_wildcards",
+ "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`.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ExpandWildcards"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "from",
+ "description": "Skips the specified number of documents.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "ignore_unavailable",
+ "description": "If `false`, the request returns an error if it targets a missing or closed index.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "lenient",
+ "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.\nThis parameter can be used only when the `q` query string parameter is specified.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "max_docs",
+ "description": "The maximum number of documents to process.\nIt defaults to all documents.\nWhen set to a value less then or equal to `scroll_size` then a scroll will not be used to retrieve the results for the operation.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "pipeline",
+ "description": "The ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "preference",
+ "description": "The node or shard the operation should be performed on.\nIt is random by default.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "q",
+ "description": "A query in the Lucene query string syntax.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "refresh",
+ "description": "If `true`, Elasticsearch refreshes affected shards to make the operation visible to search after the request completes.\nThis is different than the update API's `refresh` parameter, which causes just the shard that received the request to be refreshed.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "request_cache",
+ "description": "If `true`, the request cache is used for this request.\nIt defaults to the index-level setting.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "requests_per_second",
+ "description": "The throttle for this request in sub-requests per second.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "routing",
+ "description": "A custom value used to route operations to a specific shard.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Routing"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "scroll",
+ "description": "The period to retain the search context for scrolling.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "scroll_size",
+ "description": "The size of the scroll request that powers the operation.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "search_timeout",
+ "description": "An explicit timeout for each search request.\nBy default, there is no timeout.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "search_type",
+ "description": "The type of the search operation. Available options include `query_then_fetch` and `dfs_query_then_fetch`.\n\nSupported values include:\n - `query_then_fetch`: Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.\n - `dfs_query_then_fetch`: Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.SearchType"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "slices",
+ "description": "The number of slices this task should be divided into.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Slices"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "sort",
+ "description": "A comma-separated list of : pairs.",
+ "deprecated": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "stats",
+ "description": "The specific `tag` of the request for logging and statistical purposes.",
+ "deprecated": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "terminate_after",
+ "description": "The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this parameter to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "timeout",
+ "description": "The period each update request waits for the following operations: dynamic mapping updates, waiting for active shards.\nBy default, it is one minute.\nThis guarantees Elasticsearch waits for at least the timeout before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "version",
+ "description": "If `true`, returns the document version as part of a hit.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "version_type",
+ "description": "Should the document increment the version number (internal) on hit or not (reindex)",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "wait_for_active_shards",
+ "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe `timeout` parameter controls how long each write request waits for unavailable shards to become available.\nBoth work exactly the way they work in the bulk API.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.WaitForActiveShards"
+ },
+ "style": "form"
+ },
+ {
+ "in": "query",
+ "name": "wait_for_completion",
+ "description": "If `true`, the request blocks until the operation is complete.\nIf `false`, Elasticsearch performs some preflight checks, launches the request, and returns a task ID that you can use to cancel or get the status of the task.\nElasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "max_docs": {
+ "description": "The maximum number of documents to update.",
+ "type": "number"
+ },
+ "query": {
+ "description": "The documents to update using the Query DSL.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "script": {
+ "description": "The script to run to update the document source or metadata when updating.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "slice": {
+ "description": "Slice the request manually using the provided slice ID and total number of slices.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SlicedScroll"
+ }
+ ]
+ },
+ "conflicts": {
+ "description": "The preferred behavior when update by query hits version conflicts: `abort` or `proceed`.\n\nSupported values include:\n - `abort`: Stop reindexing if there are conflicts.\n - `proceed`: Continue reindexing even if there are conflicts.\n\n",
+ "default": "abort",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Conflicts"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "UpdateByQueryRequestExample1": {
+ "summary": "Update selected documents",
+ "description": "Run `POST my-index-000001/_update_by_query?conflicts=proceed` to update documents that match a query.\n",
+ "value": "{\n \"query\": { \n \"term\": {\n \"user.id\": \"kimchy\"\n }\n }\n}"
+ },
+ "UpdateByQueryRequestExample2": {
+ "summary": "Update the document source",
+ "description": "Run `POST my-index-000001/_update_by_query` with a script to update the document source. It increments the `count` field for all documents with a `user.id` of `kimchy` in `my-index-000001`.\n",
+ "value": "{\n \"script\": {\n \"source\": \"ctx._source.count++\",\n \"lang\": \"painless\"\n },\n \"query\": {\n \"term\": {\n \"user.id\": \"kimchy\"\n }\n }\n}"
+ },
+ "UpdateByQueryRequestExample3": {
+ "summary": "Slice manually",
+ "description": "Run `POST my-index-000001/_update_by_query` to slice an update by query manually. Provide a slice ID and total number of slices to each request.\n",
+ "value": "{\n \"slice\": {\n \"id\": 0,\n \"max\": 2\n },\n \"script\": {\n \"source\": \"ctx._source['extra'] = 'test'\"\n }\n}"
+ },
+ "UpdateByQueryRequestExample4": {
+ "summary": "Slice automatically",
+ "description": "Run `POST my-index-000001/_update_by_query?refresh&slices=5` to use automatic slicing. It automatically parallelizes using sliced scroll to slice on `_id`.\n",
+ "value": "{\n \"script\": {\n \"source\": \"ctx._source['extra'] = 'test'\"\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "batches": {
+ "description": "The number of scroll responses pulled back by the update by query.",
+ "type": "number"
+ },
+ "failures": {
+ "description": "Array of failures if there were any unrecoverable errors during the process.\nIf this is non-empty then the request ended because of those failures.\nUpdate by query is implemented using batches.\nAny failure causes the entire process to end, but all failures in the current batch are collected into the array.\nYou can use the `conflicts` option to prevent reindex from ending when version conflicts occur.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.BulkIndexByScrollFailure"
+ }
+ },
+ "noops": {
+ "description": "The number of documents that were ignored because the script used for the update by query returned a noop value for `ctx.op`.",
+ "type": "number"
+ },
+ "deleted": {
+ "description": "The number of documents that were successfully deleted.",
+ "type": "number"
+ },
+ "requests_per_second": {
+ "description": "The number of requests per second effectively run during the update by query.",
+ "type": "number"
+ },
+ "retries": {
+ "description": "The number of retries attempted by update by query.\n`bulk` is the number of bulk actions retried.\n`search` is the number of search actions retried.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Retries"
+ }
+ ]
+ },
+ "task": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.TaskId"
+ }
+ ]
+ },
+ "timed_out": {
+ "description": "If true, some requests timed out during the update by query.",
+ "type": "boolean"
+ },
+ "took": {
+ "description": "The number of milliseconds from start to end of the whole operation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitMillis"
+ }
+ ]
+ },
+ "total": {
+ "description": "The number of documents that were successfully processed.",
+ "type": "number"
+ },
+ "updated": {
+ "description": "The number of documents that were successfully updated.",
+ "type": "number"
+ },
+ "version_conflicts": {
+ "description": "The number of version conflicts that the update by query hit.",
+ "type": "number"
+ },
+ "throttled": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "throttled_millis": {
+ "description": "The number of milliseconds the request slept to conform to `requests_per_second`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitMillis"
+ }
+ ]
+ },
+ "throttled_until": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "throttled_until_millis": {
+ "description": "This field should always be equal to zero in an _update_by_query response.\nIt only has meaning when using the task API, where it indicates the next time (in milliseconds since epoch) a throttled request will be run again in order to conform to `requests_per_second`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitMillis"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-state": "Generally available",
+ "x-codeSamples": [
+ {
+ "lang": "Console",
+ "source": "POST my-index-000001/_update_by_query?conflicts=proceed\n{\n \"query\": { \n \"term\": {\n \"user.id\": \"kimchy\"\n }\n }\n}"
+ },
+ {
+ "lang": "Python",
+ "source": "resp = client.update_by_query(\n index=\"my-index-000001\",\n conflicts=\"proceed\",\n query={\n \"term\": {\n \"user.id\": \"kimchy\"\n }\n },\n)"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "const response = await client.updateByQuery({\n index: \"my-index-000001\",\n conflicts: \"proceed\",\n query: {\n term: {\n \"user.id\": \"kimchy\",\n },\n },\n});"
+ },
+ {
+ "lang": "Ruby",
+ "source": "response = client.update_by_query(\n index: \"my-index-000001\",\n conflicts: \"proceed\",\n body: {\n \"query\": {\n \"term\": {\n \"user.id\": \"kimchy\"\n }\n }\n }\n)"
+ },
+ {
+ "lang": "PHP",
+ "source": "$resp = $client->updateByQuery([\n \"index\" => \"my-index-000001\",\n \"conflicts\" => \"proceed\",\n \"body\" => [\n \"query\" => [\n \"term\" => [\n \"user.id\" => \"kimchy\",\n ],\n ],\n ],\n]);"
+ },
+ {
+ "lang": "curl",
+ "source": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"query\":{\"term\":{\"user.id\":\"kimchy\"}}}' \"$ELASTICSEARCH_URL/my-index-000001/_update_by_query?conflicts=proceed\""
+ },
+ {
+ "lang": "Java",
+ "source": "client.updateByQuery(u -> u\n .conflicts(Conflicts.Proceed)\n .index(\"my-index-000001\")\n .query(q -> q\n .term(t -> t\n .field(\"user.id\")\n .value(FieldValue.of(\"kimchy\"))\n )\n )\n);\n"
+ }
+ ],
+ "x-metaTags": [
+ {
+ "content": "Elasticsearch",
+ "name": "product_name"
+ }
+ ]
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "_types.Id": {
+ "type": "string"
+ },
+ "_types.AcknowledgedResponseBase": {
+ "type": "object",
+ "properties": {
+ "acknowledged": {
+ "description": "For a successful response, this value is always true. On failure, an exception is returned instead.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "acknowledged"
+ ]
+ },
+ "_types.Duration": {
+ "description": "A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and\n`d` (days). Also accepts \"0\" without a unit and \"-1\" to indicate an unspecified value.",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "string",
+ "enum": [
+ "-1"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "0"
+ ]
+ }
+ ]
+ },
+ "async_search._types.AsyncSearchDocumentResponseBase": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/async_search._types.AsyncSearchResponseBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "response": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/async_search._types.AsyncSearch"
+ }
+ ]
+ }
+ },
+ "required": [
+ "response"
+ ]
+ }
+ ]
+ },
+ "async_search._types.AsyncSearch": {
+ "type": "object",
+ "properties": {
+ "aggregations": {
+ "description": "Partial aggregations results, coming from the shards that have already completed running the query.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.Aggregate"
+ }
+ },
+ "_clusters": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ClusterStatistics"
+ }
+ ]
+ },
+ "fields": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "hits": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.HitsMetadata"
+ }
+ ]
+ },
+ "max_score": {
+ "type": "number"
+ },
+ "num_reduce_phases": {
+ "description": "Indicates how many reductions of the results have been performed.\nIf this number increases compared to the last retrieved results for a get asynch search request, you can expect additional results included in the search response.",
+ "type": "number"
+ },
+ "profile": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.Profile"
+ }
+ ]
+ },
+ "pit_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "_scroll_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScrollId"
+ }
+ ]
+ },
+ "_shards": {
+ "description": "Indicates how many shards have run the query.\nNote that in order for shard results to be included in the search response, they need to be reduced first.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ShardStatistics"
+ }
+ ]
+ },
+ "suggest": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.Suggest"
+ }
+ }
+ },
+ "terminated_early": {
+ "type": "boolean"
+ },
+ "timed_out": {
+ "type": "boolean"
+ },
+ "took": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "hits",
+ "_shards",
+ "timed_out",
+ "took"
+ ]
+ },
+ "_types.aggregations.Aggregate": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/explore-analyze/query-filter/aggregations"
+ },
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CardinalityAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.HdrPercentilesAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.HdrPercentileRanksAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TDigestPercentilesAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TDigestPercentileRanksAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PercentilesBucketAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MedianAbsoluteDeviationAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MinAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MaxAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SumAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AvgAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.WeightedAvgAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ValueCountAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SimpleValueAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.DerivativeAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketMetricValueAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.StatsAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.StatsBucketAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ExtendedStatsAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ExtendedStatsBucketAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.GeoBoundsAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.GeoCentroidAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.HistogramAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.DateHistogramAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AutoDateHistogramAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.VariableWidthHistogramAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.StringTermsAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.LongTermsAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.DoubleTermsAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.UnmappedTermsAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.LongRareTermsAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.StringRareTermsAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.UnmappedRareTermsAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiTermsAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MissingAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.NestedAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ReverseNestedAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.GlobalAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.FilterAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ChildrenAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ParentAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SamplerAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.UnmappedSamplerAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.GeoHashGridAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.GeoTileGridAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.GeoHexGridAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.RangeAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.DateRangeAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.GeoDistanceAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.IpRangeAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.IpPrefixAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.FiltersAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AdjacencyMatrixAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SignificantLongTermsAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SignificantStringTermsAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.UnmappedSignificantTermsAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CompositeAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.FrequentItemSetsAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TimeSeriesAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ScriptedMetricAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TopHitsAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.InferenceAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.StringStatsAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BoxPlotAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TopMetricsAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TTestAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.RateAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CumulativeCardinalityAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MatrixStatsAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.GeoLineAggregate"
+ }
+ ]
+ },
+ "_types.aggregations.CardinalityAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "value"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.AggregateBase": {
+ "type": "object",
+ "properties": {
+ "meta": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ }
+ }
+ },
+ "_types.Metadata": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "_types.aggregations.HdrPercentilesAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PercentilesAggregateBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.PercentilesAggregateBase": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "values": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.Percentiles"
+ }
+ ]
+ }
+ },
+ "required": [
+ "values"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.Percentiles": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.KeyedPercentiles"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.ArrayPercentilesItem"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.KeyedPercentiles": {
+ "type": "object",
+ "additionalProperties": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ }
+ },
+ "_types.aggregations.ArrayPercentilesItem": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "number"
+ },
+ "value": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "value_as_string": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "key",
+ "value"
+ ]
+ },
+ "_types.aggregations.HdrPercentileRanksAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PercentilesAggregateBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.TDigestPercentilesAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PercentilesAggregateBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.TDigestPercentileRanksAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PercentilesAggregateBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.PercentilesBucketAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PercentilesAggregateBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.MedianAbsoluteDeviationAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.SingleMetricAggregateBase": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The metric value. A missing value generally means that there was no data to aggregate,\nunless specified otherwise.",
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "value_as_string": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "value"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.MinAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.MaxAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.SumAggregate": {
+ "description": "Sum aggregation result. `value` is always present and is zero if there were no values to process.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.AvgAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.WeightedAvgAggregate": {
+ "description": "Weighted average aggregation result. `value` is missing if the weight was set to zero.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.ValueCountAggregate": {
+ "description": "Value count aggregation result. `value` is always present.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.SimpleValueAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.DerivativeAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "normalized_value": {
+ "type": "number"
+ },
+ "normalized_value_as_string": {
+ "type": "string"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.BucketMetricValueAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "keys": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "keys"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.StatsAggregate": {
+ "description": "Statistics aggregation result. `min`, `max` and `avg` are missing if there were no values to process\n(`count` is zero).",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number"
+ },
+ "min": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "max": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "avg": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "sum": {
+ "type": "number"
+ },
+ "min_as_string": {
+ "type": "string"
+ },
+ "max_as_string": {
+ "type": "string"
+ },
+ "avg_as_string": {
+ "type": "string"
+ },
+ "sum_as_string": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "count",
+ "min",
+ "max",
+ "avg",
+ "sum"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.StatsBucketAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.StatsAggregate"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.ExtendedStatsAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.StatsAggregate"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "sum_of_squares": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "variance": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "variance_population": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "variance_sampling": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "std_deviation": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "std_deviation_population": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "std_deviation_sampling": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "std_deviation_bounds": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.StandardDeviationBounds"
+ }
+ ]
+ },
+ "sum_of_squares_as_string": {
+ "type": "string"
+ },
+ "variance_as_string": {
+ "type": "string"
+ },
+ "variance_population_as_string": {
+ "type": "string"
+ },
+ "variance_sampling_as_string": {
+ "type": "string"
+ },
+ "std_deviation_as_string": {
+ "type": "string"
+ },
+ "std_deviation_bounds_as_string": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.StandardDeviationBoundsAsString"
+ }
+ ]
+ }
+ },
+ "required": [
+ "sum_of_squares",
+ "variance",
+ "variance_population",
+ "variance_sampling",
+ "std_deviation",
+ "std_deviation_population",
+ "std_deviation_sampling"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.StandardDeviationBounds": {
+ "type": "object",
+ "properties": {
+ "upper": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "lower": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "upper_population": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "lower_population": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "upper_sampling": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "lower_sampling": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ }
+ },
+ "required": [
+ "upper",
+ "lower",
+ "upper_population",
+ "lower_population",
+ "upper_sampling",
+ "lower_sampling"
+ ]
+ },
+ "_types.aggregations.StandardDeviationBoundsAsString": {
+ "type": "object",
+ "properties": {
+ "upper": {
+ "type": "string"
+ },
+ "lower": {
+ "type": "string"
+ },
+ "upper_population": {
+ "type": "string"
+ },
+ "lower_population": {
+ "type": "string"
+ },
+ "upper_sampling": {
+ "type": "string"
+ },
+ "lower_sampling": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "upper",
+ "lower",
+ "upper_population",
+ "lower_population",
+ "upper_sampling",
+ "lower_sampling"
+ ]
+ },
+ "_types.aggregations.ExtendedStatsBucketAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ExtendedStatsAggregate"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.GeoBoundsAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "bounds": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoBounds"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.GeoBounds": {
+ "description": "A geo bounding box. It can be represented in various ways:\n- as 4 top/bottom/left/right coordinates\n- as 2 top_left / bottom_right points\n- as 2 top_right / bottom_left points\n- as a WKT bounding box",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.CoordsGeoBounds"
+ },
+ {
+ "$ref": "#/components/schemas/_types.TopLeftBottomRightGeoBounds"
+ },
+ {
+ "$ref": "#/components/schemas/_types.TopRightBottomLeftGeoBounds"
+ },
+ {
+ "$ref": "#/components/schemas/_types.WktGeoBounds"
+ }
+ ]
+ },
+ "_types.CoordsGeoBounds": {
+ "type": "object",
+ "properties": {
+ "top": {
+ "type": "number"
+ },
+ "bottom": {
+ "type": "number"
+ },
+ "left": {
+ "type": "number"
+ },
+ "right": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "top",
+ "bottom",
+ "left",
+ "right"
+ ]
+ },
+ "_types.TopLeftBottomRightGeoBounds": {
+ "type": "object",
+ "properties": {
+ "top_left": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoLocation"
+ }
+ ]
+ },
+ "bottom_right": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoLocation"
+ }
+ ]
+ }
+ },
+ "required": [
+ "top_left",
+ "bottom_right"
+ ]
+ },
+ "_types.GeoLocation": {
+ "description": "A latitude/longitude as a 2 dimensional point. It can be represented in various ways:\n- as a `{lat, long}` object\n- as a geo hash value\n- as a `[lon, lat]` array\n- as a string in `\", \"` or WKT point formats",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.LatLonGeoLocation"
+ },
+ {
+ "$ref": "#/components/schemas/_types.GeoHashLocation"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "_types.LatLonGeoLocation": {
+ "type": "object",
+ "properties": {
+ "lat": {
+ "description": "Latitude",
+ "type": "number"
+ },
+ "lon": {
+ "description": "Longitude",
+ "type": "number"
+ }
+ },
+ "required": [
+ "lat",
+ "lon"
+ ]
+ },
+ "_types.GeoHashLocation": {
+ "type": "object",
+ "properties": {
+ "geohash": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoHash"
+ }
+ ]
+ }
+ },
+ "required": [
+ "geohash"
+ ]
+ },
+ "_types.GeoHash": {
+ "type": "string"
+ },
+ "_types.TopRightBottomLeftGeoBounds": {
+ "type": "object",
+ "properties": {
+ "top_right": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoLocation"
+ }
+ ]
+ },
+ "bottom_left": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoLocation"
+ }
+ ]
+ }
+ },
+ "required": [
+ "top_right",
+ "bottom_left"
+ ]
+ },
+ "_types.WktGeoBounds": {
+ "type": "object",
+ "properties": {
+ "wkt": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "wkt"
+ ]
+ },
+ "_types.aggregations.GeoCentroidAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number"
+ },
+ "location": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoLocation"
+ }
+ ]
+ }
+ },
+ "required": [
+ "count"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.HistogramAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseHistogramBucket"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.MultiBucketAggregateBaseHistogramBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsHistogramBucket"
+ }
+ ]
+ }
+ },
+ "required": [
+ "buckets"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketsHistogramBucket": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.HistogramBucket"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.HistogramBucket"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.HistogramBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "key_as_string": {
+ "type": "string"
+ },
+ "key": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "key"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.MultiBucketBase": {
+ "description": "Base type for multi-bucket aggregation results that can hold sub-aggregations results.",
+ "type": "object",
+ "properties": {
+ "doc_count": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "doc_count"
+ ]
+ },
+ "_types.aggregations.DateHistogramAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseDateHistogramBucket"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.MultiBucketAggregateBaseDateHistogramBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsDateHistogramBucket"
+ }
+ ]
+ }
+ },
+ "required": [
+ "buckets"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketsDateHistogramBucket": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.DateHistogramBucket"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.DateHistogramBucket"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.DateHistogramBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "key_as_string": {
+ "type": "string"
+ },
+ "key": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ }
+ },
+ "required": [
+ "key"
+ ]
+ }
+ ]
+ },
+ "_types.EpochTimeUnitMillis": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.UnitMillis"
+ }
+ ]
+ },
+ "_types.UnitMillis": {
+ "description": "Time unit for milliseconds",
+ "type": "number"
+ },
+ "_types.aggregations.AutoDateHistogramAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseDateHistogramBucket"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "interval": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationLarge"
+ }
+ ]
+ }
+ },
+ "required": [
+ "interval"
+ ]
+ }
+ ]
+ },
+ "_types.DurationLarge": {
+ "description": "A date histogram interval. Similar to `Duration` with additional units: `w` (week), `M` (month), `q` (quarter) and\n`y` (year)",
+ "type": "string"
+ },
+ "_types.aggregations.VariableWidthHistogramAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseVariableWidthHistogramBucket"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.MultiBucketAggregateBaseVariableWidthHistogramBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsVariableWidthHistogramBucket"
+ }
+ ]
+ }
+ },
+ "required": [
+ "buckets"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketsVariableWidthHistogramBucket": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.VariableWidthHistogramBucket"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.VariableWidthHistogramBucket"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.VariableWidthHistogramBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "min": {
+ "type": "number"
+ },
+ "key": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min_as_string": {
+ "type": "string"
+ },
+ "key_as_string": {
+ "type": "string"
+ },
+ "max_as_string": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "min",
+ "key",
+ "max"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.StringTermsAggregate": {
+ "description": "Result of a `terms` aggregation when the field is a string.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsAggregateBaseStringTermsBucket"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.TermsAggregateBaseStringTermsBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseStringTermsBucket"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "doc_count_error_upper_bound": {
+ "type": "number"
+ },
+ "sum_other_doc_count": {
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.MultiBucketAggregateBaseStringTermsBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsStringTermsBucket"
+ }
+ ]
+ }
+ },
+ "required": [
+ "buckets"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketsStringTermsBucket": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.StringTermsBucket"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.StringTermsBucket"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.StringTermsBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsBucketBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "key": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.FieldValue"
+ }
+ ]
+ }
+ },
+ "required": [
+ "key"
+ ]
+ }
+ ]
+ },
+ "_types.FieldValue": {
+ "description": "A field value.",
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "string"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "_types.aggregations.TermsBucketBase": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "doc_count_error_upper_bound": {
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.LongTermsAggregate": {
+ "description": "Result of a `terms` aggregation when the field is some kind of whole number like a integer, long, or a date.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsAggregateBaseLongTermsBucket"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.TermsAggregateBaseLongTermsBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseLongTermsBucket"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "doc_count_error_upper_bound": {
+ "type": "number"
+ },
+ "sum_other_doc_count": {
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.MultiBucketAggregateBaseLongTermsBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsLongTermsBucket"
+ }
+ ]
+ }
+ },
+ "required": [
+ "buckets"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketsLongTermsBucket": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.LongTermsBucket"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.LongTermsBucket"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.LongTermsBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsBucketBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "number"
+ },
+ "key_as_string": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "key"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.DoubleTermsAggregate": {
+ "description": "Result of a `terms` aggregation when the field is some kind of decimal number like a float, double, or distance.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsAggregateBaseDoubleTermsBucket"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.TermsAggregateBaseDoubleTermsBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseDoubleTermsBucket"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "doc_count_error_upper_bound": {
+ "type": "number"
+ },
+ "sum_other_doc_count": {
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.MultiBucketAggregateBaseDoubleTermsBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsDoubleTermsBucket"
+ }
+ ]
+ }
+ },
+ "required": [
+ "buckets"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketsDoubleTermsBucket": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.DoubleTermsBucket"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.DoubleTermsBucket"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.DoubleTermsBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsBucketBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "number"
+ },
+ "key_as_string": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "key"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.UnmappedTermsAggregate": {
+ "description": "Result of a `terms` aggregation when the field is unmapped. `buckets` is always empty.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsAggregateBaseVoid"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.TermsAggregateBaseVoid": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseVoid"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "doc_count_error_upper_bound": {
+ "type": "number"
+ },
+ "sum_other_doc_count": {
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.MultiBucketAggregateBaseVoid": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsVoid"
+ }
+ ]
+ }
+ },
+ "required": [
+ "buckets"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketsVoid": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_spec_utils.Void"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_spec_utils.Void"
+ }
+ }
+ ]
+ },
+ "_spec_utils.Void": {
+ "description": "The absence of any type. This is commonly used in APIs that don't return a body.\n\nAlthough \"void\" is generally used for the unit type that has only one value, this is to be interpreted as\nthe bottom type that has no value at all. Most languages have a unit type, but few have a bottom type.\n\nSee https://en.m.wikipedia.org/wiki/Unit_type and https://en.m.wikipedia.org/wiki/Bottom_type",
+ "type": "object"
+ },
+ "_types.aggregations.LongRareTermsAggregate": {
+ "description": "Result of the `rare_terms` aggregation when the field is some kind of whole number like a integer, long, or a date.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseLongRareTermsBucket"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.MultiBucketAggregateBaseLongRareTermsBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsLongRareTermsBucket"
+ }
+ ]
+ }
+ },
+ "required": [
+ "buckets"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketsLongRareTermsBucket": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.LongRareTermsBucket"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.LongRareTermsBucket"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.LongRareTermsBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "number"
+ },
+ "key_as_string": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "key"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.StringRareTermsAggregate": {
+ "description": "Result of the `rare_terms` aggregation when the field is a string.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseStringRareTermsBucket"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.MultiBucketAggregateBaseStringRareTermsBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsStringRareTermsBucket"
+ }
+ ]
+ }
+ },
+ "required": [
+ "buckets"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketsStringRareTermsBucket": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.StringRareTermsBucket"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.StringRareTermsBucket"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.StringRareTermsBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "key"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.UnmappedRareTermsAggregate": {
+ "description": "Result of a `rare_terms` aggregation when the field is unmapped. `buckets` is always empty.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseVoid"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.MultiTermsAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsAggregateBaseMultiTermsBucket"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.TermsAggregateBaseMultiTermsBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseMultiTermsBucket"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "doc_count_error_upper_bound": {
+ "type": "number"
+ },
+ "sum_other_doc_count": {
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.MultiBucketAggregateBaseMultiTermsBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsMultiTermsBucket"
+ }
+ ]
+ }
+ },
+ "required": [
+ "buckets"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketsMultiTermsBucket": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.MultiTermsBucket"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.MultiTermsBucket"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.MultiTermsBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.FieldValue"
+ }
+ },
+ "key_as_string": {
+ "type": "string"
+ },
+ "doc_count_error_upper_bound": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "key"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.MissingAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SingleBucketAggregateBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.SingleBucketAggregateBase": {
+ "description": "Base type for single-bucket aggregation results that can hold sub-aggregations results.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "doc_count": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "doc_count"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.NestedAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SingleBucketAggregateBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.ReverseNestedAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SingleBucketAggregateBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.GlobalAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SingleBucketAggregateBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.FilterAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SingleBucketAggregateBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.ChildrenAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SingleBucketAggregateBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.ParentAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SingleBucketAggregateBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.SamplerAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SingleBucketAggregateBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.UnmappedSamplerAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SingleBucketAggregateBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.GeoHashGridAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseGeoHashGridBucket"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.MultiBucketAggregateBaseGeoHashGridBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsGeoHashGridBucket"
+ }
+ ]
+ }
+ },
+ "required": [
+ "buckets"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketsGeoHashGridBucket": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.GeoHashGridBucket"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.GeoHashGridBucket"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.GeoHashGridBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "key": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoHash"
+ }
+ ]
+ }
+ },
+ "required": [
+ "key"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.GeoTileGridAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseGeoTileGridBucket"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.MultiBucketAggregateBaseGeoTileGridBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsGeoTileGridBucket"
+ }
+ ]
+ }
+ },
+ "required": [
+ "buckets"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketsGeoTileGridBucket": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.GeoTileGridBucket"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.GeoTileGridBucket"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.GeoTileGridBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "key": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoTile"
+ }
+ ]
+ }
+ },
+ "required": [
+ "key"
+ ]
+ }
+ ]
+ },
+ "_types.GeoTile": {
+ "description": "A map tile reference, represented as `{zoom}/{x}/{y}`",
+ "type": "string"
+ },
+ "_types.aggregations.GeoHexGridAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseGeoHexGridBucket"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.MultiBucketAggregateBaseGeoHexGridBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsGeoHexGridBucket"
+ }
+ ]
+ }
+ },
+ "required": [
+ "buckets"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketsGeoHexGridBucket": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.GeoHexGridBucket"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.GeoHexGridBucket"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.GeoHexGridBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "key": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoHexCell"
+ }
+ ]
+ }
+ },
+ "required": [
+ "key"
+ ]
+ }
+ ]
+ },
+ "_types.GeoHexCell": {
+ "description": "A map hex cell (H3) reference",
+ "type": "string"
+ },
+ "_types.aggregations.RangeAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseRangeBucket"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.MultiBucketAggregateBaseRangeBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsRangeBucket"
+ }
+ ]
+ }
+ },
+ "required": [
+ "buckets"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketsRangeBucket": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.RangeBucket"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.RangeBucket"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.RangeBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "number"
+ },
+ "to": {
+ "type": "number"
+ },
+ "from_as_string": {
+ "type": "string"
+ },
+ "to_as_string": {
+ "type": "string"
+ },
+ "key": {
+ "description": "The bucket key. Present if the aggregation is _not_ keyed",
+ "type": "string"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.DateRangeAggregate": {
+ "description": "Result of a `date_range` aggregation. Same format as a for a `range` aggregation: `from` and `to`\nin `buckets` are milliseconds since the Epoch, represented as a floating point number.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.RangeAggregate"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.GeoDistanceAggregate": {
+ "description": "Result of a `geo_distance` aggregation. The unit for `from` and `to` is meters by default.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.RangeAggregate"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.IpRangeAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseIpRangeBucket"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.MultiBucketAggregateBaseIpRangeBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsIpRangeBucket"
+ }
+ ]
+ }
+ },
+ "required": [
+ "buckets"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketsIpRangeBucket": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.IpRangeBucket"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.IpRangeBucket"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.IpRangeBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "from": {
+ "type": "string"
+ },
+ "to": {
+ "type": "string"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.IpPrefixAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseIpPrefixBucket"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.MultiBucketAggregateBaseIpPrefixBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsIpPrefixBucket"
+ }
+ ]
+ }
+ },
+ "required": [
+ "buckets"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketsIpPrefixBucket": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.IpPrefixBucket"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.IpPrefixBucket"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.IpPrefixBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "is_ipv6": {
+ "type": "boolean"
+ },
+ "key": {
+ "type": "string"
+ },
+ "prefix_length": {
+ "type": "number"
+ },
+ "netmask": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "is_ipv6",
+ "key",
+ "prefix_length"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.FiltersAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseFiltersBucket"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.MultiBucketAggregateBaseFiltersBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsFiltersBucket"
+ }
+ ]
+ }
+ },
+ "required": [
+ "buckets"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketsFiltersBucket": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.FiltersBucket"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.FiltersBucket"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.FiltersBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.AdjacencyMatrixAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseAdjacencyMatrixBucket"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.MultiBucketAggregateBaseAdjacencyMatrixBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsAdjacencyMatrixBucket"
+ }
+ ]
+ }
+ },
+ "required": [
+ "buckets"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketsAdjacencyMatrixBucket": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.AdjacencyMatrixBucket"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.AdjacencyMatrixBucket"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.AdjacencyMatrixBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "key"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.SignificantLongTermsAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SignificantTermsAggregateBaseSignificantLongTermsBucket"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.SignificantTermsAggregateBaseSignificantLongTermsBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseSignificantLongTermsBucket"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "bg_count": {
+ "type": "number"
+ },
+ "doc_count": {
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.MultiBucketAggregateBaseSignificantLongTermsBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsSignificantLongTermsBucket"
+ }
+ ]
+ }
+ },
+ "required": [
+ "buckets"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketsSignificantLongTermsBucket": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.SignificantLongTermsBucket"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.SignificantLongTermsBucket"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.SignificantLongTermsBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SignificantTermsBucketBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "number"
+ },
+ "key_as_string": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "key"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.SignificantTermsBucketBase": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "score": {
+ "type": "number"
+ },
+ "bg_count": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "score",
+ "bg_count"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.SignificantStringTermsAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SignificantTermsAggregateBaseSignificantStringTermsBucket"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.SignificantTermsAggregateBaseSignificantStringTermsBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseSignificantStringTermsBucket"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "bg_count": {
+ "type": "number"
+ },
+ "doc_count": {
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.MultiBucketAggregateBaseSignificantStringTermsBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsSignificantStringTermsBucket"
+ }
+ ]
+ }
+ },
+ "required": [
+ "buckets"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketsSignificantStringTermsBucket": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.SignificantStringTermsBucket"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.SignificantStringTermsBucket"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.SignificantStringTermsBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SignificantTermsBucketBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "key"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.UnmappedSignificantTermsAggregate": {
+ "description": "Result of the `significant_terms` aggregation on an unmapped field. `buckets` is always empty.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SignificantTermsAggregateBaseVoid"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.SignificantTermsAggregateBaseVoid": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseVoid"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "bg_count": {
+ "type": "number"
+ },
+ "doc_count": {
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.CompositeAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseCompositeBucket"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "after_key": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CompositeAggregateKey"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.CompositeAggregateKey": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.FieldValue"
+ }
+ },
+ "_types.aggregations.MultiBucketAggregateBaseCompositeBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsCompositeBucket"
+ }
+ ]
+ }
+ },
+ "required": [
+ "buckets"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketsCompositeBucket": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.CompositeBucket"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.CompositeBucket"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.CompositeBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "key": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CompositeAggregateKey"
+ }
+ ]
+ }
+ },
+ "required": [
+ "key"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.FrequentItemSetsAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseFrequentItemSetsBucket"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.MultiBucketAggregateBaseFrequentItemSetsBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsFrequentItemSetsBucket"
+ }
+ ]
+ }
+ },
+ "required": [
+ "buckets"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketsFrequentItemSetsBucket": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.FrequentItemSetsBucket"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.FrequentItemSetsBucket"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.FrequentItemSetsBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "support": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "key",
+ "support"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.TimeSeriesAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseTimeSeriesBucket"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.MultiBucketAggregateBaseTimeSeriesBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsTimeSeriesBucket"
+ }
+ ]
+ }
+ },
+ "required": [
+ "buckets"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketsTimeSeriesBucket": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.TimeSeriesBucket"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.TimeSeriesBucket"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.TimeSeriesBucket": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiBucketBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.FieldValue"
+ }
+ }
+ },
+ "required": [
+ "key"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.ScriptedMetricAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "value"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.TopHitsAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "hits": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.HitsMetadata"
+ }
+ ]
+ }
+ },
+ "required": [
+ "hits"
+ ]
+ }
+ ]
+ },
+ "_global.search._types.HitsMetadata": {
+ "type": "object",
+ "properties": {
+ "total": {
+ "description": "Total hit count information, present only if `track_total_hits` wasn't `false` in the search request.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.TotalHits"
+ },
+ {
+ "type": "number"
+ }
+ ]
+ },
+ "hits": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.Hit"
+ }
+ },
+ "max_score": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ }
+ },
+ "required": [
+ "hits"
+ ]
+ },
+ "_global.search._types.TotalHits": {
+ "type": "object",
+ "properties": {
+ "relation": {
+ "description": "\n\nSupported values include:\n - `eq`: Accurate\n - `gte`: Lower bound, including returned events or sequences\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.TotalHitsRelation"
+ }
+ ]
+ },
+ "value": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "relation",
+ "value"
+ ]
+ },
+ "_global.search._types.TotalHitsRelation": {
+ "type": "string",
+ "enum": [
+ "eq",
+ "gte"
+ ]
+ },
+ "_global.search._types.Hit": {
+ "type": "object",
+ "properties": {
+ "_index": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "_score": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "_explanation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.explain.Explanation"
+ }
+ ]
+ },
+ "fields": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "highlight": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "inner_hits": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_global.search._types.InnerHitsResult"
+ }
+ },
+ "matched_queries": {
+ "oneOf": [
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ {
+ "type": "object",
+ "additionalProperties": {
+ "type": "number"
+ }
+ }
+ ]
+ },
+ "_nested": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.NestedIdentity"
+ }
+ ]
+ },
+ "_ignored": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "ignored_field_values": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ }
+ },
+ "_shard": {
+ "type": "string"
+ },
+ "_node": {
+ "type": "string"
+ },
+ "_routing": {
+ "type": "string"
+ },
+ "_source": {
+ "type": "object"
+ },
+ "_rank": {
+ "type": "number"
+ },
+ "_seq_no": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SequenceNumber"
+ }
+ ]
+ },
+ "_primary_term": {
+ "type": "number"
+ },
+ "_version": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ }
+ ]
+ },
+ "sort": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SortResults"
+ }
+ ]
+ }
+ },
+ "required": [
+ "_index"
+ ]
+ },
+ "_types.IndexName": {
+ "type": "string"
+ },
+ "_global.explain.Explanation": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.explain.ExplanationDetail"
+ }
+ },
+ "value": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "description",
+ "details",
+ "value"
+ ]
+ },
+ "_global.explain.ExplanationDetail": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.explain.ExplanationDetail"
+ }
+ },
+ "value": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "description",
+ "value"
+ ]
+ },
+ "_global.search._types.InnerHitsResult": {
+ "type": "object",
+ "properties": {
+ "hits": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.HitsMetadata"
+ }
+ ]
+ }
+ },
+ "required": [
+ "hits"
+ ]
+ },
+ "_global.search._types.NestedIdentity": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "offset": {
+ "type": "number"
+ },
+ "_nested": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.NestedIdentity"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field",
+ "offset"
+ ]
+ },
+ "_types.Field": {
+ "description": "Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.",
+ "type": "string"
+ },
+ "_types.SequenceNumber": {
+ "type": "number"
+ },
+ "_types.VersionNumber": {
+ "type": "number"
+ },
+ "_types.SortResults": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.FieldValue"
+ }
+ },
+ "_types.aggregations.InferenceAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.FieldValue"
+ }
+ ]
+ },
+ "feature_importance": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.InferenceFeatureImportance"
+ }
+ },
+ "top_classes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.InferenceTopClassEntry"
+ }
+ },
+ "warning": {
+ "type": "string"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.InferenceFeatureImportance": {
+ "type": "object",
+ "properties": {
+ "feature_name": {
+ "type": "string"
+ },
+ "importance": {
+ "type": "number"
+ },
+ "classes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.InferenceClassImportance"
+ }
+ }
+ },
+ "required": [
+ "feature_name"
+ ]
+ },
+ "_types.aggregations.InferenceClassImportance": {
+ "type": "object",
+ "properties": {
+ "class_name": {
+ "type": "string"
+ },
+ "importance": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "class_name",
+ "importance"
+ ]
+ },
+ "_types.aggregations.InferenceTopClassEntry": {
+ "type": "object",
+ "properties": {
+ "class_name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.FieldValue"
+ }
+ ]
+ },
+ "class_probability": {
+ "type": "number"
+ },
+ "class_score": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "class_name",
+ "class_probability",
+ "class_score"
+ ]
+ },
+ "_types.aggregations.StringStatsAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number"
+ },
+ "min_length": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "max_length": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "avg_length": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "entropy": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "distribution": {
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "type": "number"
+ }
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "min_length_as_string": {
+ "type": "string"
+ },
+ "max_length_as_string": {
+ "type": "string"
+ },
+ "avg_length_as_string": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "count",
+ "min_length",
+ "max_length",
+ "avg_length",
+ "entropy"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BoxPlotAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "min": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "q1": {
+ "type": "number"
+ },
+ "q2": {
+ "type": "number"
+ },
+ "q3": {
+ "type": "number"
+ },
+ "lower": {
+ "type": "number"
+ },
+ "upper": {
+ "type": "number"
+ },
+ "min_as_string": {
+ "type": "string"
+ },
+ "max_as_string": {
+ "type": "string"
+ },
+ "q1_as_string": {
+ "type": "string"
+ },
+ "q2_as_string": {
+ "type": "string"
+ },
+ "q3_as_string": {
+ "type": "string"
+ },
+ "lower_as_string": {
+ "type": "string"
+ },
+ "upper_as_string": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "min",
+ "max",
+ "q1",
+ "q2",
+ "q3",
+ "lower",
+ "upper"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.TopMetricsAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "top": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.TopMetrics"
+ }
+ }
+ },
+ "required": [
+ "top"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.TopMetrics": {
+ "type": "object",
+ "properties": {
+ "sort": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.FieldValue"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ }
+ },
+ "metrics": {
+ "type": "object",
+ "additionalProperties": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.FieldValue"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "required": [
+ "sort",
+ "metrics"
+ ]
+ },
+ "_types.aggregations.TTestAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "value_as_string": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "value"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.RateAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "number"
+ },
+ "value_as_string": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "value"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.CumulativeCardinalityAggregate": {
+ "description": "Result of the `cumulative_cardinality` aggregation",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "number"
+ },
+ "value_as_string": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "value"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.MatrixStatsAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "doc_count": {
+ "type": "number"
+ },
+ "fields": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.MatrixStatsFields"
+ }
+ }
+ },
+ "required": [
+ "doc_count"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.MatrixStatsFields": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "count": {
+ "type": "number"
+ },
+ "mean": {
+ "type": "number"
+ },
+ "variance": {
+ "type": "number"
+ },
+ "skewness": {
+ "type": "number"
+ },
+ "kurtosis": {
+ "type": "number"
+ },
+ "covariance": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "number"
+ }
+ },
+ "correlation": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "number"
+ }
+ }
+ },
+ "required": [
+ "name",
+ "count",
+ "mean",
+ "variance",
+ "skewness",
+ "kurtosis",
+ "covariance",
+ "correlation"
+ ]
+ },
+ "_types.aggregations.GeoLineAggregate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "geometry": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoLine"
+ }
+ ]
+ },
+ "properties": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "type",
+ "geometry",
+ "properties"
+ ]
+ }
+ ]
+ },
+ "_types.GeoLine": {
+ "description": "A GeoJson GeoLine.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Always `\"LineString\"`",
+ "type": "string"
+ },
+ "coordinates": {
+ "description": "Array of `[lon, lat]` coordinates",
+ "type": "array",
+ "items": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ },
+ "required": [
+ "type",
+ "coordinates"
+ ]
+ },
+ "_types.ClusterStatistics": {
+ "type": "object",
+ "properties": {
+ "skipped": {
+ "type": "number"
+ },
+ "successful": {
+ "type": "number"
+ },
+ "total": {
+ "type": "number"
+ },
+ "running": {
+ "type": "number"
+ },
+ "partial": {
+ "type": "number"
+ },
+ "failed": {
+ "type": "number"
+ },
+ "details": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.ClusterDetails"
+ }
+ }
+ },
+ "required": [
+ "skipped",
+ "successful",
+ "total",
+ "running",
+ "partial",
+ "failed"
+ ]
+ },
+ "_types.ClusterDetails": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ClusterSearchStatus"
+ }
+ ]
+ },
+ "indices": {
+ "type": "string"
+ },
+ "took": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitMillis"
+ }
+ ]
+ },
+ "timed_out": {
+ "type": "boolean"
+ },
+ "_shards": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ShardStatistics"
+ }
+ ]
+ },
+ "failures": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.ShardFailure"
+ }
+ }
+ },
+ "required": [
+ "status",
+ "indices",
+ "timed_out"
+ ]
+ },
+ "_types.ClusterSearchStatus": {
+ "type": "string",
+ "enum": [
+ "running",
+ "successful",
+ "partial",
+ "skipped",
+ "failed"
+ ]
+ },
+ "_types.DurationValueUnitMillis": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.UnitMillis"
+ }
+ ]
+ },
+ "_types.ShardStatistics": {
+ "type": "object",
+ "properties": {
+ "failed": {
+ "description": "The number of shards the operation or search attempted to run on but failed.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.uint"
+ }
+ ]
+ },
+ "successful": {
+ "description": "The number of shards the operation or search succeeded on.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.uint"
+ }
+ ]
+ },
+ "total": {
+ "description": "The number of shards the operation or search will run on overall.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.uint"
+ }
+ ]
+ },
+ "failures": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.ShardFailure"
+ }
+ },
+ "skipped": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.uint"
+ }
+ ]
+ }
+ },
+ "required": [
+ "failed",
+ "successful",
+ "total"
+ ]
+ },
+ "_types.uint": {
+ "type": "number"
+ },
+ "_types.ShardFailure": {
+ "type": "object",
+ "properties": {
+ "index": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "node": {
+ "type": "string"
+ },
+ "reason": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ErrorCause"
+ }
+ ]
+ },
+ "shard": {
+ "type": "number"
+ },
+ "status": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "reason",
+ "shard"
+ ]
+ },
+ "_types.ErrorCause": {
+ "description": "Cause and details about a request failure. This class defines the properties common to all error types.\nAdditional details are also provided, that depend on the error type.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The type of error",
+ "type": "string"
+ },
+ "reason": {
+ "description": "A human-readable explanation of the error, in English.",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "stack_trace": {
+ "description": "The server stack trace. Present only if the `error_trace=true` parameter was sent with the request.",
+ "type": "string"
+ },
+ "caused_by": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ErrorCause"
+ }
+ ]
+ },
+ "root_cause": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.ErrorCause"
+ }
+ },
+ "suppressed": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.ErrorCause"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_global.search._types.Profile": {
+ "type": "object",
+ "properties": {
+ "shards": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.ShardProfile"
+ }
+ }
+ },
+ "required": [
+ "shards"
+ ]
+ },
+ "_global.search._types.ShardProfile": {
+ "type": "object",
+ "properties": {
+ "aggregations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.AggregationProfile"
+ }
+ },
+ "cluster": {
+ "type": "string"
+ },
+ "dfs": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.DfsProfile"
+ }
+ ]
+ },
+ "fetch": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.FetchProfile"
+ }
+ ]
+ },
+ "id": {
+ "type": "string"
+ },
+ "index": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "node_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.NodeId"
+ }
+ ]
+ },
+ "searches": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.SearchProfile"
+ }
+ },
+ "shard_id": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "aggregations",
+ "cluster",
+ "id",
+ "index",
+ "node_id",
+ "searches",
+ "shard_id"
+ ]
+ },
+ "_global.search._types.AggregationProfile": {
+ "type": "object",
+ "properties": {
+ "breakdown": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.AggregationBreakdown"
+ }
+ ]
+ },
+ "description": {
+ "type": "string"
+ },
+ "time_in_nanos": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitNanos"
+ }
+ ]
+ },
+ "type": {
+ "type": "string"
+ },
+ "debug": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.AggregationProfileDebug"
+ }
+ ]
+ },
+ "children": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.AggregationProfile"
+ }
+ }
+ },
+ "required": [
+ "breakdown",
+ "description",
+ "time_in_nanos",
+ "type"
+ ]
+ },
+ "_global.search._types.AggregationBreakdown": {
+ "type": "object",
+ "properties": {
+ "build_aggregation": {
+ "type": "number"
+ },
+ "build_aggregation_count": {
+ "type": "number"
+ },
+ "build_leaf_collector": {
+ "type": "number"
+ },
+ "build_leaf_collector_count": {
+ "type": "number"
+ },
+ "collect": {
+ "type": "number"
+ },
+ "collect_count": {
+ "type": "number"
+ },
+ "initialize": {
+ "type": "number"
+ },
+ "initialize_count": {
+ "type": "number"
+ },
+ "post_collection": {
+ "type": "number"
+ },
+ "post_collection_count": {
+ "type": "number"
+ },
+ "reduce": {
+ "type": "number"
+ },
+ "reduce_count": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "build_aggregation",
+ "build_aggregation_count",
+ "build_leaf_collector",
+ "build_leaf_collector_count",
+ "collect",
+ "collect_count",
+ "initialize",
+ "initialize_count",
+ "reduce",
+ "reduce_count"
+ ]
+ },
+ "_types.DurationValueUnitNanos": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.UnitNanos"
+ }
+ ]
+ },
+ "_types.UnitNanos": {
+ "description": "Time unit for nanoseconds",
+ "type": "number"
+ },
+ "_global.search._types.AggregationProfileDebug": {
+ "type": "object",
+ "properties": {
+ "segments_with_multi_valued_ords": {
+ "type": "number"
+ },
+ "collection_strategy": {
+ "type": "string"
+ },
+ "segments_with_single_valued_ords": {
+ "type": "number"
+ },
+ "total_buckets": {
+ "type": "number"
+ },
+ "built_buckets": {
+ "type": "number"
+ },
+ "result_strategy": {
+ "type": "string"
+ },
+ "has_filter": {
+ "type": "boolean"
+ },
+ "delegate": {
+ "type": "string"
+ },
+ "delegate_debug": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.AggregationProfileDebug"
+ }
+ ]
+ },
+ "chars_fetched": {
+ "type": "number"
+ },
+ "extract_count": {
+ "type": "number"
+ },
+ "extract_ns": {
+ "type": "number"
+ },
+ "values_fetched": {
+ "type": "number"
+ },
+ "collect_analyzed_ns": {
+ "type": "number"
+ },
+ "collect_analyzed_count": {
+ "type": "number"
+ },
+ "surviving_buckets": {
+ "type": "number"
+ },
+ "ordinals_collectors_used": {
+ "type": "number"
+ },
+ "ordinals_collectors_overhead_too_high": {
+ "type": "number"
+ },
+ "string_hashing_collectors_used": {
+ "type": "number"
+ },
+ "numeric_collectors_used": {
+ "type": "number"
+ },
+ "empty_collectors_used": {
+ "type": "number"
+ },
+ "deferred_aggregators": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "segments_with_doc_count_field": {
+ "type": "number"
+ },
+ "segments_with_deleted_docs": {
+ "type": "number"
+ },
+ "filters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.AggregationProfileDelegateDebugFilter"
+ }
+ },
+ "segments_counted": {
+ "type": "number"
+ },
+ "segments_collected": {
+ "type": "number"
+ },
+ "map_reducer": {
+ "type": "string"
+ },
+ "brute_force_used": {
+ "type": "number"
+ },
+ "dynamic_pruning_attempted": {
+ "type": "number"
+ },
+ "dynamic_pruning_used": {
+ "type": "number"
+ },
+ "skipped_due_to_no_data": {
+ "type": "number"
+ }
+ }
+ },
+ "_global.search._types.AggregationProfileDelegateDebugFilter": {
+ "type": "object",
+ "properties": {
+ "results_from_metadata": {
+ "type": "number"
+ },
+ "query": {
+ "type": "string"
+ },
+ "specialized_for": {
+ "type": "string"
+ },
+ "segments_counted_in_constant_time": {
+ "type": "number"
+ }
+ }
+ },
+ "_global.search._types.DfsProfile": {
+ "type": "object",
+ "properties": {
+ "statistics": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.DfsStatisticsProfile"
+ }
+ ]
+ },
+ "knn": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.DfsKnnProfile"
+ }
+ }
+ }
+ },
+ "_global.search._types.DfsStatisticsProfile": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "time": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "time_in_nanos": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitNanos"
+ }
+ ]
+ },
+ "breakdown": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.DfsStatisticsBreakdown"
+ }
+ ]
+ },
+ "debug": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "children": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.DfsStatisticsProfile"
+ }
+ }
+ },
+ "required": [
+ "type",
+ "description",
+ "time_in_nanos",
+ "breakdown"
+ ]
+ },
+ "_global.search._types.DfsStatisticsBreakdown": {
+ "type": "object",
+ "properties": {
+ "collection_statistics": {
+ "type": "number"
+ },
+ "collection_statistics_count": {
+ "type": "number"
+ },
+ "create_weight": {
+ "type": "number"
+ },
+ "create_weight_count": {
+ "type": "number"
+ },
+ "rewrite": {
+ "type": "number"
+ },
+ "rewrite_count": {
+ "type": "number"
+ },
+ "term_statistics": {
+ "type": "number"
+ },
+ "term_statistics_count": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "collection_statistics",
+ "collection_statistics_count",
+ "create_weight",
+ "create_weight_count",
+ "rewrite",
+ "rewrite_count",
+ "term_statistics",
+ "term_statistics_count"
+ ]
+ },
+ "_global.search._types.DfsKnnProfile": {
+ "type": "object",
+ "properties": {
+ "vector_operations_count": {
+ "type": "number"
+ },
+ "query": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.KnnQueryProfileResult"
+ }
+ },
+ "rewrite_time": {
+ "type": "number"
+ },
+ "collector": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.KnnCollectorResult"
+ }
+ }
+ },
+ "required": [
+ "query",
+ "rewrite_time",
+ "collector"
+ ]
+ },
+ "_global.search._types.KnnQueryProfileResult": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "time": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "time_in_nanos": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitNanos"
+ }
+ ]
+ },
+ "breakdown": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.KnnQueryProfileBreakdown"
+ }
+ ]
+ },
+ "debug": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "children": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.KnnQueryProfileResult"
+ }
+ }
+ },
+ "required": [
+ "type",
+ "description",
+ "time_in_nanos",
+ "breakdown"
+ ]
+ },
+ "_global.search._types.KnnQueryProfileBreakdown": {
+ "type": "object",
+ "properties": {
+ "advance": {
+ "type": "number"
+ },
+ "advance_count": {
+ "type": "number"
+ },
+ "build_scorer": {
+ "type": "number"
+ },
+ "build_scorer_count": {
+ "type": "number"
+ },
+ "compute_max_score": {
+ "type": "number"
+ },
+ "compute_max_score_count": {
+ "type": "number"
+ },
+ "count_weight": {
+ "type": "number"
+ },
+ "count_weight_count": {
+ "type": "number"
+ },
+ "create_weight": {
+ "type": "number"
+ },
+ "create_weight_count": {
+ "type": "number"
+ },
+ "match": {
+ "type": "number"
+ },
+ "match_count": {
+ "type": "number"
+ },
+ "next_doc": {
+ "type": "number"
+ },
+ "next_doc_count": {
+ "type": "number"
+ },
+ "score": {
+ "type": "number"
+ },
+ "score_count": {
+ "type": "number"
+ },
+ "set_min_competitive_score": {
+ "type": "number"
+ },
+ "set_min_competitive_score_count": {
+ "type": "number"
+ },
+ "shallow_advance": {
+ "type": "number"
+ },
+ "shallow_advance_count": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "advance",
+ "advance_count",
+ "build_scorer",
+ "build_scorer_count",
+ "compute_max_score",
+ "compute_max_score_count",
+ "count_weight",
+ "count_weight_count",
+ "create_weight",
+ "create_weight_count",
+ "match",
+ "match_count",
+ "next_doc",
+ "next_doc_count",
+ "score",
+ "score_count",
+ "set_min_competitive_score",
+ "set_min_competitive_score_count",
+ "shallow_advance",
+ "shallow_advance_count"
+ ]
+ },
+ "_global.search._types.KnnCollectorResult": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "reason": {
+ "type": "string"
+ },
+ "time": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "time_in_nanos": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitNanos"
+ }
+ ]
+ },
+ "children": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.KnnCollectorResult"
+ }
+ }
+ },
+ "required": [
+ "name",
+ "reason",
+ "time_in_nanos"
+ ]
+ },
+ "_global.search._types.FetchProfile": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "time_in_nanos": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitNanos"
+ }
+ ]
+ },
+ "breakdown": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.FetchProfileBreakdown"
+ }
+ ]
+ },
+ "debug": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.FetchProfileDebug"
+ }
+ ]
+ },
+ "children": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.FetchProfile"
+ }
+ }
+ },
+ "required": [
+ "type",
+ "description",
+ "time_in_nanos",
+ "breakdown"
+ ]
+ },
+ "_global.search._types.FetchProfileBreakdown": {
+ "type": "object",
+ "properties": {
+ "load_source": {
+ "type": "number"
+ },
+ "load_source_count": {
+ "type": "number"
+ },
+ "load_stored_fields": {
+ "type": "number"
+ },
+ "load_stored_fields_count": {
+ "type": "number"
+ },
+ "next_reader": {
+ "type": "number"
+ },
+ "next_reader_count": {
+ "type": "number"
+ },
+ "process_count": {
+ "type": "number"
+ },
+ "process": {
+ "type": "number"
+ }
+ }
+ },
+ "_global.search._types.FetchProfileDebug": {
+ "type": "object",
+ "properties": {
+ "stored_fields": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "fast_path": {
+ "type": "number"
+ }
+ }
+ },
+ "_types.NodeId": {
+ "type": "string"
+ },
+ "_global.search._types.SearchProfile": {
+ "type": "object",
+ "properties": {
+ "collector": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.Collector"
+ }
+ },
+ "query": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.QueryProfile"
+ }
+ },
+ "rewrite_time": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "collector",
+ "query",
+ "rewrite_time"
+ ]
+ },
+ "_global.search._types.Collector": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "reason": {
+ "type": "string"
+ },
+ "time_in_nanos": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitNanos"
+ }
+ ]
+ },
+ "children": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.Collector"
+ }
+ }
+ },
+ "required": [
+ "name",
+ "reason",
+ "time_in_nanos"
+ ]
+ },
+ "_global.search._types.QueryProfile": {
+ "type": "object",
+ "properties": {
+ "breakdown": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.QueryBreakdown"
+ }
+ ]
+ },
+ "description": {
+ "type": "string"
+ },
+ "time_in_nanos": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitNanos"
+ }
+ ]
+ },
+ "type": {
+ "type": "string"
+ },
+ "children": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.QueryProfile"
+ }
+ }
+ },
+ "required": [
+ "breakdown",
+ "description",
+ "time_in_nanos",
+ "type"
+ ]
+ },
+ "_global.search._types.QueryBreakdown": {
+ "type": "object",
+ "properties": {
+ "advance": {
+ "type": "number"
+ },
+ "advance_count": {
+ "type": "number"
+ },
+ "build_scorer": {
+ "type": "number"
+ },
+ "build_scorer_count": {
+ "type": "number"
+ },
+ "create_weight": {
+ "type": "number"
+ },
+ "create_weight_count": {
+ "type": "number"
+ },
+ "match": {
+ "type": "number"
+ },
+ "match_count": {
+ "type": "number"
+ },
+ "shallow_advance": {
+ "type": "number"
+ },
+ "shallow_advance_count": {
+ "type": "number"
+ },
+ "next_doc": {
+ "type": "number"
+ },
+ "next_doc_count": {
+ "type": "number"
+ },
+ "score": {
+ "type": "number"
+ },
+ "score_count": {
+ "type": "number"
+ },
+ "compute_max_score": {
+ "type": "number"
+ },
+ "compute_max_score_count": {
+ "type": "number"
+ },
+ "count_weight": {
+ "type": "number"
+ },
+ "count_weight_count": {
+ "type": "number"
+ },
+ "set_min_competitive_score": {
+ "type": "number"
+ },
+ "set_min_competitive_score_count": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "advance",
+ "advance_count",
+ "build_scorer",
+ "build_scorer_count",
+ "create_weight",
+ "create_weight_count",
+ "match",
+ "match_count",
+ "shallow_advance",
+ "shallow_advance_count",
+ "next_doc",
+ "next_doc_count",
+ "score",
+ "score_count",
+ "compute_max_score",
+ "compute_max_score_count",
+ "count_weight",
+ "count_weight_count",
+ "set_min_competitive_score",
+ "set_min_competitive_score_count"
+ ]
+ },
+ "_types.ScrollId": {
+ "type": "string"
+ },
+ "_global.search._types.Suggest": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.CompletionSuggest"
+ },
+ {
+ "$ref": "#/components/schemas/_global.search._types.PhraseSuggest"
+ },
+ {
+ "$ref": "#/components/schemas/_global.search._types.TermSuggest"
+ }
+ ]
+ },
+ "_global.search._types.CompletionSuggest": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.SuggestBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "options": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.CompletionSuggestOption"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.CompletionSuggestOption"
+ }
+ }
+ ]
+ }
+ },
+ "required": [
+ "options"
+ ]
+ }
+ ]
+ },
+ "_global.search._types.CompletionSuggestOption": {
+ "type": "object",
+ "properties": {
+ "collate_match": {
+ "type": "boolean"
+ },
+ "contexts": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.Context"
+ }
+ }
+ },
+ "fields": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "_id": {
+ "type": "string"
+ },
+ "_index": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "_routing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Routing"
+ }
+ ]
+ },
+ "_score": {
+ "type": "number"
+ },
+ "_source": {
+ "type": "object"
+ },
+ "text": {
+ "type": "string"
+ },
+ "score": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "text"
+ ]
+ },
+ "_global.search._types.Context": {
+ "description": "Text or location that we want similar documents for or a lookup to a document's field for the text.",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/_types.GeoLocation"
+ }
+ ]
+ },
+ "_types.Routing": {
+ "type": "string"
+ },
+ "_global.search._types.SuggestBase": {
+ "type": "object",
+ "properties": {
+ "length": {
+ "type": "number"
+ },
+ "offset": {
+ "type": "number"
+ },
+ "text": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "length",
+ "offset",
+ "text"
+ ]
+ },
+ "_global.search._types.PhraseSuggest": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.SuggestBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "options": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.PhraseSuggestOption"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.PhraseSuggestOption"
+ }
+ }
+ ]
+ }
+ },
+ "required": [
+ "options"
+ ]
+ }
+ ]
+ },
+ "_global.search._types.PhraseSuggestOption": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "type": "string"
+ },
+ "score": {
+ "type": "number"
+ },
+ "highlighted": {
+ "type": "string"
+ },
+ "collate_match": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "text",
+ "score"
+ ]
+ },
+ "_global.search._types.TermSuggest": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.SuggestBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "options": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.TermSuggestOption"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.TermSuggestOption"
+ }
+ }
+ ]
+ }
+ },
+ "required": [
+ "options"
+ ]
+ }
+ ]
+ },
+ "_global.search._types.TermSuggestOption": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "type": "string"
+ },
+ "score": {
+ "type": "number"
+ },
+ "freq": {
+ "type": "number"
+ },
+ "highlighted": {
+ "type": "string"
+ },
+ "collate_match": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "text",
+ "score",
+ "freq"
+ ]
+ },
+ "async_search._types.AsyncSearchResponseBase": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "is_partial": {
+ "description": "When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards.\nWhile the query is running, `is_partial` is always set to `true`.",
+ "type": "boolean"
+ },
+ "is_running": {
+ "description": "Indicates whether the search is still running or has completed.\n\n> info\n> If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`.",
+ "type": "boolean"
+ },
+ "expiration_time": {
+ "description": "Indicates when the async search will expire.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "expiration_time_in_millis": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "start_time": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "start_time_in_millis": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "completion_time": {
+ "description": "Indicates when the async search completed.\nIt is present only when the search has completed.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "completion_time_in_millis": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ }
+ },
+ "required": [
+ "is_partial",
+ "is_running",
+ "expiration_time_in_millis",
+ "start_time_in_millis"
+ ]
+ },
+ "_types.DateTime": {
+ "description": "A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a\nnumber of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string\nrepresentation.",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "async_search.status.StatusResponseBase": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/async_search._types.AsyncSearchResponseBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "_shards": {
+ "description": "The number of shards that have run the query so far.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ShardStatistics"
+ }
+ ]
+ },
+ "_clusters": {
+ "description": "Metadata about clusters involved in the cross-cluster search.\nIt is not shown for local-only searches.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ClusterStatistics"
+ }
+ ]
+ },
+ "completion_status": {
+ "description": "If the async search completed, this field shows the status code of the search.\nFor example, `200` indicates that the async search was successfully completed.\n`503` indicates that the async search was completed with an error.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "_shards"
+ ]
+ }
+ ]
+ },
+ "_types.Indices": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ }
+ ]
+ },
+ "_types.query_dsl.Operator": {
+ "type": "string",
+ "enum": [
+ "and",
+ "AND",
+ "or",
+ "OR"
+ ]
+ },
+ "_types.Fields": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ }
+ ]
+ },
+ "_types.ExpandWildcards": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.ExpandWildcard"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.ExpandWildcard"
+ }
+ }
+ ]
+ },
+ "_types.ExpandWildcard": {
+ "type": "string",
+ "enum": [
+ "all",
+ "open",
+ "closed",
+ "hidden",
+ "none"
+ ]
+ },
+ "_types.SearchType": {
+ "type": "string",
+ "enum": [
+ "query_then_fetch",
+ "dfs_query_then_fetch"
+ ]
+ },
+ "_types.SuggestMode": {
+ "type": "string",
+ "enum": [
+ "missing",
+ "popular",
+ "always"
+ ]
+ },
+ "_global.search._types.TrackHits": {
+ "description": "Number of hits matching the query to count accurately. If true, the exact\nnumber of hits is returned at the cost of some performance. If false, the\nresponse does not include the total number of hits matching the query.\nDefaults to 10,000 hits.",
+ "oneOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "number"
+ }
+ ]
+ },
+ "_global.search._types.SourceConfigParam": {
+ "description": "Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.\nUsed as a query parameter along with the `_source_includes` and `_source_excludes` parameters.",
+ "oneOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ },
+ "_types.aggregations.AggregationContainer": {
+ "allOf": [
+ {
+ "type": "object",
+ "properties": {
+ "aggregations": {
+ "description": "Sub-aggregations for this aggregation.\nOnly applies to bucket aggregations.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.AggregationContainer"
+ }
+ },
+ "meta": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ }
+ }
+ },
+ {
+ "type": "object",
+ "properties": {
+ "adjacency_matrix": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-adjacency-matrix-aggregation"
+ },
+ "description": "A bucket aggregation returning a form of adjacency matrix.\nThe request provides a collection of named filter expressions, similar to the `filters` aggregation.\nEach bucket in the response represents a non-empty cell in the matrix of intersecting filters.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AdjacencyMatrixAggregation"
+ }
+ ]
+ },
+ "auto_date_histogram": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-autodatehistogram-aggregation"
+ },
+ "description": "A multi-bucket aggregation similar to the date histogram, except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AutoDateHistogramAggregation"
+ }
+ ]
+ },
+ "avg": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-avg-aggregation"
+ },
+ "description": "A single-value metrics aggregation that computes the average of numeric values that are extracted from the aggregated documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AverageAggregation"
+ }
+ ]
+ },
+ "avg_bucket": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-avg-bucket-aggregation"
+ },
+ "description": "A sibling pipeline aggregation which calculates the mean value of a specified metric in a sibling aggregation.\nThe specified metric must be numeric and the sibling aggregation must be a multi-bucket aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AverageBucketAggregation"
+ }
+ ]
+ },
+ "boxplot": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-boxplot-aggregation"
+ },
+ "description": "A metrics aggregation that computes a box plot of numeric values extracted from the aggregated documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BoxplotAggregation"
+ }
+ ]
+ },
+ "bucket_script": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-script-aggregation"
+ },
+ "description": "A parent pipeline aggregation which runs a script which can perform per bucket computations on metrics in the parent multi-bucket aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketScriptAggregation"
+ }
+ ]
+ },
+ "bucket_selector": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-selector-aggregation"
+ },
+ "description": "A parent pipeline aggregation which runs a script to determine whether the current bucket will be retained in the parent multi-bucket aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketSelectorAggregation"
+ }
+ ]
+ },
+ "bucket_sort": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-sort-aggregation"
+ },
+ "description": "A parent pipeline aggregation which sorts the buckets of its parent multi-bucket aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketSortAggregation"
+ }
+ ]
+ },
+ "bucket_count_ks_test": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-count-ks-test-aggregation"
+ },
+ "description": "A sibling pipeline aggregation which runs a two sample Kolmogorov–Smirnov test (\"K-S test\") against a provided distribution and the distribution implied by the documents counts in the configured sibling aggregation.",
+ "x-state": "Technical preview",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketKsAggregation"
+ }
+ ]
+ },
+ "bucket_correlation": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-correlation-aggregation"
+ },
+ "description": "A sibling pipeline aggregation which runs a correlation function on the configured sibling multi-bucket aggregation.",
+ "x-state": "Technical preview",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketCorrelationAggregation"
+ }
+ ]
+ },
+ "cardinality": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-cardinality-aggregation"
+ },
+ "description": "A single-value metrics aggregation that calculates an approximate count of distinct values.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CardinalityAggregation"
+ }
+ ]
+ },
+ "categorize_text": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-categorize-text-aggregation"
+ },
+ "description": "A multi-bucket aggregation that groups semi-structured text into buckets.",
+ "x-state": "Technical preview",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CategorizeTextAggregation"
+ }
+ ]
+ },
+ "children": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-children-aggregation"
+ },
+ "description": "A single bucket aggregation that selects child documents that have the specified type, as defined in a `join` field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ChildrenAggregation"
+ }
+ ]
+ },
+ "composite": {
+ "description": "A multi-bucket aggregation that creates composite buckets from different sources.\nUnlike the other multi-bucket aggregations, you can use the `composite` aggregation to paginate *all* buckets from a multi-level aggregation efficiently.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CompositeAggregation"
+ }
+ ]
+ },
+ "cumulative_cardinality": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-cumulative-cardinality-aggregation"
+ },
+ "description": "A parent pipeline aggregation which calculates the cumulative cardinality in a parent `histogram` or `date_histogram` aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CumulativeCardinalityAggregation"
+ }
+ ]
+ },
+ "cumulative_sum": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-cumulative-sum-aggregation"
+ },
+ "description": "A parent pipeline aggregation which calculates the cumulative sum of a specified metric in a parent `histogram` or `date_histogram` aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CumulativeSumAggregation"
+ }
+ ]
+ },
+ "date_histogram": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-datehistogram-aggregation"
+ },
+ "description": "A multi-bucket values source based aggregation that can be applied on date values or date range values extracted from the documents.\nIt dynamically builds fixed size (interval) buckets over the values.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.DateHistogramAggregation"
+ }
+ ]
+ },
+ "date_range": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-daterange-aggregation"
+ },
+ "description": "A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.DateRangeAggregation"
+ }
+ ]
+ },
+ "derivative": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-derivative-aggregation"
+ },
+ "description": "A parent pipeline aggregation which calculates the derivative of a specified metric in a parent `histogram` or `date_histogram` aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.DerivativeAggregation"
+ }
+ ]
+ },
+ "diversified_sampler": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-diversified-sampler-aggregation"
+ },
+ "description": "A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents.\nSimilar to the `sampler` aggregation, but adds the ability to limit the number of matches that share a common value.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.DiversifiedSamplerAggregation"
+ }
+ ]
+ },
+ "extended_stats": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-extendedstats-aggregation"
+ },
+ "description": "A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ExtendedStatsAggregation"
+ }
+ ]
+ },
+ "extended_stats_bucket": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-extended-stats-bucket-aggregation"
+ },
+ "description": "A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ExtendedStatsBucketAggregation"
+ }
+ ]
+ },
+ "frequent_item_sets": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-frequent-item-sets-aggregation"
+ },
+ "description": "A bucket aggregation which finds frequent item sets, a form of association rules mining that identifies items that often occur together.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.FrequentItemSetsAggregation"
+ }
+ ]
+ },
+ "filter": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filter-aggregation"
+ },
+ "description": "A single bucket aggregation that narrows the set of documents to those that match a query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "filters": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filters-aggregation"
+ },
+ "description": "A multi-bucket aggregation where each bucket contains the documents that match a query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.FiltersAggregation"
+ }
+ ]
+ },
+ "geo_bounds": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geobounds-aggregation"
+ },
+ "description": "A metric aggregation that computes the geographic bounding box containing all values for a Geopoint or Geoshape field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.GeoBoundsAggregation"
+ }
+ ]
+ },
+ "geo_centroid": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geocentroid-aggregation"
+ },
+ "description": "A metric aggregation that computes the weighted centroid from all coordinate values for geo fields.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.GeoCentroidAggregation"
+ }
+ ]
+ },
+ "geo_distance": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geodistance-aggregation"
+ },
+ "description": "A multi-bucket aggregation that works on `geo_point` fields.\nEvaluates the distance of each document value from an origin point and determines the buckets it belongs to, based on ranges defined in the request.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.GeoDistanceAggregation"
+ }
+ ]
+ },
+ "geohash_grid": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geohashgrid-aggregation"
+ },
+ "description": "A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid.\nEach cell is labeled using a geohash which is of user-definable precision.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.GeoHashGridAggregation"
+ }
+ ]
+ },
+ "geo_line": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geo-line"
+ },
+ "description": "Aggregates all `geo_point` values within a bucket into a `LineString` ordered by the chosen sort field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.GeoLineAggregation"
+ }
+ ]
+ },
+ "geotile_grid": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geotilegrid-aggregation"
+ },
+ "description": "A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid.\nEach cell corresponds to a map tile as used by many online map sites.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.GeoTileGridAggregation"
+ }
+ ]
+ },
+ "geohex_grid": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geohexgrid-aggregation"
+ },
+ "description": "A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid.\nEach cell corresponds to a H3 cell index and is labeled using the H3Index representation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.GeohexGridAggregation"
+ }
+ ]
+ },
+ "global": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-global-aggregation"
+ },
+ "description": "Defines a single bucket of all the documents within the search execution context.\nThis context is defined by the indices and the document types you’re searching on, but is not influenced by the search query itself.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.GlobalAggregation"
+ }
+ ]
+ },
+ "histogram": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-histogram-aggregation"
+ },
+ "description": "A multi-bucket values source based aggregation that can be applied on numeric values or numeric range values extracted from the documents.\nIt dynamically builds fixed size (interval) buckets over the values.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.HistogramAggregation"
+ }
+ ]
+ },
+ "ip_range": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-iprange-aggregation"
+ },
+ "description": "A multi-bucket value source based aggregation that enables the user to define a set of IP ranges - each representing a bucket.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.IpRangeAggregation"
+ }
+ ]
+ },
+ "ip_prefix": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-ipprefix-aggregation"
+ },
+ "description": "A bucket aggregation that groups documents based on the network or sub-network of an IP address.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.IpPrefixAggregation"
+ }
+ ]
+ },
+ "inference": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-inference-bucket-aggregation"
+ },
+ "description": "A parent pipeline aggregation which loads a pre-trained model and performs inference on the collated result fields from the parent bucket aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.InferenceAggregation"
+ }
+ ]
+ },
+ "line": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.GeoLineAggregation"
+ }
+ ]
+ },
+ "matrix_stats": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-matrix-stats-aggregation"
+ },
+ "description": "A numeric aggregation that computes the following statistics over a set of document fields: `count`, `mean`, `variance`, `skewness`, `kurtosis`, `covariance`, and `covariance`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MatrixStatsAggregation"
+ }
+ ]
+ },
+ "max": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-max-aggregation"
+ },
+ "description": "A single-value metrics aggregation that returns the maximum value among the numeric values extracted from the aggregated documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MaxAggregation"
+ }
+ ]
+ },
+ "max_bucket": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-max-bucket-aggregation"
+ },
+ "description": "A sibling pipeline aggregation which identifies the bucket(s) with the maximum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s).",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MaxBucketAggregation"
+ }
+ ]
+ },
+ "median_absolute_deviation": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-median-absolute-deviation-aggregation"
+ },
+ "description": "A single-value aggregation that approximates the median absolute deviation of its search results.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MedianAbsoluteDeviationAggregation"
+ }
+ ]
+ },
+ "min": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-min-aggregation"
+ },
+ "description": "A single-value metrics aggregation that returns the minimum value among numeric values extracted from the aggregated documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MinAggregation"
+ }
+ ]
+ },
+ "min_bucket": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-min-bucket-aggregation"
+ },
+ "description": "A sibling pipeline aggregation which identifies the bucket(s) with the minimum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s).",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MinBucketAggregation"
+ }
+ ]
+ },
+ "missing": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-missing-aggregation"
+ },
+ "description": "A field data based single bucket aggregation, that creates a bucket of all documents in the current document set context that are missing a field value (effectively, missing a field or having the configured NULL value set).",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MissingAggregation"
+ }
+ ]
+ },
+ "moving_avg": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MovingAverageAggregation"
+ }
+ ]
+ },
+ "moving_percentiles": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-moving-percentiles-aggregation"
+ },
+ "description": "Given an ordered series of percentiles, \"slides\" a window across those percentiles and computes cumulative percentiles.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MovingPercentilesAggregation"
+ }
+ ]
+ },
+ "moving_fn": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-movfn-aggregation"
+ },
+ "description": "Given an ordered series of data, \"slides\" a window across the data and runs a custom script on each window of data.\nFor convenience, a number of common functions are predefined such as `min`, `max`, and moving averages.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MovingFunctionAggregation"
+ }
+ ]
+ },
+ "multi_terms": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-multi-terms-aggregation"
+ },
+ "description": "A multi-bucket value source based aggregation where buckets are dynamically built - one per unique set of values.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiTermsAggregation"
+ }
+ ]
+ },
+ "nested": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-nested-aggregation"
+ },
+ "description": "A special single bucket aggregation that enables aggregating nested documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.NestedAggregation"
+ }
+ ]
+ },
+ "normalize": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-normalize-aggregation"
+ },
+ "description": "A parent pipeline aggregation which calculates the specific normalized/rescaled value for a specific bucket value.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.NormalizeAggregation"
+ }
+ ]
+ },
+ "parent": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-parent-aggregation"
+ },
+ "description": "A special single bucket aggregation that selects parent documents that have the specified type, as defined in a `join` field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ParentAggregation"
+ }
+ ]
+ },
+ "percentile_ranks": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-percentile-rank-aggregation"
+ },
+ "description": "A multi-value metrics aggregation that calculates one or more percentile ranks over numeric values extracted from the aggregated documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PercentileRanksAggregation"
+ }
+ ]
+ },
+ "percentiles": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-percentile-aggregation"
+ },
+ "description": "A multi-value metrics aggregation that calculates one or more percentiles over numeric values extracted from the aggregated documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PercentilesAggregation"
+ }
+ ]
+ },
+ "percentiles_bucket": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-percentiles-bucket-aggregation"
+ },
+ "description": "A sibling pipeline aggregation which calculates percentiles across all bucket of a specified metric in a sibling aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PercentilesBucketAggregation"
+ }
+ ]
+ },
+ "range": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-range-aggregation"
+ },
+ "description": "A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.RangeAggregation"
+ }
+ ]
+ },
+ "rare_terms": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-rare-terms-aggregation"
+ },
+ "description": "A multi-bucket value source based aggregation which finds \"rare\" terms — terms that are at the long-tail of the distribution and are not frequent.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.RareTermsAggregation"
+ }
+ ]
+ },
+ "rate": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-rate-aggregation"
+ },
+ "description": "Calculates a rate of documents or a field in each bucket.\nCan only be used inside a `date_histogram` or `composite` aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.RateAggregation"
+ }
+ ]
+ },
+ "reverse_nested": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-reverse-nested-aggregation"
+ },
+ "description": "A special single bucket aggregation that enables aggregating on parent documents from nested documents.\nShould only be defined inside a `nested` aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ReverseNestedAggregation"
+ }
+ ]
+ },
+ "sampler": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-sampler-aggregation"
+ },
+ "description": "A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SamplerAggregation"
+ }
+ ]
+ },
+ "scripted_metric": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-scripted-metric-aggregation"
+ },
+ "description": "A metric aggregation that uses scripts to provide a metric output.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ScriptedMetricAggregation"
+ }
+ ]
+ },
+ "serial_diff": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-serialdiff-aggregation"
+ },
+ "description": "An aggregation that subtracts values in a time series from themselves at different time lags or periods.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SerialDifferencingAggregation"
+ }
+ ]
+ },
+ "significant_terms": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significantterms-aggregation"
+ },
+ "description": "Returns interesting or unusual occurrences of terms in a set.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SignificantTermsAggregation"
+ }
+ ]
+ },
+ "significant_text": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significanttext-aggregation"
+ },
+ "description": "Returns interesting or unusual occurrences of free-text terms in a set.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SignificantTextAggregation"
+ }
+ ]
+ },
+ "stats": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-stats-aggregation"
+ },
+ "description": "A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.StatsAggregation"
+ }
+ ]
+ },
+ "stats_bucket": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-stats-bucket-aggregation"
+ },
+ "description": "A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.StatsBucketAggregation"
+ }
+ ]
+ },
+ "string_stats": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-string-stats-aggregation"
+ },
+ "description": "A multi-value metrics aggregation that computes statistics over string values extracted from the aggregated documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.StringStatsAggregation"
+ }
+ ]
+ },
+ "sum": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-sum-aggregation"
+ },
+ "description": "A single-value metrics aggregation that sums numeric values that are extracted from the aggregated documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SumAggregation"
+ }
+ ]
+ },
+ "sum_bucket": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-sum-bucket-aggregation"
+ },
+ "description": "A sibling pipeline aggregation which calculates the sum of a specified metric across all buckets in a sibling aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SumBucketAggregation"
+ }
+ ]
+ },
+ "terms": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-terms-aggregation"
+ },
+ "description": "A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsAggregation"
+ }
+ ]
+ },
+ "time_series": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-time-series-aggregation"
+ },
+ "description": "The time series aggregation queries data created using a time series index.\nThis is typically data such as metrics or other data streams with a time component, and requires creating an index using the time series mode.",
+ "x-state": "Technical preview",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TimeSeriesAggregation"
+ }
+ ]
+ },
+ "top_hits": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-hits-aggregation"
+ },
+ "description": "A metric aggregation that returns the top matching documents per bucket.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TopHitsAggregation"
+ }
+ ]
+ },
+ "t_test": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-ttest-aggregation"
+ },
+ "description": "A metrics aggregation that performs a statistical hypothesis test in which the test statistic follows a Student’s t-distribution under the null hypothesis on numeric values extracted from the aggregated documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TTestAggregation"
+ }
+ ]
+ },
+ "top_metrics": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-metrics"
+ },
+ "description": "A metric aggregation that selects metrics from the document with the largest or smallest sort value.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TopMetricsAggregation"
+ }
+ ]
+ },
+ "value_count": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-valuecount-aggregation"
+ },
+ "description": "A single-value metrics aggregation that counts the number of values that are extracted from the aggregated documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ValueCountAggregation"
+ }
+ ]
+ },
+ "weighted_avg": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-weight-avg-aggregation"
+ },
+ "description": "A single-value metrics aggregation that computes the weighted average of numeric values that are extracted from the aggregated documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.WeightedAverageAggregation"
+ }
+ ]
+ },
+ "variable_width_histogram": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-variablewidthhistogram-aggregation"
+ },
+ "description": "A multi-bucket aggregation similar to the histogram, except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.VariableWidthHistogramAggregation"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ }
+ ]
+ },
+ "_types.aggregations.AdjacencyMatrixAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "filters": {
+ "description": "Filters used to create buckets.\nAt least one filter is required.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ },
+ "separator": {
+ "description": "Separator used to concatenate filter names. Defaults to &.",
+ "type": "string"
+ }
+ }
+ }
+ ]
+ },
+ "_types.query_dsl.QueryContainer": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl"
+ },
+ "description": "An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.",
+ "type": "object",
+ "properties": {
+ "bool": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-bool-query"
+ },
+ "description": "matches documents matching boolean combinations of other queries.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.BoolQuery"
+ }
+ ]
+ },
+ "boosting": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-boosting-query"
+ },
+ "description": "Returns documents matching a `positive` query while reducing the relevance score of documents that also match a `negative` query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.BoostingQuery"
+ }
+ ]
+ },
+ "common": {
+ "deprecated": true,
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.CommonTermsQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "combined_fields": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-combined-fields-query"
+ },
+ "description": "The `combined_fields` query supports searching multiple text fields as if their contents had been indexed into one combined field.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.CombinedFieldsQuery"
+ }
+ ]
+ },
+ "constant_score": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-constant-score-query"
+ },
+ "description": "Wraps a filter query and returns every matching document with a relevance score equal to the `boost` parameter value.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.ConstantScoreQuery"
+ }
+ ]
+ },
+ "dis_max": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-dis-max-query"
+ },
+ "description": "Returns documents matching one or more wrapped queries, called query clauses or clauses.\nIf a returned document matches multiple query clauses, the `dis_max` query assigns the document the highest relevance score from any matching clause, plus a tie breaking increment for any additional matching subqueries.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.DisMaxQuery"
+ }
+ ]
+ },
+ "distance_feature": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-distance-feature-query"
+ },
+ "description": "Boosts the relevance score of documents closer to a provided origin date or point.\nFor example, you can use this query to give more weight to documents closer to a certain date or location.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.DistanceFeatureQuery"
+ }
+ ]
+ },
+ "exists": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-exists-query"
+ },
+ "description": "Returns documents that contain an indexed value for a field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.ExistsQuery"
+ }
+ ]
+ },
+ "function_score": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-function-score-query"
+ },
+ "description": "The `function_score` enables you to modify the score of documents that are retrieved by a query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.FunctionScoreQuery"
+ }
+ ]
+ },
+ "fuzzy": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-fuzzy-query"
+ },
+ "description": "Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.FuzzyQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "geo_bounding_box": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-bounding-box-query"
+ },
+ "description": "Matches geo_point and geo_shape values that intersect a bounding box.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.GeoBoundingBoxQuery"
+ }
+ ]
+ },
+ "geo_distance": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-distance-query"
+ },
+ "description": "Matches `geo_point` and `geo_shape` values within a given distance of a geopoint.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.GeoDistanceQuery"
+ }
+ ]
+ },
+ "geo_grid": {
+ "description": "Matches `geo_point` and `geo_shape` values that intersect a grid cell from a GeoGrid aggregation.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.GeoGridQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "geo_polygon": {
+ "deprecated": true,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.GeoPolygonQuery"
+ }
+ ]
+ },
+ "geo_shape": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-shape-query"
+ },
+ "description": "Filter documents indexed using either the `geo_shape` or the `geo_point` type.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.GeoShapeQuery"
+ }
+ ]
+ },
+ "has_child": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-has-child-query"
+ },
+ "description": "Returns parent documents whose joined child documents match a provided query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.HasChildQuery"
+ }
+ ]
+ },
+ "has_parent": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-has-parent-query"
+ },
+ "description": "Returns child documents whose joined parent document matches a provided query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.HasParentQuery"
+ }
+ ]
+ },
+ "ids": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-ids-query"
+ },
+ "description": "Returns documents based on their IDs.\nThis query uses document IDs stored in the `_id` field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IdsQuery"
+ }
+ ]
+ },
+ "intervals": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-intervals-query"
+ },
+ "description": "Returns documents based on the order and proximity of matching terms.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "knn": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-knn-query"
+ },
+ "description": "Finds the k nearest vectors to a query vector, as measured by a similarity\nmetric. knn query finds nearest vectors through approximate search on indexed\ndense_vectors.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.KnnQuery"
+ }
+ ]
+ },
+ "match": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query"
+ },
+ "description": "Returns documents that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.MatchQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "match_all": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query"
+ },
+ "description": "Matches all documents, giving them all a `_score` of 1.0.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.MatchAllQuery"
+ }
+ ]
+ },
+ "match_bool_prefix": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-bool-prefix-query"
+ },
+ "description": "Analyzes its input and constructs a `bool` query from the terms.\nEach term except the last is used in a `term` query.\nThe last term is used in a prefix query.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.MatchBoolPrefixQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "match_none": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query#query-dsl-match-none-query"
+ },
+ "description": "Matches no documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.MatchNoneQuery"
+ }
+ ]
+ },
+ "match_phrase": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase"
+ },
+ "description": "Analyzes the text and creates a phrase query out of the analyzed text.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.MatchPhraseQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "match_phrase_prefix": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase-prefix"
+ },
+ "description": "Returns documents that contain the words of a provided text, in the same order as provided.\nThe last term of the provided text is treated as a prefix, matching any words that begin with that term.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.MatchPhrasePrefixQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "more_like_this": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-mlt-query"
+ },
+ "description": "Returns documents that are \"like\" a given set of documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.MoreLikeThisQuery"
+ }
+ ]
+ },
+ "multi_match": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-match-query"
+ },
+ "description": "Enables you to search for a provided text, number, date or boolean value across multiple fields.\nThe provided text is analyzed before matching.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.MultiMatchQuery"
+ }
+ ]
+ },
+ "nested": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-nested-query"
+ },
+ "description": "Wraps another query to search nested fields.\nIf an object matches the search, the nested query returns the root parent document.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.NestedQuery"
+ }
+ ]
+ },
+ "parent_id": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-parent-id-query"
+ },
+ "description": "Returns child documents joined to a specific parent document.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.ParentIdQuery"
+ }
+ ]
+ },
+ "percolate": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-percolate-query"
+ },
+ "description": "Matches queries stored in an index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.PercolateQuery"
+ }
+ ]
+ },
+ "pinned": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-pinned-query"
+ },
+ "description": "Promotes selected documents to rank higher than those matching a given query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.PinnedQuery"
+ }
+ ]
+ },
+ "prefix": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-prefix-query"
+ },
+ "description": "Returns documents that contain a specific prefix in a provided field.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.PrefixQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "query_string": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-query-string-query"
+ },
+ "description": "Returns documents based on a provided query string, using a parser with a strict syntax.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryStringQuery"
+ }
+ ]
+ },
+ "range": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-range-query"
+ },
+ "description": "Returns documents that contain terms within a provided range.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.RangeQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "rank_feature": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-rank-feature-query"
+ },
+ "description": "Boosts the relevance score of documents based on the numeric value of a `rank_feature` or `rank_features` field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.RankFeatureQuery"
+ }
+ ]
+ },
+ "regexp": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-regexp-query"
+ },
+ "description": "Returns documents that contain terms matching a regular expression.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.RegexpQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "rule": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.RuleQuery"
+ }
+ ]
+ },
+ "script": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-script-query"
+ },
+ "description": "Filters documents based on a provided script.\nThe script query is typically used in a filter context.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.ScriptQuery"
+ }
+ ]
+ },
+ "script_score": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-script-score-query"
+ },
+ "description": "Uses a script to provide a custom score for returned documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.ScriptScoreQuery"
+ }
+ ]
+ },
+ "semantic": {
+ "description": "A semantic query to semantic_text field types",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SemanticQuery"
+ }
+ ]
+ },
+ "shape": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-shape-query"
+ },
+ "description": "Queries documents that contain fields indexed using the `shape` type.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.ShapeQuery"
+ }
+ ]
+ },
+ "simple_query_string": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-simple-query-string-query"
+ },
+ "description": "Returns documents based on a provided query string, using a parser with a limited but fault-tolerant syntax.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringQuery"
+ }
+ ]
+ },
+ "span_containing": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-containing-query"
+ },
+ "description": "Returns matches which enclose another span query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanContainingQuery"
+ }
+ ]
+ },
+ "span_field_masking": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-field-masking-query"
+ },
+ "description": "Wrapper to allow span queries to participate in composite single-field span queries by _lying_ about their search field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanFieldMaskingQuery"
+ }
+ ]
+ },
+ "span_first": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-first-query"
+ },
+ "description": "Matches spans near the beginning of a field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanFirstQuery"
+ }
+ ]
+ },
+ "span_multi": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-multi-term-query"
+ },
+ "description": "Allows you to wrap a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query) as a `span` query, so it can be nested.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanMultiTermQuery"
+ }
+ ]
+ },
+ "span_near": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-near-query"
+ },
+ "description": "Matches spans which are near one another.\nYou can specify `slop`, the maximum number of intervening unmatched positions, as well as whether matches are required to be in-order.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanNearQuery"
+ }
+ ]
+ },
+ "span_not": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-not-query"
+ },
+ "description": "Removes matches which overlap with another span query or which are within x tokens before (controlled by the parameter `pre`) or y tokens after (controlled by the parameter `post`) another span query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanNotQuery"
+ }
+ ]
+ },
+ "span_or": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-query"
+ },
+ "description": "Matches the union of its span clauses.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanOrQuery"
+ }
+ ]
+ },
+ "span_term": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-term-query"
+ },
+ "description": "Matches spans containing a term.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanTermQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "span_within": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-within-query"
+ },
+ "description": "Returns matches which are enclosed inside another span query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanWithinQuery"
+ }
+ ]
+ },
+ "sparse_vector": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-sparse-vector-query"
+ },
+ "description": "Using input query vectors or a natural language processing model to convert a query into a list of token-weight pairs, queries against a sparse vector field.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SparseVectorQuery"
+ }
+ ]
+ },
+ "term": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-term-query"
+ },
+ "description": "Returns documents that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.TermQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "terms": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-query"
+ },
+ "description": "Returns documents that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.TermsQuery"
+ }
+ ]
+ },
+ "terms_set": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-set-query"
+ },
+ "description": "Returns documents that contain a minimum number of exact terms in a provided field.\nTo return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.TermsSetQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "text_expansion": {
+ "deprecated": true,
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-text-expansion-query"
+ },
+ "description": "Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.",
+ "x-state": "Generally available",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.TextExpansionQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "weighted_tokens": {
+ "deprecated": true,
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-weighted-tokens-query"
+ },
+ "description": "Supports returning text_expansion query results by sending in precomputed tokens with the query.",
+ "x-state": "Generally available",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.WeightedTokensQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "wildcard": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wildcard-query"
+ },
+ "description": "Returns documents that contain terms matching a wildcard pattern.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.WildcardQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "wrapper": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wrapper-query"
+ },
+ "description": "A query that accepts any other query as base64 encoded string.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.WrapperQuery"
+ }
+ ]
+ },
+ "type": {
+ "deprecated": true,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.TypeQuery"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "_types.query_dsl.BoolQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "filter": {
+ "description": "The clause (query) must appear in matching documents.\nHowever, unlike `must`, the score of the query will be ignored.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ }
+ ]
+ },
+ "minimum_should_match": {
+ "description": "Specifies the number or percentage of `should` clauses returned documents must match.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.MinimumShouldMatch"
+ }
+ ]
+ },
+ "must": {
+ "description": "The clause (query) must appear in matching documents and will contribute to the score.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ }
+ ]
+ },
+ "must_not": {
+ "description": "The clause (query) must not appear in the matching documents.\nBecause scoring is ignored, a score of `0` is returned for all documents.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ }
+ ]
+ },
+ "should": {
+ "description": "The clause (query) should appear in the matching document.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.MinimumShouldMatch": {
+ "description": "The minimum number of terms that should match as integer, percentage or range",
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "_types.query_dsl.QueryBase": {
+ "type": "object",
+ "properties": {
+ "boost": {
+ "description": "Floating point number used to decrease or increase the relevance scores of the query.\nBoost values are relative to the default value of 1.0.\nA boost value between 0 and 1.0 decreases the relevance score.\nA value greater than 1.0 increases the relevance score.",
+ "default": 1.0,
+ "type": "number"
+ },
+ "_name": {
+ "type": "string"
+ }
+ }
+ },
+ "_types.query_dsl.BoostingQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "negative_boost": {
+ "description": "Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the `negative` query.",
+ "type": "number"
+ },
+ "negative": {
+ "description": "Query used to decrease the relevance score of matching documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "positive": {
+ "description": "Any returned documents must match this query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ }
+ },
+ "required": [
+ "negative_boost",
+ "negative",
+ "positive"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.CommonTermsQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "analyzer": {
+ "type": "string"
+ },
+ "cutoff_frequency": {
+ "type": "number"
+ },
+ "high_freq_operator": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.Operator"
+ }
+ ]
+ },
+ "low_freq_operator": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.Operator"
+ }
+ ]
+ },
+ "minimum_should_match": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.MinimumShouldMatch"
+ }
+ ]
+ },
+ "query": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "query"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.CombinedFieldsQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "fields": {
+ "description": "List of fields to search. Field wildcard patterns are allowed. Only `text` fields are supported, and they must all have the same search `analyzer`.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ },
+ "query": {
+ "description": "Text to search for in the provided `fields`.\nThe `combined_fields` query analyzes the provided text before performing a search.",
+ "type": "string"
+ },
+ "auto_generate_synonyms_phrase_query": {
+ "description": "If true, match phrase queries are automatically created for multi-term synonyms.",
+ "default": true,
+ "type": "boolean"
+ },
+ "operator": {
+ "description": "Boolean logic used to interpret text in the query value.",
+ "default": "or",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.CombinedFieldsOperator"
+ }
+ ]
+ },
+ "minimum_should_match": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match"
+ },
+ "description": "Minimum number of clauses that must match for a document to be returned.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.MinimumShouldMatch"
+ }
+ ]
+ },
+ "zero_terms_query": {
+ "description": "Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter.\n\nSupported values include:\n - `none`: No documents are returned if the analyzer removes all tokens.\n - `all`: Returns all documents, similar to a `match_all` query.\n\n",
+ "default": "none",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.CombinedFieldsZeroTerms"
+ }
+ ]
+ }
+ },
+ "required": [
+ "fields",
+ "query"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.CombinedFieldsOperator": {
+ "type": "string",
+ "enum": [
+ "or",
+ "and"
+ ]
+ },
+ "_types.query_dsl.CombinedFieldsZeroTerms": {
+ "type": "string",
+ "enum": [
+ "none",
+ "all"
+ ]
+ },
+ "_types.query_dsl.ConstantScoreQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "filter": {
+ "description": "Filter query you wish to run. Any returned documents must match this query.\nFilter queries do not calculate relevance scores.\nTo speed up performance, Elasticsearch automatically caches frequently used filter queries.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ }
+ },
+ "required": [
+ "filter"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.DisMaxQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "queries": {
+ "description": "One or more query clauses.\nReturned documents must match one or more of these queries.\nIf a document matches multiple queries, Elasticsearch uses the highest relevance score.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ },
+ "tie_breaker": {
+ "description": "Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses.",
+ "default": 0.0,
+ "type": "number"
+ }
+ },
+ "required": [
+ "queries"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.DistanceFeatureQuery": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-distance-feature-query"
+ },
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.UntypedDistanceFeatureQuery"
+ },
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.GeoDistanceFeatureQuery"
+ },
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.DateDistanceFeatureQuery"
+ }
+ ]
+ },
+ "_types.query_dsl.UntypedDistanceFeatureQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.DistanceFeatureQueryBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.query_dsl.DistanceFeatureQueryBase": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "origin": {
+ "description": "Date or point of origin used to calculate distances.\nIf the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.\nDate Math, such as `now-1h`, is supported.\nIf the field value is a `geo_point` field, the `origin` value must be a geopoint.",
+ "type": "object"
+ },
+ "pivot": {
+ "description": "Distance from the `origin` at which relevance scores receive half of the `boost` value.\nIf the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`.",
+ "type": "object"
+ },
+ "field": {
+ "description": "Name of the field used to calculate distances. This field must meet the following criteria:\nbe a `date`, `date_nanos` or `geo_point` field;\nhave an `index` mapping parameter value of `true`, which is the default;\nhave an `doc_values` mapping parameter value of `true`, which is the default.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "origin",
+ "pivot",
+ "field"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.GeoDistanceFeatureQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.DistanceFeatureQueryBaseGeoLocationDistance"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.query_dsl.DistanceFeatureQueryBaseGeoLocationDistance": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "origin": {
+ "description": "Date or point of origin used to calculate distances.\nIf the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.\nDate Math, such as `now-1h`, is supported.\nIf the field value is a `geo_point` field, the `origin` value must be a geopoint.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoLocation"
+ }
+ ]
+ },
+ "pivot": {
+ "description": "Distance from the `origin` at which relevance scores receive half of the `boost` value.\nIf the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Distance"
+ }
+ ]
+ },
+ "field": {
+ "description": "Name of the field used to calculate distances. This field must meet the following criteria:\nbe a `date`, `date_nanos` or `geo_point` field;\nhave an `index` mapping parameter value of `true`, which is the default;\nhave an `doc_values` mapping parameter value of `true`, which is the default.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "origin",
+ "pivot",
+ "field"
+ ]
+ }
+ ]
+ },
+ "_types.Distance": {
+ "type": "string"
+ },
+ "_types.query_dsl.DateDistanceFeatureQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.DistanceFeatureQueryBaseDateMathDuration"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.query_dsl.DistanceFeatureQueryBaseDateMathDuration": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "origin": {
+ "description": "Date or point of origin used to calculate distances.\nIf the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.\nDate Math, such as `now-1h`, is supported.\nIf the field value is a `geo_point` field, the `origin` value must be a geopoint.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateMath"
+ }
+ ]
+ },
+ "pivot": {
+ "description": "Distance from the `origin` at which relevance scores receive half of the `boost` value.\nIf the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "field": {
+ "description": "Name of the field used to calculate distances. This field must meet the following criteria:\nbe a `date`, `date_nanos` or `geo_point` field;\nhave an `index` mapping parameter value of `true`, which is the default;\nhave an `doc_values` mapping parameter value of `true`, which is the default.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "origin",
+ "pivot",
+ "field"
+ ]
+ }
+ ]
+ },
+ "_types.DateMath": {
+ "type": "string"
+ },
+ "_types.query_dsl.ExistsQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "Name of the field you wish to search.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.FunctionScoreQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "boost_mode": {
+ "description": "Defines how he newly computed score is combined with the score of the query\n\nSupported values include:\n - `multiply`: Query score and function score are multiplied\n - `replace`: Only the function score is used.\nThe query score is ignored.\n - `sum`: Query score and function score are added\n - `avg`: Query score and function score are averaged\n - `max`: Max of query score and function score\n - `min`: Min of query score and function score\n\n",
+ "default": "multiply",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.FunctionBoostMode"
+ }
+ ]
+ },
+ "functions": {
+ "description": "One or more functions that compute a new score for each document returned by the query.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.FunctionScoreContainer"
+ }
+ },
+ "max_boost": {
+ "description": "Restricts the new score to not exceed the provided limit.",
+ "type": "number"
+ },
+ "min_score": {
+ "description": "Excludes documents that do not meet the provided score threshold.",
+ "type": "number"
+ },
+ "query": {
+ "description": "A query that determines the documents for which a new score is computed.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "score_mode": {
+ "description": "Specifies how the computed scores are combined\n\nSupported values include:\n - `multiply`: Scores are multiplied.\n - `sum`: Scores are summed.\n - `avg`: Scores are averaged.\n - `first`: The first function that has a matching filter is applied.\n - `max`: Maximum score is used.\n - `min`: Minimum score is used.\n\n",
+ "default": "multiply",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.FunctionScoreMode"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.query_dsl.FunctionBoostMode": {
+ "type": "string",
+ "enum": [
+ "multiply",
+ "replace",
+ "sum",
+ "avg",
+ "max",
+ "min"
+ ]
+ },
+ "_types.query_dsl.FunctionScoreContainer": {
+ "allOf": [
+ {
+ "type": "object",
+ "properties": {
+ "filter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "weight": {
+ "type": "number"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "properties": {
+ "exp": {
+ "description": "Function that scores a document with a exponential decay, depending on the distance of a numeric field value of the document from an origin.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.DecayFunction"
+ }
+ ]
+ },
+ "gauss": {
+ "description": "Function that scores a document with a normal decay, depending on the distance of a numeric field value of the document from an origin.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.DecayFunction"
+ }
+ ]
+ },
+ "linear": {
+ "description": "Function that scores a document with a linear decay, depending on the distance of a numeric field value of the document from an origin.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.DecayFunction"
+ }
+ ]
+ },
+ "field_value_factor": {
+ "description": "Function allows you to use a field from a document to influence the score.\nIt’s similar to using the script_score function, however, it avoids the overhead of scripting.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.FieldValueFactorScoreFunction"
+ }
+ ]
+ },
+ "random_score": {
+ "description": "Generates scores that are uniformly distributed from 0 up to but not including 1.\nIn case you want scores to be reproducible, it is possible to provide a `seed` and `field`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.RandomScoreFunction"
+ }
+ ]
+ },
+ "script_score": {
+ "description": "Enables you to wrap another query and customize the scoring of it optionally with a computation derived from other numeric field values in the doc using a script expression.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.ScriptScoreFunction"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ }
+ ]
+ },
+ "_types.query_dsl.DecayFunction": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.UntypedDecayFunction"
+ },
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.DateDecayFunction"
+ },
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.NumericDecayFunction"
+ },
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.GeoDecayFunction"
+ }
+ ]
+ },
+ "_types.query_dsl.UntypedDecayFunction": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.DecayFunctionBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.query_dsl.DecayFunctionBase": {
+ "type": "object",
+ "properties": {
+ "multi_value_mode": {
+ "description": "Determines how the distance is calculated when a field used for computing the decay contains multiple values.\n\nSupported values include:\n - `min`: Distance is the minimum distance.\n - `max`: Distance is the maximum distance.\n - `avg`: Distance is the average distance.\n - `sum`: Distance is the sum of all distances.\n\n",
+ "default": "min",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.MultiValueMode"
+ }
+ ]
+ }
+ }
+ },
+ "_types.query_dsl.MultiValueMode": {
+ "type": "string",
+ "enum": [
+ "min",
+ "max",
+ "avg",
+ "sum"
+ ]
+ },
+ "_types.query_dsl.DateDecayFunction": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.DecayFunctionBaseDateMathDuration"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.query_dsl.DecayFunctionBaseDateMathDuration": {
+ "type": "object",
+ "properties": {
+ "multi_value_mode": {
+ "description": "Determines how the distance is calculated when a field used for computing the decay contains multiple values.\n\nSupported values include:\n - `min`: Distance is the minimum distance.\n - `max`: Distance is the maximum distance.\n - `avg`: Distance is the average distance.\n - `sum`: Distance is the sum of all distances.\n\n",
+ "default": "min",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.MultiValueMode"
+ }
+ ]
+ }
+ }
+ },
+ "_types.query_dsl.NumericDecayFunction": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.DecayFunctionBasedoubledouble"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.query_dsl.DecayFunctionBasedoubledouble": {
+ "type": "object",
+ "properties": {
+ "multi_value_mode": {
+ "description": "Determines how the distance is calculated when a field used for computing the decay contains multiple values.\n\nSupported values include:\n - `min`: Distance is the minimum distance.\n - `max`: Distance is the maximum distance.\n - `avg`: Distance is the average distance.\n - `sum`: Distance is the sum of all distances.\n\n",
+ "default": "min",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.MultiValueMode"
+ }
+ ]
+ }
+ }
+ },
+ "_types.query_dsl.GeoDecayFunction": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.DecayFunctionBaseGeoLocationDistance"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.query_dsl.DecayFunctionBaseGeoLocationDistance": {
+ "type": "object",
+ "properties": {
+ "multi_value_mode": {
+ "description": "Determines how the distance is calculated when a field used for computing the decay contains multiple values.\n\nSupported values include:\n - `min`: Distance is the minimum distance.\n - `max`: Distance is the maximum distance.\n - `avg`: Distance is the average distance.\n - `sum`: Distance is the sum of all distances.\n\n",
+ "default": "min",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.MultiValueMode"
+ }
+ ]
+ }
+ }
+ },
+ "_types.query_dsl.FieldValueFactorScoreFunction": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "Field to be extracted from the document.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "factor": {
+ "description": "Optional factor to multiply the field value with.",
+ "default": 1.0,
+ "type": "number"
+ },
+ "missing": {
+ "description": "Value used if the document doesn’t have that field.\nThe modifier and factor are still applied to it as though it were read from the document.",
+ "type": "number"
+ },
+ "modifier": {
+ "description": "Modifier to apply to the field value.\n\nSupported values include:\n - `none`: Do not apply any multiplier to the field value.\n - `log`: Take the common logarithm of the field value.\nBecause this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to use `log1p` instead.\n - `log1p`: Add 1 to the field value and take the common logarithm.\n - `log2p`: Add 2 to the field value and take the common logarithm.\n - `ln`: Take the natural logarithm of the field value.\nBecause this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to use `ln1p` instead.\n - `ln1p`: Add 1 to the field value and take the natural logarithm.\n - `ln2p`: Add 2 to the field value and take the natural logarithm.\n - `square`: Square the field value (multiply it by itself).\n - `sqrt`: Take the square root of the field value.\n - `reciprocal`: Reciprocate the field value, same as `1/x` where `x` is the field’s value.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.FieldValueFactorModifier"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field"
+ ]
+ },
+ "_types.query_dsl.FieldValueFactorModifier": {
+ "type": "string",
+ "enum": [
+ "none",
+ "log",
+ "log1p",
+ "log2p",
+ "ln",
+ "ln1p",
+ "ln2p",
+ "square",
+ "sqrt",
+ "reciprocal"
+ ]
+ },
+ "_types.query_dsl.RandomScoreFunction": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "seed": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "_types.query_dsl.ScriptScoreFunction": {
+ "type": "object",
+ "properties": {
+ "script": {
+ "description": "A script that computes a score.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ }
+ },
+ "required": [
+ "script"
+ ]
+ },
+ "_types.Script": {
+ "type": "object",
+ "properties": {
+ "source": {
+ "description": "The script source.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScriptSource"
+ }
+ ]
+ },
+ "id": {
+ "description": "The `id` for a stored script.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "params": {
+ "description": "Specifies any named parameters that are passed into the script as variables.\nUse parameters instead of hard-coded values to decrease compile time.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "lang": {
+ "description": "Specifies the language the script is written in.\n\nSupported values include:\n - `painless`: Painless scripting language, purpose-built for Elasticsearch.\n - `expression`: Lucene’s expressions language, compiles a JavaScript expression to bytecode.\n - `mustache`: Mustache templated, used for templates.\n - `java`: Expert Java API\n\n",
+ "default": "painless",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScriptLanguage"
+ }
+ ]
+ },
+ "options": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "_types.ScriptSource": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/_global.search._types.SearchRequestBody"
+ }
+ ]
+ },
+ "_global.search._types.SearchRequestBody": {
+ "type": "object",
+ "properties": {
+ "aggregations": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/explore-analyze/query-filter/aggregations"
+ },
+ "description": "Defines the aggregations that are run as part of the search request.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.AggregationContainer"
+ }
+ },
+ "collapse": {
+ "description": "Collapses search results the values of the specified field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.FieldCollapse"
+ }
+ ]
+ },
+ "explain": {
+ "description": "If `true`, the request returns detailed information about score computation as part of a hit.",
+ "default": false,
+ "type": "boolean"
+ },
+ "ext": {
+ "description": "Configuration of search extensions defined by Elasticsearch plugins.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "from": {
+ "description": "The starting document offset, which must be non-negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "highlight": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/highlighting"
+ },
+ "description": "Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.Highlight"
+ }
+ ]
+ },
+ "track_total_hits": {
+ "description": "Number of hits matching the query to count accurately.\nIf `true`, the exact number of hits is returned at the cost of some performance.\nIf `false`, the response does not include the total number of hits matching the query.",
+ "default": "10000",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.TrackHits"
+ }
+ ]
+ },
+ "indices_boost": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl#relevance-scores"
+ },
+ "description": "Boost the `_score` of documents from specified indices.\nThe boost value is the factor by which scores are multiplied.\nA boost value greater than `1.0` increases the score.\nA boost value between `0` and `1.0` decreases the score.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "number"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ }
+ },
+ "docvalue_fields": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#docvalue-fields"
+ },
+ "description": "An array of wildcard (`*`) field patterns.\nThe request returns doc values for field names matching these patterns in the `hits.fields` property of the response.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
+ }
+ },
+ "knn": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/solutions/search/vector/knn#approximate-knn"
+ },
+ "description": "The approximate kNN search to run.",
+ "x-state": "Generally available",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.KnnSearch"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.KnnSearch"
+ }
+ }
+ ]
+ },
+ "min_score": {
+ "description": "The minimum `_score` for matching documents.\nDocuments with a lower `_score` are not included in search results or results collected by aggregations.",
+ "type": "number"
+ },
+ "post_filter": {
+ "description": "Use the `post_filter` parameter to filter search results.\nThe search hits are filtered after the aggregations are calculated.\nA post filter has no impact on the aggregation results.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "profile": {
+ "description": "Set to `true` to return detailed timing information about the execution of individual components in a search request.\nNOTE: This is a debugging tool and adds significant overhead to search execution.",
+ "default": false,
+ "type": "boolean"
+ },
+ "query": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl"
+ },
+ "description": "The search definition using the Query DSL.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "rescore": {
+ "description": "Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.Rescore"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.Rescore"
+ }
+ }
+ ]
+ },
+ "retriever": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrievers"
+ },
+ "description": "A retriever is a specification to describe top documents returned from a search.\nA retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RetrieverContainer"
+ }
+ ]
+ },
+ "script_fields": {
+ "description": "Retrieve a script evaluation (based on different fields) for each hit.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.ScriptField"
+ }
+ },
+ "search_after": {
+ "description": "Used to retrieve the next page of hits using a set of sort values from the previous page.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SortResults"
+ }
+ ]
+ },
+ "size": {
+ "description": "The number of hits to return, which must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` property.",
+ "default": 10.0,
+ "type": "number"
+ },
+ "slice": {
+ "description": "Split a scrolled search into multiple slices that can be consumed independently.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SlicedScroll"
+ }
+ ]
+ },
+ "sort": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results"
+ },
+ "description": "A comma-separated list of : pairs.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Sort"
+ }
+ ]
+ },
+ "_source": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#source-filtering"
+ },
+ "description": "The source fields that are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nIf the `stored_fields` property is specified, the `_source` property defaults to `false`.\nOtherwise, it defaults to `true`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.SourceConfig"
+ }
+ ]
+ },
+ "fields": {
+ "description": "An array of wildcard (`*`) field patterns.\nThe request returns values for field names matching these patterns in the `hits.fields` property of the response.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
+ }
+ },
+ "suggest": {
+ "description": "Defines a suggester that provides similar looking terms based on a provided text.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.Suggester"
+ }
+ ]
+ },
+ "terminate_after": {
+ "description": "The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this property to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this property for requests that target data streams with backing indices across multiple data tiers.\n\nIf set to `0` (default), the query does not terminate early.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "timeout": {
+ "description": "The period of time to wait for a response from each shard.\nIf no response is received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.",
+ "type": "string"
+ },
+ "track_scores": {
+ "description": "If `true`, calculate and return document scores, even if the scores are not used for sorting.",
+ "default": false,
+ "type": "boolean"
+ },
+ "version": {
+ "description": "If `true`, the request returns the document version as part of a hit.",
+ "default": false,
+ "type": "boolean"
+ },
+ "seq_no_primary_term": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control"
+ },
+ "description": "If `true`, the request returns sequence number and primary term of the last modification of each hit.",
+ "type": "boolean"
+ },
+ "stored_fields": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#stored-fields"
+ },
+ "description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` property defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ },
+ "pit": {
+ "description": "Limit the search to a point in time (PIT).\nIf you provide a PIT, you cannot specify an `` in the request path.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.PointInTimeReference"
+ }
+ ]
+ },
+ "runtime_mappings": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/manage-data/data-store/mapping/define-runtime-fields-in-search-request"
+ },
+ "description": "One or more runtime fields in the search request.\nThese fields take precedence over mapped fields with the same name.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RuntimeFields"
+ }
+ ]
+ },
+ "stats": {
+ "description": "The stats groups to associate with the search.\nEach group maintains a statistics aggregation for its associated searches.\nYou can retrieve these stats using the indices stats API.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "_global.search._types.FieldCollapse": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The field to collapse the result set on",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "inner_hits": {
+ "description": "The number of inner hits and their sort order",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.InnerHits"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.InnerHits"
+ }
+ }
+ ]
+ },
+ "max_concurrent_group_searches": {
+ "description": "The number of concurrent requests allowed to retrieve the inner_hits per group",
+ "type": "number"
+ },
+ "collapse": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.FieldCollapse"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field"
+ ]
+ },
+ "_global.search._types.InnerHits": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name for the particular inner hit definition in the response.\nUseful when a search request contains multiple inner hits.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "size": {
+ "description": "The maximum number of hits to return per `inner_hits`.",
+ "default": 3.0,
+ "type": "number"
+ },
+ "from": {
+ "description": "Inner hit starting document offset.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "collapse": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.FieldCollapse"
+ }
+ ]
+ },
+ "docvalue_fields": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
+ }
+ },
+ "explain": {
+ "type": "boolean"
+ },
+ "highlight": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.Highlight"
+ }
+ ]
+ },
+ "ignore_unmapped": {
+ "type": "boolean"
+ },
+ "script_fields": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.ScriptField"
+ }
+ },
+ "seq_no_primary_term": {
+ "type": "boolean"
+ },
+ "fields": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ },
+ "sort": {
+ "description": "How the inner hits should be sorted per `inner_hits`.\nBy default, inner hits are sorted by score.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Sort"
+ }
+ ]
+ },
+ "_source": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.SourceConfig"
+ }
+ ]
+ },
+ "stored_fields": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ },
+ "track_scores": {
+ "default": false,
+ "type": "boolean"
+ },
+ "version": {
+ "type": "boolean"
+ }
+ }
+ },
+ "_types.Name": {
+ "type": "string"
+ },
+ "_types.query_dsl.FieldAndFormat": {
+ "description": "A reference to a field with formatting instructions on how to return the value",
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "A wildcard pattern. The request returns values for field names matching this pattern.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "format": {
+ "description": "The format in which the values are returned.",
+ "type": "string"
+ },
+ "include_unmapped": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "field"
+ ]
+ },
+ "_global.search._types.Highlight": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.HighlightBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "encoder": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.HighlighterEncoder"
+ }
+ ]
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_global.search._types.HighlightField"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_global.search._types.HighlightField"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ }
+ }
+ ]
+ }
+ },
+ "required": [
+ "fields"
+ ]
+ }
+ ]
+ },
+ "_global.search._types.HighlighterEncoder": {
+ "type": "string",
+ "enum": [
+ "default",
+ "html"
+ ]
+ },
+ "_global.search._types.HighlightField": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.HighlightBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "fragment_offset": {
+ "type": "number"
+ },
+ "matched_fields": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_global.search._types.HighlightBase": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "\n\nSupported values include:\n - `plain`: The `plain` highlighter uses the standard Lucene highlighter\n - `fvh`: The fvh highlighter uses the Lucene Fast Vector highlighter.\n - `unified`: The unified highlighter uses the Lucene Unified Highlighter.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.HighlighterType"
+ }
+ ]
+ },
+ "boundary_chars": {
+ "description": "A string that contains each boundary character.",
+ "default": ".,!? \\t\\n",
+ "type": "string"
+ },
+ "boundary_max_scan": {
+ "description": "How far to scan for boundary characters.",
+ "default": 20.0,
+ "type": "number"
+ },
+ "boundary_scanner": {
+ "description": "Specifies how to break the highlighted fragments: chars, sentence, or word.\nOnly valid for the unified and fvh highlighters.\nDefaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter.\n\nSupported values include:\n - `chars`: Use the characters specified by `boundary_chars` as highlighting boundaries.\nThe `boundary_max_scan` setting controls how far to scan for boundary characters.\nOnly valid for the `fvh` highlighter.\n - `sentence`: Break highlighted fragments at the next sentence boundary, as determined by Java’s `BreakIterator`.\nYou can specify the locale to use with `boundary_scanner_locale`.\nWhen used with the `unified` highlighter, the `sentence` scanner splits sentences bigger than `fragment_size` at the first word boundary next to fragment_size.\nYou can set `fragment_size` to `0` to never split any sentence.\n - `word`: Break highlighted fragments at the next word boundary, as determined by Java’s `BreakIterator`.\nYou can specify the locale to use with `boundary_scanner_locale`.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.BoundaryScanner"
+ }
+ ]
+ },
+ "boundary_scanner_locale": {
+ "description": "Controls which locale is used to search for sentence and word boundaries.\nThis parameter takes a form of a language tag, for example: `\"en-US\"`, `\"fr-FR\"`, `\"ja-JP\"`.",
+ "default": "Locale.ROOT",
+ "type": "string"
+ },
+ "force_source": {
+ "deprecated": true,
+ "type": "boolean"
+ },
+ "fragmenter": {
+ "description": "Specifies how text should be broken up in highlight snippets: `simple` or `span`.\nOnly valid for the `plain` highlighter.",
+ "default": "span",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.HighlighterFragmenter"
+ }
+ ]
+ },
+ "fragment_size": {
+ "description": "The size of the highlighted fragment in characters.",
+ "default": 100.0,
+ "type": "number"
+ },
+ "highlight_filter": {
+ "type": "boolean"
+ },
+ "highlight_query": {
+ "description": "Highlight matches for a query other than the search query.\nThis is especially useful if you use a rescore query because those are not taken into account by highlighting by default.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "max_fragment_length": {
+ "type": "number"
+ },
+ "max_analyzed_offset": {
+ "description": "If set to a non-negative value, highlighting stops at this defined maximum limit.\nThe rest of the text is not processed, thus not highlighted and no error is returned\nThe `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting.",
+ "type": "number"
+ },
+ "no_match_size": {
+ "description": "The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "number_of_fragments": {
+ "description": "The maximum number of fragments to return.\nIf the number of fragments is set to `0`, no fragments are returned.\nInstead, the entire field contents are highlighted and returned.\nThis can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required.\nIf `number_of_fragments` is `0`, `fragment_size` is ignored.",
+ "default": 5.0,
+ "type": "number"
+ },
+ "options": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "order": {
+ "description": "Sorts highlighted fragments by score when set to `score`.\nBy default, fragments will be output in the order they appear in the field (order: `none`).\nSetting this option to `score` will output the most relevant fragments first.\nEach highlighter applies its own logic to compute relevancy scores.",
+ "default": "none",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.HighlighterOrder"
+ }
+ ]
+ },
+ "phrase_limit": {
+ "description": "Controls the number of matching phrases in a document that are considered.\nPrevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory.\nWhen using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory.\nOnly supported by the `fvh` highlighter.",
+ "default": 256.0,
+ "type": "number"
+ },
+ "post_tags": {
+ "description": "Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text.\nBy default, highlighted text is wrapped in `` and `` tags.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "pre_tags": {
+ "description": "Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text.\nBy default, highlighted text is wrapped in `` and `` tags.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "require_field_match": {
+ "description": "By default, only fields that contains a query match are highlighted.\nSet to `false` to highlight all fields.",
+ "default": true,
+ "type": "boolean"
+ },
+ "tags_schema": {
+ "description": "Set to `styled` to use the built-in tag schema.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.HighlighterTagsSchema"
+ }
+ ]
+ }
+ }
+ },
+ "_global.search._types.HighlighterType": {
+ "anyOf": [
+ {
+ "type": "string",
+ "enum": [
+ "plain",
+ "fvh",
+ "unified"
+ ]
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "_global.search._types.BoundaryScanner": {
+ "type": "string",
+ "enum": [
+ "chars",
+ "sentence",
+ "word"
+ ]
+ },
+ "_global.search._types.HighlighterFragmenter": {
+ "type": "string",
+ "enum": [
+ "simple",
+ "span"
+ ]
+ },
+ "_global.search._types.HighlighterOrder": {
+ "type": "string",
+ "enum": [
+ "score"
+ ]
+ },
+ "_global.search._types.HighlighterTagsSchema": {
+ "type": "string",
+ "enum": [
+ "styled"
+ ]
+ },
+ "_types.ScriptField": {
+ "type": "object",
+ "properties": {
+ "script": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "ignore_failure": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "script"
+ ]
+ },
+ "_types.Sort": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.SortCombinations"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.SortCombinations"
+ }
+ }
+ ]
+ },
+ "_types.SortCombinations": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ },
+ {
+ "$ref": "#/components/schemas/_types.SortOptions"
+ }
+ ]
+ },
+ "_types.SortOptions": {
+ "type": "object",
+ "properties": {
+ "_score": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScoreSort"
+ }
+ ]
+ },
+ "_doc": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScoreSort"
+ }
+ ]
+ },
+ "_geo_distance": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoDistanceSort"
+ }
+ ]
+ },
+ "_script": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScriptSort"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "_types.ScoreSort": {
+ "type": "object",
+ "properties": {
+ "order": {
+ "description": "\n\nSupported values include:\n - `asc`: Ascending (smallest to largest)\n - `desc`: Descending (largest to smallest)\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SortOrder"
+ }
+ ]
+ }
+ }
+ },
+ "_types.SortOrder": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ },
+ "_types.GeoDistanceSort": {
+ "type": "object",
+ "properties": {
+ "mode": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SortMode"
+ }
+ ]
+ },
+ "distance_type": {
+ "description": "\n\nSupported values include:\n - `arc`: The `arc` calculation is the most accurate.\n - `plane`: The `plane` calculation is faster but less accurate.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoDistanceType"
+ }
+ ]
+ },
+ "ignore_unmapped": {
+ "type": "boolean"
+ },
+ "order": {
+ "description": "\n\nSupported values include:\n - `asc`: Ascending (smallest to largest)\n - `desc`: Descending (largest to smallest)\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SortOrder"
+ }
+ ]
+ },
+ "unit": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DistanceUnit"
+ }
+ ]
+ },
+ "nested": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.NestedSortValue"
+ }
+ ]
+ }
+ }
+ },
+ "_types.SortMode": {
+ "type": "string",
+ "enum": [
+ "min",
+ "max",
+ "sum",
+ "avg",
+ "median"
+ ]
+ },
+ "_types.GeoDistanceType": {
+ "type": "string",
+ "enum": [
+ "arc",
+ "plane"
+ ]
+ },
+ "_types.DistanceUnit": {
+ "type": "string",
+ "enum": [
+ "in",
+ "ft",
+ "yd",
+ "mi",
+ "nmi",
+ "km",
+ "m",
+ "cm",
+ "mm"
+ ]
+ },
+ "_types.NestedSortValue": {
+ "type": "object",
+ "properties": {
+ "filter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "max_children": {
+ "type": "number"
+ },
+ "nested": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.NestedSortValue"
+ }
+ ]
+ },
+ "path": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "path"
+ ]
+ },
+ "_types.ScriptSort": {
+ "type": "object",
+ "properties": {
+ "order": {
+ "description": "\n\nSupported values include:\n - `asc`: Ascending (smallest to largest)\n - `desc`: Descending (largest to smallest)\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SortOrder"
+ }
+ ]
+ },
+ "script": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScriptSortType"
+ }
+ ]
+ },
+ "mode": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SortMode"
+ }
+ ]
+ },
+ "nested": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.NestedSortValue"
+ }
+ ]
+ }
+ },
+ "required": [
+ "script"
+ ]
+ },
+ "_types.ScriptSortType": {
+ "type": "string",
+ "enum": [
+ "string",
+ "number",
+ "version"
+ ]
+ },
+ "_global.search._types.SourceConfig": {
+ "description": "Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.",
+ "oneOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "$ref": "#/components/schemas/_global.search._types.SourceFilter"
+ }
+ ]
+ },
+ "_global.search._types.SourceFilter": {
+ "type": "object",
+ "properties": {
+ "exclude_vectors": {
+ "description": "If `true`, vector fields are excluded from the returned source.\n\nThis option takes precedence over `includes`: any vector field will\nremain excluded even if it matches an `includes` rule.",
+ "type": "boolean"
+ },
+ "excludes": {
+ "description": "A list of fields to exclude from the returned source.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ },
+ "includes": {
+ "description": "A list of fields to include in the returned source.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ }
+ }
+ },
+ "_types.KnnSearch": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The name of the vector field to search against",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "query_vector": {
+ "description": "The query vector",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.QueryVector"
+ }
+ ]
+ },
+ "query_vector_builder": {
+ "description": "The query vector builder. You must provide a query_vector_builder or query_vector, but not both.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.QueryVectorBuilder"
+ }
+ ]
+ },
+ "k": {
+ "description": "The final number of nearest neighbors to return as top hits",
+ "type": "number"
+ },
+ "num_candidates": {
+ "description": "The number of nearest neighbor candidates to consider per shard",
+ "type": "number"
+ },
+ "boost": {
+ "description": "Boost value to apply to kNN scores",
+ "type": "number"
+ },
+ "filter": {
+ "description": "Filters for the kNN search query",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ }
+ ]
+ },
+ "similarity": {
+ "description": "The minimum similarity for a vector to be considered a match",
+ "type": "number"
+ },
+ "inner_hits": {
+ "description": "If defined, each search hit will contain inner hits.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.InnerHits"
+ }
+ ]
+ },
+ "rescore_vector": {
+ "description": "Apply oversampling and rescoring to quantized vectors",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RescoreVector"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field"
+ ]
+ },
+ "_types.QueryVector": {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ },
+ "_types.QueryVectorBuilder": {
+ "type": "object",
+ "properties": {
+ "text_embedding": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.TextEmbedding"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "_types.TextEmbedding": {
+ "type": "object",
+ "properties": {
+ "model_id": {
+ "type": "string"
+ },
+ "model_text": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "model_id",
+ "model_text"
+ ]
+ },
+ "_types.RescoreVector": {
+ "type": "object",
+ "properties": {
+ "oversample": {
+ "description": "Applies the specified oversample factor to k on the approximate kNN search",
+ "type": "number"
+ }
+ },
+ "required": [
+ "oversample"
+ ]
+ },
+ "_global.search._types.Rescore": {
+ "allOf": [
+ {
+ "type": "object",
+ "properties": {
+ "window_size": {
+ "type": "number"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "properties": {
+ "query": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.RescoreQuery"
+ }
+ ]
+ },
+ "learning_to_rank": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.LearningToRank"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ }
+ ]
+ },
+ "_global.search._types.RescoreQuery": {
+ "type": "object",
+ "properties": {
+ "rescore_query": {
+ "description": "The query to use for rescoring.\nThis query is only run on the Top-K results returned by the `query` and `post_filter` phases.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "query_weight": {
+ "description": "Relative importance of the original query versus the rescore query.",
+ "default": 1.0,
+ "type": "number"
+ },
+ "rescore_query_weight": {
+ "description": "Relative importance of the rescore query versus the original query.",
+ "default": 1.0,
+ "type": "number"
+ },
+ "score_mode": {
+ "description": "Determines how scores are combined.\n\nSupported values include:\n - `avg`: Average the original score and the rescore query score.\n - `max`: Take the max of original score and the rescore query score.\n - `min`: Take the min of the original score and the rescore query score.\n - `multiply`: Multiply the original score by the rescore query score.\nUseful for `function` query rescores.\n - `total`: Add the original score and the rescore query score.\n\n",
+ "default": "total",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.ScoreMode"
+ }
+ ]
+ }
+ },
+ "required": [
+ "rescore_query"
+ ]
+ },
+ "_global.search._types.ScoreMode": {
+ "type": "string",
+ "enum": [
+ "avg",
+ "max",
+ "min",
+ "multiply",
+ "total"
+ ]
+ },
+ "_global.search._types.LearningToRank": {
+ "type": "object",
+ "properties": {
+ "model_id": {
+ "description": "The unique identifier of the trained model uploaded to Elasticsearch",
+ "type": "string"
+ },
+ "params": {
+ "description": "Named parameters to be passed to the query templates used for feature",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "required": [
+ "model_id"
+ ]
+ },
+ "_types.RetrieverContainer": {
+ "type": "object",
+ "properties": {
+ "standard": {
+ "description": "A retriever that replaces the functionality of a traditional query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.StandardRetriever"
+ }
+ ]
+ },
+ "knn": {
+ "description": "A retriever that replaces the functionality of a knn search.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.KnnRetriever"
+ }
+ ]
+ },
+ "rrf": {
+ "description": "A retriever that produces top documents from reciprocal rank fusion (RRF).",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RRFRetriever"
+ }
+ ]
+ },
+ "text_similarity_reranker": {
+ "description": "A retriever that reranks the top documents based on a reranking model using the InferenceAPI",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.TextSimilarityReranker"
+ }
+ ]
+ },
+ "rule": {
+ "description": "A retriever that replaces the functionality of a rule query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RuleRetriever"
+ }
+ ]
+ },
+ "rescorer": {
+ "description": "A retriever that re-scores only the results produced by its child retriever.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RescorerRetriever"
+ }
+ ]
+ },
+ "linear": {
+ "description": "A retriever that supports the combination of different retrievers through a weighted linear combination.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.LinearRetriever"
+ }
+ ]
+ },
+ "pinned": {
+ "description": "A pinned retriever applies pinned documents to the underlying retriever.\nThis retriever will rewrite to a PinnedQueryBuilder.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.PinnedRetriever"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "_types.StandardRetriever": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RetrieverBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "query": {
+ "description": "Defines a query to retrieve a set of top documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "search_after": {
+ "description": "Defines a search after object parameter used for pagination.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SortResults"
+ }
+ ]
+ },
+ "terminate_after": {
+ "description": "Maximum number of documents to collect for each shard.",
+ "type": "number"
+ },
+ "sort": {
+ "description": "A sort object that that specifies the order of matching documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Sort"
+ }
+ ]
+ },
+ "collapse": {
+ "description": "Collapses the top documents by a specified key into a single top document per key.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.FieldCollapse"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.RetrieverBase": {
+ "type": "object",
+ "properties": {
+ "filter": {
+ "description": "Query to filter the documents that can match.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ }
+ ]
+ },
+ "min_score": {
+ "description": "Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.",
+ "type": "number"
+ },
+ "_name": {
+ "description": "Retriever name.",
+ "type": "string"
+ }
+ }
+ },
+ "_types.KnnRetriever": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RetrieverBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The name of the vector field to search against.",
+ "type": "string"
+ },
+ "query_vector": {
+ "description": "Query vector. Must have the same number of dimensions as the vector field you are searching against. You must provide a query_vector_builder or query_vector, but not both.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.QueryVector"
+ }
+ ]
+ },
+ "query_vector_builder": {
+ "description": "Defines a model to build a query vector.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.QueryVectorBuilder"
+ }
+ ]
+ },
+ "k": {
+ "description": "Number of nearest neighbors to return as top hits.",
+ "type": "number"
+ },
+ "num_candidates": {
+ "description": "Number of nearest neighbor candidates to consider per shard.",
+ "type": "number"
+ },
+ "similarity": {
+ "description": "The minimum similarity required for a document to be considered a match.",
+ "type": "number"
+ },
+ "rescore_vector": {
+ "description": "Apply oversampling and rescoring to quantized vectors",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RescoreVector"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field",
+ "k",
+ "num_candidates"
+ ]
+ }
+ ]
+ },
+ "_types.RRFRetriever": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RetrieverBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "retrievers": {
+ "description": "A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.RetrieverContainer"
+ }
+ },
+ "rank_constant": {
+ "description": "This value determines how much influence documents in individual result sets per query have over the final ranked result set.",
+ "type": "number"
+ },
+ "rank_window_size": {
+ "description": "This value determines the size of the individual result sets per query.",
+ "type": "number"
+ },
+ "query": {
+ "type": "string"
+ },
+ "fields": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "retrievers"
+ ]
+ }
+ ]
+ },
+ "_types.TextSimilarityReranker": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RetrieverBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "retriever": {
+ "description": "The nested retriever which will produce the first-level results, that will later be used for reranking.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RetrieverContainer"
+ }
+ ]
+ },
+ "rank_window_size": {
+ "description": "This value determines how many documents we will consider from the nested retriever.",
+ "type": "number"
+ },
+ "inference_id": {
+ "description": "Unique identifier of the inference endpoint created using the inference API.",
+ "type": "string"
+ },
+ "inference_text": {
+ "description": "The text snippet used as the basis for similarity comparison",
+ "type": "string"
+ },
+ "field": {
+ "description": "The document field to be used for text similarity comparisons. This field should contain the text that will be evaluated against the inference_text",
+ "type": "string"
+ }
+ },
+ "required": [
+ "retriever",
+ "inference_text",
+ "field"
+ ]
+ }
+ ]
+ },
+ "_types.RuleRetriever": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RetrieverBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "ruleset_ids": {
+ "description": "The ruleset IDs containing the rules this retriever is evaluating against.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ }
+ ]
+ },
+ "match_criteria": {
+ "description": "The match criteria that will determine if a rule in the provided rulesets should be applied.",
+ "type": "object"
+ },
+ "retriever": {
+ "description": "The retriever whose results rules should be applied to.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RetrieverContainer"
+ }
+ ]
+ },
+ "rank_window_size": {
+ "description": "This value determines the size of the individual result set.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "ruleset_ids",
+ "match_criteria",
+ "retriever"
+ ]
+ }
+ ]
+ },
+ "_types.RescorerRetriever": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RetrieverBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "retriever": {
+ "description": "Inner retriever.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RetrieverContainer"
+ }
+ ]
+ },
+ "rescore": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.Rescore"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.Rescore"
+ }
+ }
+ ]
+ }
+ },
+ "required": [
+ "retriever",
+ "rescore"
+ ]
+ }
+ ]
+ },
+ "_types.LinearRetriever": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RetrieverBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "retrievers": {
+ "description": "Inner retrievers.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.InnerRetriever"
+ }
+ },
+ "rank_window_size": {
+ "type": "number"
+ },
+ "query": {
+ "type": "string"
+ },
+ "fields": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "normalizer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScoreNormalizer"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.InnerRetriever": {
+ "type": "object",
+ "properties": {
+ "retriever": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RetrieverContainer"
+ }
+ ]
+ },
+ "weight": {
+ "type": "number"
+ },
+ "normalizer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScoreNormalizer"
+ }
+ ]
+ }
+ },
+ "required": [
+ "retriever",
+ "weight",
+ "normalizer"
+ ]
+ },
+ "_types.ScoreNormalizer": {
+ "type": "string",
+ "enum": [
+ "none",
+ "minmax",
+ "l2_norm"
+ ]
+ },
+ "_types.PinnedRetriever": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RetrieverBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "retriever": {
+ "description": "Inner retriever.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RetrieverContainer"
+ }
+ ]
+ },
+ "ids": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "docs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.SpecifiedDocument"
+ }
+ },
+ "rank_window_size": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "retriever"
+ ]
+ }
+ ]
+ },
+ "_types.SpecifiedDocument": {
+ "type": "object",
+ "properties": {
+ "index": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "_types.SlicedScroll": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "max": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "id",
+ "max"
+ ]
+ },
+ "_global.search._types.Suggester": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "description": "Global suggest text, to avoid repetition when the same text is used in several suggesters",
+ "type": "string"
+ }
+ }
+ },
+ "_global.search._types.PointInTimeReference": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "keep_alive": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "_types.mapping.RuntimeFields": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.mapping.RuntimeField"
+ }
+ },
+ "_types.mapping.RuntimeField": {
+ "type": "object",
+ "properties": {
+ "fields": {
+ "description": "For type `composite`",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.mapping.CompositeSubField"
+ }
+ },
+ "fetch_fields": {
+ "description": "For type `lookup`",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.mapping.RuntimeFieldFetchFields"
+ }
+ },
+ "format": {
+ "description": "A custom format for `date` type runtime fields.",
+ "type": "string"
+ },
+ "input_field": {
+ "description": "For type `lookup`",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "target_field": {
+ "description": "For type `lookup`",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "target_index": {
+ "description": "For type `lookup`",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "script": {
+ "description": "Painless script executed at query time.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "type": {
+ "description": "Field type, which can be: `boolean`, `composite`, `date`, `double`, `geo_point`, `ip`,`keyword`, `long`, or `lookup`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RuntimeFieldType"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.mapping.CompositeSubField": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RuntimeFieldType"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.mapping.RuntimeFieldType": {
+ "type": "string",
+ "enum": [
+ "boolean",
+ "composite",
+ "date",
+ "double",
+ "geo_point",
+ "geo_shape",
+ "ip",
+ "keyword",
+ "long",
+ "lookup"
+ ]
+ },
+ "_types.mapping.RuntimeFieldFetchFields": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "format": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "field"
+ ]
+ },
+ "_types.ScriptLanguage": {
+ "anyOf": [
+ {
+ "type": "string",
+ "enum": [
+ "painless",
+ "expression",
+ "mustache",
+ "java"
+ ]
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "_types.query_dsl.FunctionScoreMode": {
+ "type": "string",
+ "enum": [
+ "multiply",
+ "sum",
+ "avg",
+ "first",
+ "max",
+ "min"
+ ]
+ },
+ "_types.query_dsl.FuzzyQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "max_expansions": {
+ "description": "Maximum number of variations created.",
+ "default": 50.0,
+ "type": "number"
+ },
+ "prefix_length": {
+ "description": "Number of beginning characters left unchanged when creating expansions.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "rewrite": {
+ "description": "Number of beginning characters left unchanged when creating expansions.",
+ "default": "constant_score",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.MultiTermQueryRewrite"
+ }
+ ]
+ },
+ "transpositions": {
+ "description": "Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`).",
+ "default": true,
+ "type": "boolean"
+ },
+ "fuzziness": {
+ "description": "Maximum edit distance allowed for matching.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fuzziness"
+ }
+ ]
+ },
+ "value": {
+ "description": "Term you wish to find in the provided field.",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ }
+ ]
+ }
+ },
+ "required": [
+ "value"
+ ]
+ }
+ ]
+ },
+ "_types.MultiTermQueryRewrite": {
+ "type": "string"
+ },
+ "_types.Fuzziness": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "number"
+ }
+ ]
+ },
+ "_types.query_dsl.GeoBoundingBoxQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "deprecated": true,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.GeoExecution"
+ }
+ ]
+ },
+ "validation_method": {
+ "description": "Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.\nSet to `COERCE` to also try to infer correct latitude or longitude.\n\nSupported values include:\n - `coerce`: Accept geo points with invalid latitude or longitude and additionally try and infer correct coordinates.\n - `ignore_malformed`: Accept geo points with invalid latitude or longitude.\n - `strict`\n\n",
+ "default": "'strict'",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.GeoValidationMethod"
+ }
+ ]
+ },
+ "ignore_unmapped": {
+ "description": "Set to `true` to ignore an unmapped field and not match any documents for this query.\nSet to `false` to throw an exception if the field is not mapped.",
+ "default": false,
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "_types.query_dsl.GeoExecution": {
+ "type": "string",
+ "enum": [
+ "memory",
+ "indexed"
+ ]
+ },
+ "_types.query_dsl.GeoValidationMethod": {
+ "type": "string",
+ "enum": [
+ "coerce",
+ "ignore_malformed",
+ "strict"
+ ]
+ },
+ "_types.query_dsl.GeoDistanceQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "distance": {
+ "description": "The radius of the circle centred on the specified location.\nPoints which fall into this circle are considered to be matches.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Distance"
+ }
+ ]
+ },
+ "distance_type": {
+ "description": "How to compute the distance.\nSet to `plane` for a faster calculation that's inaccurate on long distances and close to the poles.\n\nSupported values include:\n - `arc`: The `arc` calculation is the most accurate.\n - `plane`: The `plane` calculation is faster but less accurate.\n\n",
+ "default": "'arc'",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoDistanceType"
+ }
+ ]
+ },
+ "validation_method": {
+ "description": "Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.\nSet to `COERCE` to also try to infer correct latitude or longitude.\n\nSupported values include:\n - `coerce`: Accept geo points with invalid latitude or longitude and additionally try and infer correct coordinates.\n - `ignore_malformed`: Accept geo points with invalid latitude or longitude.\n - `strict`\n\n",
+ "default": "'strict'",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.GeoValidationMethod"
+ }
+ ]
+ },
+ "ignore_unmapped": {
+ "description": "Set to `true` to ignore an unmapped field and not match any documents for this query.\nSet to `false` to throw an exception if the field is not mapped.",
+ "default": false,
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "distance"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.GeoGridQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "geotile": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoTile"
+ }
+ ]
+ },
+ "geohash": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoHash"
+ }
+ ]
+ },
+ "geohex": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoHexCell"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ }
+ ]
+ },
+ "_types.query_dsl.GeoPolygonQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "validation_method": {
+ "description": "\n\nSupported values include:\n - `coerce`: Accept geo points with invalid latitude or longitude and additionally try and infer correct coordinates.\n - `ignore_malformed`: Accept geo points with invalid latitude or longitude.\n - `strict`\n\n",
+ "default": "'strict'",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.GeoValidationMethod"
+ }
+ ]
+ },
+ "ignore_unmapped": {
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "_types.query_dsl.GeoShapeQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "ignore_unmapped": {
+ "description": "Set to `true` to ignore an unmapped field and not match any documents for this query.\nSet to `false` to throw an exception if the field is not mapped.",
+ "default": false,
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "_types.query_dsl.HasChildQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "ignore_unmapped": {
+ "description": "Indicates whether to ignore an unmapped `type` and not return any documents instead of an error.",
+ "default": false,
+ "type": "boolean"
+ },
+ "inner_hits": {
+ "description": "If defined, each search hit will contain inner hits.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.InnerHits"
+ }
+ ]
+ },
+ "max_children": {
+ "description": "Maximum number of child documents that match the query allowed for a returned parent document.\nIf the parent document exceeds this limit, it is excluded from the search results.",
+ "type": "number"
+ },
+ "min_children": {
+ "description": "Minimum number of child documents that match the query required to match the query for a returned parent document.\nIf the parent document does not meet this limit, it is excluded from the search results.",
+ "type": "number"
+ },
+ "query": {
+ "description": "Query you wish to run on child documents of the `type` field.\nIf a child document matches the search, the query returns the parent document.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "score_mode": {
+ "description": "Indicates how scores for matching child documents affect the root parent document’s relevance score.",
+ "default": "'none'",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.ChildScoreMode"
+ }
+ ]
+ },
+ "type": {
+ "description": "Name of the child relationship mapped for the `join` field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RelationName"
+ }
+ ]
+ }
+ },
+ "required": [
+ "query",
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.ChildScoreMode": {
+ "type": "string",
+ "enum": [
+ "none",
+ "avg",
+ "sum",
+ "max",
+ "min"
+ ]
+ },
+ "_types.RelationName": {
+ "type": "string"
+ },
+ "_types.query_dsl.HasParentQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "ignore_unmapped": {
+ "description": "Indicates whether to ignore an unmapped `parent_type` and not return any documents instead of an error.\nYou can use this parameter to query multiple indices that may not contain the `parent_type`.",
+ "default": false,
+ "type": "boolean"
+ },
+ "inner_hits": {
+ "description": "If defined, each search hit will contain inner hits.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.InnerHits"
+ }
+ ]
+ },
+ "parent_type": {
+ "description": "Name of the parent relationship mapped for the `join` field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RelationName"
+ }
+ ]
+ },
+ "query": {
+ "description": "Query you wish to run on parent documents of the `parent_type` field.\nIf a parent document matches the search, the query returns its child documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "score": {
+ "description": "Indicates whether the relevance score of a matching parent document is aggregated into its child documents.",
+ "default": false,
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "parent_type",
+ "query"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.IdsQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "values": {
+ "description": "An array of document IDs.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Ids"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.Ids": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ }
+ ]
+ },
+ "_types.query_dsl.IntervalsQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-intervals-query"
+ },
+ "type": "object",
+ "properties": {
+ "all_of": {
+ "description": "Returns matches that span a combination of other rules.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsAllOf"
+ }
+ ]
+ },
+ "any_of": {
+ "description": "Returns intervals produced by any of its sub-rules.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsAnyOf"
+ }
+ ]
+ },
+ "fuzzy": {
+ "description": "Matches terms that are similar to the provided term, within an edit distance defined by `fuzziness`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsFuzzy"
+ }
+ ]
+ },
+ "match": {
+ "description": "Matches analyzed text.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsMatch"
+ }
+ ]
+ },
+ "prefix": {
+ "description": "Matches terms that start with a specified set of characters.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsPrefix"
+ }
+ ]
+ },
+ "range": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsRange"
+ }
+ ]
+ },
+ "regexp": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsRegexp"
+ }
+ ]
+ },
+ "wildcard": {
+ "description": "Matches terms using a wildcard pattern.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsWildcard"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ }
+ ]
+ },
+ "_types.query_dsl.IntervalsAllOf": {
+ "type": "object",
+ "properties": {
+ "intervals": {
+ "description": "An array of rules to combine. All rules must produce a match in a document for the overall source to match.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer"
+ }
+ },
+ "max_gaps": {
+ "description": "Maximum number of positions between the matching terms.\nIntervals produced by the rules further apart than this are not considered matches.",
+ "default": -1.0,
+ "type": "number"
+ },
+ "ordered": {
+ "description": "If `true`, intervals produced by the rules should appear in the order in which they are specified.",
+ "default": false,
+ "type": "boolean"
+ },
+ "filter": {
+ "description": "Rule used to filter returned intervals.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsFilter"
+ }
+ ]
+ }
+ },
+ "required": [
+ "intervals"
+ ]
+ },
+ "_types.query_dsl.IntervalsContainer": {
+ "type": "object",
+ "properties": {
+ "all_of": {
+ "description": "Returns matches that span a combination of other rules.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsAllOf"
+ }
+ ]
+ },
+ "any_of": {
+ "description": "Returns intervals produced by any of its sub-rules.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsAnyOf"
+ }
+ ]
+ },
+ "fuzzy": {
+ "description": "Matches analyzed text.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsFuzzy"
+ }
+ ]
+ },
+ "match": {
+ "description": "Matches analyzed text.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsMatch"
+ }
+ ]
+ },
+ "prefix": {
+ "description": "Matches terms that start with a specified set of characters.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsPrefix"
+ }
+ ]
+ },
+ "range": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsRange"
+ }
+ ]
+ },
+ "regexp": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsRegexp"
+ }
+ ]
+ },
+ "wildcard": {
+ "description": "Matches terms using a wildcard pattern.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsWildcard"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "_types.query_dsl.IntervalsAnyOf": {
+ "type": "object",
+ "properties": {
+ "intervals": {
+ "description": "An array of rules to match.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer"
+ }
+ },
+ "filter": {
+ "description": "Rule used to filter returned intervals.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsFilter"
+ }
+ ]
+ }
+ },
+ "required": [
+ "intervals"
+ ]
+ },
+ "_types.query_dsl.IntervalsFilter": {
+ "type": "object",
+ "properties": {
+ "after": {
+ "description": "Query used to return intervals that follow an interval from the `filter` rule.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer"
+ }
+ ]
+ },
+ "before": {
+ "description": "Query used to return intervals that occur before an interval from the `filter` rule.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer"
+ }
+ ]
+ },
+ "contained_by": {
+ "description": "Query used to return intervals contained by an interval from the `filter` rule.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer"
+ }
+ ]
+ },
+ "containing": {
+ "description": "Query used to return intervals that contain an interval from the `filter` rule.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer"
+ }
+ ]
+ },
+ "not_contained_by": {
+ "description": "Query used to return intervals that are **not** contained by an interval from the `filter` rule.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer"
+ }
+ ]
+ },
+ "not_containing": {
+ "description": "Query used to return intervals that do **not** contain an interval from the `filter` rule.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer"
+ }
+ ]
+ },
+ "not_overlapping": {
+ "description": "Query used to return intervals that do **not** overlap with an interval from the `filter` rule.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer"
+ }
+ ]
+ },
+ "overlapping": {
+ "description": "Query used to return intervals that overlap with an interval from the `filter` rule.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsContainer"
+ }
+ ]
+ },
+ "script": {
+ "description": "Script used to return matching documents.\nThis script must return a boolean value: `true` or `false`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "_types.query_dsl.IntervalsFuzzy": {
+ "type": "object",
+ "properties": {
+ "analyzer": {
+ "description": "Analyzer used to normalize the term.",
+ "type": "string"
+ },
+ "fuzziness": {
+ "description": "Maximum edit distance allowed for matching.",
+ "default": "auto",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fuzziness"
+ }
+ ]
+ },
+ "prefix_length": {
+ "description": "Number of beginning characters left unchanged when creating expansions.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "term": {
+ "description": "The term to match.",
+ "type": "string"
+ },
+ "transpositions": {
+ "description": "Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`).",
+ "default": true,
+ "type": "boolean"
+ },
+ "use_field": {
+ "description": "If specified, match intervals from this field rather than the top-level field.\nThe `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "term"
+ ]
+ },
+ "_types.query_dsl.IntervalsMatch": {
+ "type": "object",
+ "properties": {
+ "analyzer": {
+ "description": "Analyzer used to analyze terms in the query.",
+ "type": "string"
+ },
+ "max_gaps": {
+ "description": "Maximum number of positions between the matching terms.\nTerms further apart than this are not considered matches.",
+ "default": -1.0,
+ "type": "number"
+ },
+ "ordered": {
+ "description": "If `true`, matching terms must appear in their specified order.",
+ "default": false,
+ "type": "boolean"
+ },
+ "query": {
+ "description": "Text you wish to find in the provided field.",
+ "type": "string"
+ },
+ "use_field": {
+ "description": "If specified, match intervals from this field rather than the top-level field.\nThe `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "filter": {
+ "description": "An optional interval filter.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IntervalsFilter"
+ }
+ ]
+ }
+ },
+ "required": [
+ "query"
+ ]
+ },
+ "_types.query_dsl.IntervalsPrefix": {
+ "type": "object",
+ "properties": {
+ "analyzer": {
+ "description": "Analyzer used to analyze the `prefix`.",
+ "type": "string"
+ },
+ "prefix": {
+ "description": "Beginning characters of terms you wish to find in the top-level field.",
+ "type": "string"
+ },
+ "use_field": {
+ "description": "If specified, match intervals from this field rather than the top-level field.\nThe `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "prefix"
+ ]
+ },
+ "_types.query_dsl.IntervalsRange": {
+ "type": "object",
+ "properties": {
+ "analyzer": {
+ "description": "Analyzer used to analyze the `prefix`.",
+ "type": "string"
+ },
+ "gte": {
+ "description": "Lower term, either gte or gt must be provided.",
+ "type": "string"
+ },
+ "gt": {
+ "description": "Lower term, either gte or gt must be provided.",
+ "type": "string"
+ },
+ "lte": {
+ "description": "Upper term, either lte or lt must be provided.",
+ "type": "string"
+ },
+ "lt": {
+ "description": "Upper term, either lte or lt must be provided.",
+ "type": "string"
+ },
+ "use_field": {
+ "description": "If specified, match intervals from this field rather than the top-level field.\nThe `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ }
+ },
+ "_types.query_dsl.IntervalsRegexp": {
+ "type": "object",
+ "properties": {
+ "analyzer": {
+ "description": "Analyzer used to analyze the `prefix`.",
+ "type": "string"
+ },
+ "pattern": {
+ "description": "Regex pattern.",
+ "type": "string"
+ },
+ "use_field": {
+ "description": "If specified, match intervals from this field rather than the top-level field.\nThe `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "pattern"
+ ]
+ },
+ "_types.query_dsl.IntervalsWildcard": {
+ "type": "object",
+ "properties": {
+ "analyzer": {
+ "description": "Analyzer used to analyze the `pattern`.\nDefaults to the top-level field's analyzer.",
+ "type": "string"
+ },
+ "pattern": {
+ "description": "Wildcard pattern used to find matching terms.",
+ "type": "string"
+ },
+ "use_field": {
+ "description": "If specified, match intervals from this field rather than the top-level field.\nThe `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "pattern"
+ ]
+ },
+ "_types.KnnQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The name of the vector field to search against",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "query_vector": {
+ "description": "The query vector",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.QueryVector"
+ }
+ ]
+ },
+ "query_vector_builder": {
+ "description": "The query vector builder. You must provide a query_vector_builder or query_vector, but not both.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.QueryVectorBuilder"
+ }
+ ]
+ },
+ "num_candidates": {
+ "description": "The number of nearest neighbor candidates to consider per shard",
+ "type": "number"
+ },
+ "k": {
+ "description": "The final number of nearest neighbors to return as top hits",
+ "type": "number"
+ },
+ "filter": {
+ "description": "Filters for the kNN search query",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ }
+ ]
+ },
+ "similarity": {
+ "description": "The minimum similarity for a vector to be considered a match",
+ "type": "number"
+ },
+ "rescore_vector": {
+ "description": "Apply oversampling and rescoring to quantized vectors",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RescoreVector"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.MatchQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "analyzer": {
+ "description": "Analyzer used to convert the text in the query value into tokens.",
+ "type": "string"
+ },
+ "auto_generate_synonyms_phrase_query": {
+ "description": "If `true`, match phrase queries are automatically created for multi-term synonyms.",
+ "default": true,
+ "type": "boolean"
+ },
+ "cutoff_frequency": {
+ "deprecated": true,
+ "type": "number"
+ },
+ "fuzziness": {
+ "description": "Maximum edit distance allowed for matching.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fuzziness"
+ }
+ ]
+ },
+ "fuzzy_rewrite": {
+ "description": "Method used to rewrite the query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.MultiTermQueryRewrite"
+ }
+ ]
+ },
+ "fuzzy_transpositions": {
+ "description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).",
+ "default": true,
+ "type": "boolean"
+ },
+ "lenient": {
+ "description": "If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored.",
+ "default": false,
+ "type": "boolean"
+ },
+ "max_expansions": {
+ "description": "Maximum number of terms to which the query will expand.",
+ "default": 50.0,
+ "type": "number"
+ },
+ "minimum_should_match": {
+ "description": "Minimum number of clauses that must match for a document to be returned.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.MinimumShouldMatch"
+ }
+ ]
+ },
+ "operator": {
+ "description": "Boolean logic used to interpret text in the query value.",
+ "default": "'or'",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.Operator"
+ }
+ ]
+ },
+ "prefix_length": {
+ "description": "Number of beginning characters left unchanged for fuzzy matching.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "query": {
+ "description": "Text, number, boolean value or date you wish to find in the provided field.",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ }
+ ]
+ },
+ "zero_terms_query": {
+ "description": "Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter.\n\nSupported values include:\n - `all`: Returns all documents, similar to a `match_all` query.\n - `none`: No documents are returned if the `analyzer` removes all tokens.\n\n",
+ "default": "'none'",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.ZeroTermsQuery"
+ }
+ ]
+ }
+ },
+ "required": [
+ "query"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.ZeroTermsQuery": {
+ "type": "string",
+ "enum": [
+ "all",
+ "none"
+ ]
+ },
+ "_types.query_dsl.MatchAllQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.query_dsl.MatchBoolPrefixQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "analyzer": {
+ "description": "Analyzer used to convert the text in the query value into tokens.",
+ "type": "string"
+ },
+ "fuzziness": {
+ "description": "Maximum edit distance allowed for matching.\nCan be applied to the term subqueries constructed for all terms but the final term.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fuzziness"
+ }
+ ]
+ },
+ "fuzzy_rewrite": {
+ "description": "Method used to rewrite the query.\nCan be applied to the term subqueries constructed for all terms but the final term.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.MultiTermQueryRewrite"
+ }
+ ]
+ },
+ "fuzzy_transpositions": {
+ "description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).\nCan be applied to the term subqueries constructed for all terms but the final term.",
+ "default": true,
+ "type": "boolean"
+ },
+ "max_expansions": {
+ "description": "Maximum number of terms to which the query will expand.\nCan be applied to the term subqueries constructed for all terms but the final term.",
+ "default": 50.0,
+ "type": "number"
+ },
+ "minimum_should_match": {
+ "description": "Minimum number of clauses that must match for a document to be returned.\nApplied to the constructed bool query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.MinimumShouldMatch"
+ }
+ ]
+ },
+ "operator": {
+ "description": "Boolean logic used to interpret text in the query value.\nApplied to the constructed bool query.",
+ "default": "'or'",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.Operator"
+ }
+ ]
+ },
+ "prefix_length": {
+ "description": "Number of beginning characters left unchanged for fuzzy matching.\nCan be applied to the term subqueries constructed for all terms but the final term.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "query": {
+ "description": "Terms you wish to find in the provided field.\nThe last term is used in a prefix query.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "query"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.MatchNoneQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.query_dsl.MatchPhraseQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "analyzer": {
+ "description": "Analyzer used to convert the text in the query value into tokens.",
+ "type": "string"
+ },
+ "query": {
+ "description": "Query terms that are analyzed and turned into a phrase query.",
+ "type": "string"
+ },
+ "slop": {
+ "description": "Maximum number of positions allowed between matching tokens.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "zero_terms_query": {
+ "description": "Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter.\n\nSupported values include:\n - `all`: Returns all documents, similar to a `match_all` query.\n - `none`: No documents are returned if the `analyzer` removes all tokens.\n\n",
+ "default": "'none'",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.ZeroTermsQuery"
+ }
+ ]
+ }
+ },
+ "required": [
+ "query"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.MatchPhrasePrefixQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "analyzer": {
+ "description": "Analyzer used to convert text in the query value into tokens.",
+ "type": "string"
+ },
+ "max_expansions": {
+ "description": "Maximum number of terms to which the last provided term of the query value will expand.",
+ "default": 50.0,
+ "type": "number"
+ },
+ "query": {
+ "description": "Text you wish to find in the provided field.",
+ "type": "string"
+ },
+ "slop": {
+ "description": "Maximum number of positions allowed between matching tokens.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "zero_terms_query": {
+ "description": "Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter.\n\nSupported values include:\n - `all`: Returns all documents, similar to a `match_all` query.\n - `none`: No documents are returned if the `analyzer` removes all tokens.\n\n",
+ "default": "none",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.ZeroTermsQuery"
+ }
+ ]
+ }
+ },
+ "required": [
+ "query"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.MoreLikeThisQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "analyzer": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/manage-data/data-store/text-analysis"
+ },
+ "description": "The analyzer that is used to analyze the free form text.\nDefaults to the analyzer associated with the first field in fields.",
+ "type": "string"
+ },
+ "boost_terms": {
+ "description": "Each term in the formed query could be further boosted by their tf-idf score.\nThis sets the boost factor to use when using this feature.\nDefaults to deactivated (0).",
+ "default": 0.0,
+ "type": "number"
+ },
+ "fail_on_unsupported_field": {
+ "description": "Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (`text` or `keyword`).",
+ "default": true,
+ "type": "boolean"
+ },
+ "fields": {
+ "description": "A list of fields to fetch and analyze the text from.\nDefaults to the `index.query.default_field` index setting, which has a default value of `*`.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ },
+ "include": {
+ "description": "Specifies whether the input documents should also be included in the search results returned.",
+ "default": false,
+ "type": "boolean"
+ },
+ "like": {
+ "description": "Specifies free form text and/or a single or multiple documents for which you want to find similar documents.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.Like"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.Like"
+ }
+ }
+ ]
+ },
+ "max_doc_freq": {
+ "description": "The maximum document frequency above which the terms are ignored from the input document.",
+ "type": "number"
+ },
+ "max_query_terms": {
+ "description": "The maximum number of query terms that can be selected.",
+ "default": 25.0,
+ "type": "number"
+ },
+ "max_word_length": {
+ "description": "The maximum word length above which the terms are ignored.\nDefaults to unbounded (`0`).",
+ "default": 0.0,
+ "type": "number"
+ },
+ "min_doc_freq": {
+ "description": "The minimum document frequency below which the terms are ignored from the input document.",
+ "default": 5.0,
+ "type": "number"
+ },
+ "minimum_should_match": {
+ "description": "After the disjunctive query has been formed, this parameter controls the number of terms that must match.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.MinimumShouldMatch"
+ }
+ ]
+ },
+ "min_term_freq": {
+ "description": "The minimum term frequency below which the terms are ignored from the input document.",
+ "default": 2.0,
+ "type": "number"
+ },
+ "min_word_length": {
+ "description": "The minimum word length below which the terms are ignored.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "routing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Routing"
+ }
+ ]
+ },
+ "stop_words": {
+ "description": "An array of stop words.\nAny word in this set is ignored.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "unlike": {
+ "description": "Used in combination with `like` to exclude documents that match a set of terms.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.Like"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.Like"
+ }
+ }
+ ]
+ },
+ "version": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ }
+ ]
+ },
+ "version_type": {
+ "description": "\n\nSupported values include:\n - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n - `force`: This option is deprecated because it can cause primary and replica shards to diverge.\n\n",
+ "default": "'internal'",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionType"
+ }
+ ]
+ }
+ },
+ "required": [
+ "like"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.Like": {
+ "description": "Text that we want similar documents for or a lookup to a document's field for the text.",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.LikeDocument"
+ }
+ ]
+ },
+ "_types.query_dsl.LikeDocument": {
+ "type": "object",
+ "properties": {
+ "doc": {
+ "description": "A document not present in the index.",
+ "type": "object"
+ },
+ "fields": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ },
+ "_id": {
+ "description": "ID of a document.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "_index": {
+ "description": "Index of a document.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "per_field_analyzer": {
+ "description": "Overrides the default analyzer.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "routing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Routing"
+ }
+ ]
+ },
+ "version": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ }
+ ]
+ },
+ "version_type": {
+ "description": "\n\nSupported values include:\n - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n - `force`: This option is deprecated because it can cause primary and replica shards to diverge.\n\n",
+ "default": "'internal'",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionType"
+ }
+ ]
+ }
+ }
+ },
+ "_types.VersionType": {
+ "type": "string",
+ "enum": [
+ "internal",
+ "external",
+ "external_gte",
+ "force"
+ ]
+ },
+ "_types.analysis.StopWords": {
+ "description": "Language value, such as _arabic_ or _thai_. Defaults to _english_.\nEach language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words.\nAlso accepts an array of stop words.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWordLanguage"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "_types.analysis.StopWordLanguage": {
+ "type": "string",
+ "enum": [
+ "_arabic_",
+ "_armenian_",
+ "_basque_",
+ "_bengali_",
+ "_brazilian_",
+ "_bulgarian_",
+ "_catalan_",
+ "_cjk_",
+ "_czech_",
+ "_danish_",
+ "_dutch_",
+ "_english_",
+ "_estonian_",
+ "_finnish_",
+ "_french_",
+ "_galician_",
+ "_german_",
+ "_greek_",
+ "_hindi_",
+ "_hungarian_",
+ "_indonesian_",
+ "_irish_",
+ "_italian_",
+ "_latvian_",
+ "_lithuanian_",
+ "_norwegian_",
+ "_persian_",
+ "_portuguese_",
+ "_romanian_",
+ "_russian_",
+ "_serbian_",
+ "_sorani_",
+ "_spanish_",
+ "_swedish_",
+ "_thai_",
+ "_turkish_",
+ "_none_"
+ ]
+ },
+ "_types.query_dsl.MultiMatchQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "analyzer": {
+ "description": "Analyzer used to convert the text in the query value into tokens.",
+ "type": "string"
+ },
+ "auto_generate_synonyms_phrase_query": {
+ "description": "If `true`, match phrase queries are automatically created for multi-term synonyms.",
+ "default": true,
+ "type": "boolean"
+ },
+ "cutoff_frequency": {
+ "deprecated": true,
+ "type": "number"
+ },
+ "fields": {
+ "description": "The fields to be queried.\nDefaults to the `index.query.default_field` index settings, which in turn defaults to `*`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ },
+ "fuzziness": {
+ "description": "Maximum edit distance allowed for matching.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fuzziness"
+ }
+ ]
+ },
+ "fuzzy_rewrite": {
+ "description": "Method used to rewrite the query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.MultiTermQueryRewrite"
+ }
+ ]
+ },
+ "fuzzy_transpositions": {
+ "description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).\nCan be applied to the term subqueries constructed for all terms but the final term.",
+ "default": true,
+ "type": "boolean"
+ },
+ "lenient": {
+ "description": "If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored.",
+ "default": false,
+ "type": "boolean"
+ },
+ "max_expansions": {
+ "description": "Maximum number of terms to which the query will expand.",
+ "default": 50.0,
+ "type": "number"
+ },
+ "minimum_should_match": {
+ "description": "Minimum number of clauses that must match for a document to be returned.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.MinimumShouldMatch"
+ }
+ ]
+ },
+ "operator": {
+ "description": "Boolean logic used to interpret text in the query value.",
+ "default": "'or'",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.Operator"
+ }
+ ]
+ },
+ "prefix_length": {
+ "description": "Number of beginning characters left unchanged for fuzzy matching.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "query": {
+ "description": "Text, number, boolean value or date you wish to find in the provided field.",
+ "type": "string"
+ },
+ "slop": {
+ "description": "Maximum number of positions allowed between matching tokens.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "tie_breaker": {
+ "description": "Determines how scores for each per-term blended query and scores across groups are combined.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "type": {
+ "description": "How `the` multi_match query is executed internally.\n\nSupported values include:\n - `best_fields`: Finds documents that match any field, but uses the `_score` from the best field.\n - `most_fields`: Finds documents that match any field and combines the `_score` from each field.\n - `cross_fields`: Treats fields with the same analyzer as though they were one big field.\nLooks for each word in any field.\n - `phrase`: Runs a `match_phrase` query on each field and uses the `_score` from the best field.\n - `phrase_prefix`: Runs a `match_phrase_prefix` query on each field and uses the `_score` from the best field.\n - `bool_prefix`: Creates a `match_bool_prefix` query on each field and combines the `_score` from each field.\n\n",
+ "default": "'best_fields'",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.TextQueryType"
+ }
+ ]
+ },
+ "zero_terms_query": {
+ "description": "Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter.\n\nSupported values include:\n - `all`: Returns all documents, similar to a `match_all` query.\n - `none`: No documents are returned if the `analyzer` removes all tokens.\n\n",
+ "default": "'none'",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.ZeroTermsQuery"
+ }
+ ]
+ }
+ },
+ "required": [
+ "query"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.TextQueryType": {
+ "type": "string",
+ "enum": [
+ "best_fields",
+ "most_fields",
+ "cross_fields",
+ "phrase",
+ "phrase_prefix",
+ "bool_prefix"
+ ]
+ },
+ "_types.query_dsl.NestedQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "ignore_unmapped": {
+ "description": "Indicates whether to ignore an unmapped path and not return any documents instead of an error.",
+ "default": false,
+ "type": "boolean"
+ },
+ "inner_hits": {
+ "description": "If defined, each search hit will contain inner hits.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.InnerHits"
+ }
+ ]
+ },
+ "path": {
+ "description": "Path to the nested object you wish to search.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "query": {
+ "description": "Query you wish to run on nested objects in the path.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "score_mode": {
+ "description": "How scores for matching child objects affect the root parent document’s relevance score.",
+ "default": "'avg'",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.ChildScoreMode"
+ }
+ ]
+ }
+ },
+ "required": [
+ "path",
+ "query"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.ParentIdQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "ID of the parent document.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "ignore_unmapped": {
+ "description": "Indicates whether to ignore an unmapped `type` and not return any documents instead of an error.",
+ "default": false,
+ "type": "boolean"
+ },
+ "type": {
+ "description": "Name of the child relationship mapped for the `join` field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RelationName"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.query_dsl.PercolateQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "document": {
+ "description": "The source of the document being percolated.",
+ "type": "object"
+ },
+ "documents": {
+ "description": "An array of sources of the documents being percolated.",
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ },
+ "field": {
+ "description": "Field that holds the indexed queries. The field must use the `percolator` mapping type.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "id": {
+ "description": "The ID of a stored document to percolate.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "index": {
+ "description": "The index of a stored document to percolate.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "name": {
+ "description": "The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified.",
+ "type": "string"
+ },
+ "preference": {
+ "description": "Preference used to fetch document to percolate.",
+ "type": "string"
+ },
+ "routing": {
+ "description": "Routing used to fetch document to percolate.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Routing"
+ }
+ ]
+ },
+ "version": {
+ "description": "The expected version of a stored document to percolate.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.PinnedQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-pinned-query"
+ },
+ "allOf": [
+ {
+ "type": "object",
+ "properties": {
+ "organic": {
+ "description": "Any choice of query used to rank documents which will be ranked below the \"pinned\" documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ }
+ },
+ "required": [
+ "organic"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "ids": {
+ "description": "Document IDs listed in the order they are to appear in results.\nRequired if `docs` is not specified.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ },
+ "docs": {
+ "description": "Documents listed in the order they are to appear in results.\nRequired if `ids` is not specified.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.PinnedDoc"
+ }
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ }
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.PinnedDoc": {
+ "type": "object",
+ "properties": {
+ "_id": {
+ "description": "The unique document ID.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "_index": {
+ "description": "The index that contains the document.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ }
+ },
+ "required": [
+ "_id"
+ ]
+ },
+ "_types.query_dsl.PrefixQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "rewrite": {
+ "description": "Method used to rewrite the query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.MultiTermQueryRewrite"
+ }
+ ]
+ },
+ "value": {
+ "description": "Beginning characters of terms you wish to find in the provided field.",
+ "type": "string"
+ },
+ "case_insensitive": {
+ "description": "Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.\nDefault is `false` which means the case sensitivity of matching depends on the underlying field’s mapping.",
+ "default": false,
+ "x-state": "Generally available",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "value"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.QueryStringQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "allow_leading_wildcard": {
+ "description": "If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string.",
+ "default": true,
+ "type": "boolean"
+ },
+ "analyzer": {
+ "description": "Analyzer used to convert text in the query string into tokens.",
+ "type": "string"
+ },
+ "analyze_wildcard": {
+ "description": "If `true`, the query attempts to analyze wildcard terms in the query string.",
+ "default": false,
+ "type": "boolean"
+ },
+ "auto_generate_synonyms_phrase_query": {
+ "description": "If `true`, match phrase queries are automatically created for multi-term synonyms.",
+ "default": true,
+ "type": "boolean"
+ },
+ "default_field": {
+ "description": "Default field to search if no field is provided in the query string.\nSupports wildcards (`*`).\nDefaults to the `index.query.default_field` index setting, which has a default value of `*`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "default_operator": {
+ "description": "Default boolean logic used to interpret text in the query string if no operators are specified.",
+ "default": "'or'",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.Operator"
+ }
+ ]
+ },
+ "enable_position_increments": {
+ "description": "If `true`, enable position increments in queries constructed from a `query_string` search.",
+ "default": true,
+ "type": "boolean"
+ },
+ "escape": {
+ "default": false,
+ "type": "boolean"
+ },
+ "fields": {
+ "description": "Array of fields to search. Supports wildcards (`*`).",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ },
+ "fuzziness": {
+ "description": "Maximum edit distance allowed for fuzzy matching.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fuzziness"
+ }
+ ]
+ },
+ "fuzzy_max_expansions": {
+ "description": "Maximum number of terms to which the query expands for fuzzy matching.",
+ "default": 50.0,
+ "type": "number"
+ },
+ "fuzzy_prefix_length": {
+ "description": "Number of beginning characters left unchanged for fuzzy matching.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "fuzzy_rewrite": {
+ "description": "Method used to rewrite the query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.MultiTermQueryRewrite"
+ }
+ ]
+ },
+ "fuzzy_transpositions": {
+ "description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).",
+ "default": true,
+ "type": "boolean"
+ },
+ "lenient": {
+ "description": "If `true`, format-based errors, such as providing a text value for a numeric field, are ignored.",
+ "default": false,
+ "type": "boolean"
+ },
+ "max_determinized_states": {
+ "description": "Maximum number of automaton states required for the query.",
+ "default": 10000.0,
+ "type": "number"
+ },
+ "minimum_should_match": {
+ "description": "Minimum number of clauses that must match for a document to be returned.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.MinimumShouldMatch"
+ }
+ ]
+ },
+ "phrase_slop": {
+ "description": "Maximum number of positions allowed between matching tokens for phrases.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "query": {
+ "description": "Query string you wish to parse and use for search.",
+ "type": "string"
+ },
+ "quote_analyzer": {
+ "description": "Analyzer used to convert quoted text in the query string into tokens.\nFor quoted text, this parameter overrides the analyzer specified in the `analyzer` parameter.",
+ "type": "string"
+ },
+ "quote_field_suffix": {
+ "description": "Suffix appended to quoted text in the query string.\nYou can use this suffix to use a different analysis method for exact matches.",
+ "type": "string"
+ },
+ "rewrite": {
+ "description": "Method used to rewrite the query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.MultiTermQueryRewrite"
+ }
+ ]
+ },
+ "tie_breaker": {
+ "description": "How to combine the queries generated from the individual search terms in the resulting `dis_max` query.",
+ "type": "number"
+ },
+ "time_zone": {
+ "description": "Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.TimeZone"
+ }
+ ]
+ },
+ "type": {
+ "description": "Determines how the query matches and scores documents.\n\nSupported values include:\n - `best_fields`: Finds documents that match any field, but uses the `_score` from the best field.\n - `most_fields`: Finds documents that match any field and combines the `_score` from each field.\n - `cross_fields`: Treats fields with the same analyzer as though they were one big field.\nLooks for each word in any field.\n - `phrase`: Runs a `match_phrase` query on each field and uses the `_score` from the best field.\n - `phrase_prefix`: Runs a `match_phrase_prefix` query on each field and uses the `_score` from the best field.\n - `bool_prefix`: Creates a `match_bool_prefix` query on each field and combines the `_score` from each field.\n\n",
+ "default": "'best_fields'",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.TextQueryType"
+ }
+ ]
+ }
+ },
+ "required": [
+ "query"
+ ]
+ }
+ ]
+ },
+ "_types.TimeZone": {
+ "type": "string"
+ },
+ "_types.query_dsl.RangeQuery": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-range-query"
+ },
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.UntypedRangeQuery"
+ },
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.DateRangeQuery"
+ },
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.NumberRangeQuery"
+ },
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.TermRangeQuery"
+ }
+ ]
+ },
+ "_types.query_dsl.UntypedRangeQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.RangeQueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "format": {
+ "description": "Date format used to convert `date` values in the query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateFormat"
+ }
+ ]
+ },
+ "time_zone": {
+ "description": "Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.TimeZone"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.DateFormat": {
+ "type": "string"
+ },
+ "_types.query_dsl.RangeQueryBase": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "relation": {
+ "description": "Indicates how the range query matches values for `range` fields.\n\nSupported values include:\n - `within`: Matches documents with a range field value entirely within the query’s range.\n - `contains`: Matches documents with a range field value that entirely contains the query’s range.\n - `intersects`: Matches documents with a range field value that intersects the query’s range.\n\n",
+ "default": "intersects",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.RangeRelation"
+ }
+ ]
+ },
+ "gt": {
+ "description": "Greater than.",
+ "type": "object"
+ },
+ "gte": {
+ "description": "Greater than or equal to.",
+ "type": "object"
+ },
+ "lt": {
+ "description": "Less than.",
+ "type": "object"
+ },
+ "lte": {
+ "description": "Less than or equal to.",
+ "type": "object"
+ }
+ }
+ }
+ ]
+ },
+ "_types.query_dsl.RangeRelation": {
+ "type": "string",
+ "enum": [
+ "within",
+ "contains",
+ "intersects"
+ ]
+ },
+ "_types.query_dsl.DateRangeQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.RangeQueryBaseDateMath"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "format": {
+ "description": "Date format used to convert `date` values in the query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateFormat"
+ }
+ ]
+ },
+ "time_zone": {
+ "description": "Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.TimeZone"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.query_dsl.RangeQueryBaseDateMath": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "relation": {
+ "description": "Indicates how the range query matches values for `range` fields.\n\nSupported values include:\n - `within`: Matches documents with a range field value entirely within the query’s range.\n - `contains`: Matches documents with a range field value that entirely contains the query’s range.\n - `intersects`: Matches documents with a range field value that intersects the query’s range.\n\n",
+ "default": "intersects",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.RangeRelation"
+ }
+ ]
+ },
+ "gt": {
+ "description": "Greater than.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateMath"
+ }
+ ]
+ },
+ "gte": {
+ "description": "Greater than or equal to.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateMath"
+ }
+ ]
+ },
+ "lt": {
+ "description": "Less than.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateMath"
+ }
+ ]
+ },
+ "lte": {
+ "description": "Less than or equal to.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateMath"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.query_dsl.NumberRangeQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.RangeQueryBasedouble"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.query_dsl.RangeQueryBasedouble": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "relation": {
+ "description": "Indicates how the range query matches values for `range` fields.\n\nSupported values include:\n - `within`: Matches documents with a range field value entirely within the query’s range.\n - `contains`: Matches documents with a range field value that entirely contains the query’s range.\n - `intersects`: Matches documents with a range field value that intersects the query’s range.\n\n",
+ "default": "intersects",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.RangeRelation"
+ }
+ ]
+ },
+ "gt": {
+ "description": "Greater than.",
+ "type": "number"
+ },
+ "gte": {
+ "description": "Greater than or equal to.",
+ "type": "number"
+ },
+ "lt": {
+ "description": "Less than.",
+ "type": "number"
+ },
+ "lte": {
+ "description": "Less than or equal to.",
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "_types.query_dsl.TermRangeQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.RangeQueryBasestring"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.query_dsl.RangeQueryBasestring": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "relation": {
+ "description": "Indicates how the range query matches values for `range` fields.\n\nSupported values include:\n - `within`: Matches documents with a range field value entirely within the query’s range.\n - `contains`: Matches documents with a range field value that entirely contains the query’s range.\n - `intersects`: Matches documents with a range field value that intersects the query’s range.\n\n",
+ "default": "intersects",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.RangeRelation"
+ }
+ ]
+ },
+ "gt": {
+ "description": "Greater than.",
+ "type": "string"
+ },
+ "gte": {
+ "description": "Greater than or equal to.",
+ "type": "string"
+ },
+ "lt": {
+ "description": "Less than.",
+ "type": "string"
+ },
+ "lte": {
+ "description": "Less than or equal to.",
+ "type": "string"
+ }
+ }
+ }
+ ]
+ },
+ "_types.query_dsl.RankFeatureQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "`rank_feature` or `rank_features` field used to boost relevance scores.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "saturation": {
+ "description": "Saturation function used to boost relevance scores based on the value of the rank feature `field`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunctionSaturation"
+ }
+ ]
+ },
+ "log": {
+ "description": "Logarithmic function used to boost relevance scores based on the value of the rank feature `field`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunctionLogarithm"
+ }
+ ]
+ },
+ "linear": {
+ "description": "Linear function used to boost relevance scores based on the value of the rank feature `field`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunctionLinear"
+ }
+ ]
+ },
+ "sigmoid": {
+ "description": "Sigmoid function used to boost relevance scores based on the value of the rank feature `field`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunctionSigmoid"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.RankFeatureFunctionSaturation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunction"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "pivot": {
+ "description": "Configurable pivot value so that the result will be less than 0.5.",
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "_types.query_dsl.RankFeatureFunction": {
+ "type": "object"
+ },
+ "_types.query_dsl.RankFeatureFunctionLogarithm": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunction"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "scaling_factor": {
+ "description": "Configurable scaling factor.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "scaling_factor"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.RankFeatureFunctionLinear": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunction"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.query_dsl.RankFeatureFunctionSigmoid": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.RankFeatureFunction"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "pivot": {
+ "description": "Configurable pivot value so that the result will be less than 0.5.",
+ "type": "number"
+ },
+ "exponent": {
+ "description": "Configurable Exponent.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "pivot",
+ "exponent"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.RegexpQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "case_insensitive": {
+ "description": "Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`.\nWhen `false`, case sensitivity of matching depends on the underlying field’s mapping.",
+ "default": false,
+ "x-state": "Generally available",
+ "type": "boolean"
+ },
+ "flags": {
+ "description": "Enables optional operators for the regular expression.",
+ "type": "string"
+ },
+ "max_determinized_states": {
+ "description": "Maximum number of automaton states required for the query.",
+ "default": 10000.0,
+ "type": "number"
+ },
+ "rewrite": {
+ "description": "Method used to rewrite the query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.MultiTermQueryRewrite"
+ }
+ ]
+ },
+ "value": {
+ "description": "Regular expression for terms you wish to find in the provided field.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "value"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.RuleQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "organic": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "ruleset_ids": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ }
+ ]
+ },
+ "ruleset_id": {
+ "type": "string"
+ },
+ "match_criteria": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "organic",
+ "match_criteria"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.ScriptQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "script": {
+ "description": "Contains a script to run as a query.\nThis script must return a boolean value, `true` or `false`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ }
+ },
+ "required": [
+ "script"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.ScriptScoreQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "min_score": {
+ "description": "Documents with a score lower than this floating point number are excluded from the search results.",
+ "type": "number"
+ },
+ "query": {
+ "description": "Query used to return documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "script": {
+ "description": "Script used to compute the score of documents returned by the query.\nImportant: final relevance scores from the `script_score` query cannot be negative.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ }
+ },
+ "required": [
+ "query",
+ "script"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.SemanticQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The field to query, which must be a semantic_text field type",
+ "type": "string"
+ },
+ "query": {
+ "description": "The query text",
+ "type": "string"
+ }
+ },
+ "required": [
+ "field",
+ "query"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.ShapeQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "ignore_unmapped": {
+ "description": "When set to `true` the query ignores an unmapped field and will not match any documents.",
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "_types.query_dsl.SimpleQueryStringQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "analyzer": {
+ "description": "Analyzer used to convert text in the query string into tokens.",
+ "type": "string"
+ },
+ "analyze_wildcard": {
+ "description": "If `true`, the query attempts to analyze wildcard terms in the query string.",
+ "default": false,
+ "type": "boolean"
+ },
+ "auto_generate_synonyms_phrase_query": {
+ "description": "If `true`, the parser creates a match_phrase query for each multi-position token.",
+ "default": true,
+ "type": "boolean"
+ },
+ "default_operator": {
+ "description": "Default boolean logic used to interpret text in the query string if no operators are specified.",
+ "default": "'or'",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.Operator"
+ }
+ ]
+ },
+ "fields": {
+ "description": "Array of fields you wish to search.\nAccepts wildcard expressions.\nYou also can boost relevance scores for matches to particular fields using a caret (`^`) notation.\nDefaults to the `index.query.default_field index` setting, which has a default value of `*`.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ },
+ "flags": {
+ "description": "List of enabled operators for the simple query string syntax.",
+ "default": "ALL",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringFlags"
+ }
+ ]
+ },
+ "fuzzy_max_expansions": {
+ "description": "Maximum number of terms to which the query expands for fuzzy matching.",
+ "default": 50.0,
+ "type": "number"
+ },
+ "fuzzy_prefix_length": {
+ "description": "Number of beginning characters left unchanged for fuzzy matching.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "fuzzy_transpositions": {
+ "description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).",
+ "type": "boolean"
+ },
+ "lenient": {
+ "description": "If `true`, format-based errors, such as providing a text value for a numeric field, are ignored.",
+ "default": false,
+ "type": "boolean"
+ },
+ "minimum_should_match": {
+ "description": "Minimum number of clauses that must match for a document to be returned.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.MinimumShouldMatch"
+ }
+ ]
+ },
+ "query": {
+ "description": "Query string in the simple query string syntax you wish to parse and use for search.",
+ "type": "string"
+ },
+ "quote_field_suffix": {
+ "description": "Suffix appended to quoted text in the query string.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "query"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.SimpleQueryStringFlags": {
+ "description": "Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX`",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.PipeSeparatedFlagsSimpleQueryStringFlag"
+ }
+ ]
+ },
+ "_spec_utils.PipeSeparatedFlagsSimpleQueryStringFlag": {
+ "description": "A set of flags that can be represented as a single enum value or a set of values that are encoded\nas a pipe-separated string\n\nDepending on the target language, code generators can use this hint to generate language specific\nflags enum constructs and the corresponding (de-)serialization code.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringFlag"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "_types.query_dsl.SimpleQueryStringFlag": {
+ "type": "string",
+ "enum": [
+ "NONE",
+ "AND",
+ "NOT",
+ "OR",
+ "PREFIX",
+ "PHRASE",
+ "PRECEDENCE",
+ "ESCAPE",
+ "WHITESPACE",
+ "FUZZY",
+ "NEAR",
+ "SLOP",
+ "ALL"
+ ]
+ },
+ "_types.query_dsl.SpanContainingQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "big": {
+ "description": "Can be any span query.\nMatching spans from `big` that contain matches from `little` are returned.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanQuery"
+ }
+ ]
+ },
+ "little": {
+ "description": "Can be any span query.\nMatching spans from `big` that contain matches from `little` are returned.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanQuery"
+ }
+ ]
+ }
+ },
+ "required": [
+ "big",
+ "little"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.SpanQuery": {
+ "type": "object",
+ "properties": {
+ "span_containing": {
+ "description": "Accepts a list of span queries, but only returns those spans which also match a second span query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanContainingQuery"
+ }
+ ]
+ },
+ "span_field_masking": {
+ "description": "Allows queries like `span_near` or `span_or` across different fields.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanFieldMaskingQuery"
+ }
+ ]
+ },
+ "span_first": {
+ "description": "Accepts another span query whose matches must appear within the first N positions of the field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanFirstQuery"
+ }
+ ]
+ },
+ "span_gap": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanGapQuery"
+ }
+ ]
+ },
+ "span_multi": {
+ "description": "Wraps a `term`, `range`, `prefix`, `wildcard`, `regexp`, or `fuzzy` query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanMultiTermQuery"
+ }
+ ]
+ },
+ "span_near": {
+ "description": "Accepts multiple span queries whose matches must be within the specified distance of each other, and possibly in the same order.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanNearQuery"
+ }
+ ]
+ },
+ "span_not": {
+ "description": "Wraps another span query, and excludes any documents which match that query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanNotQuery"
+ }
+ ]
+ },
+ "span_or": {
+ "description": "Combines multiple span queries and returns documents which match any of the specified queries.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanOrQuery"
+ }
+ ]
+ },
+ "span_term": {
+ "description": "The equivalent of the `term` query but for use with other span queries.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanTermQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "span_within": {
+ "description": "The result from a single span query is returned as long is its span falls within the spans returned by a list of other span queries.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanWithinQuery"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "_types.query_dsl.SpanFieldMaskingQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "query": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanQuery"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field",
+ "query"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.SpanFirstQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "end": {
+ "description": "Controls the maximum end position permitted in a match.",
+ "type": "number"
+ },
+ "match": {
+ "description": "Can be any other span type query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanQuery"
+ }
+ ]
+ }
+ },
+ "required": [
+ "end",
+ "match"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.SpanGapQuery": {
+ "description": "Can only be used as a clause in a span_near query.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "number"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "_types.query_dsl.SpanMultiTermQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "match": {
+ "description": "Should be a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query).",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ }
+ },
+ "required": [
+ "match"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.SpanNearQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "clauses": {
+ "description": "Array of one or more other span type queries.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanQuery"
+ }
+ },
+ "in_order": {
+ "description": "Controls whether matches are required to be in-order.",
+ "type": "boolean"
+ },
+ "slop": {
+ "description": "Controls the maximum number of intervening unmatched positions permitted.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "clauses"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.SpanNotQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "dist": {
+ "description": "The number of tokens from within the include span that can’t have overlap with the exclude span.\nEquivalent to setting both `pre` and `post`.",
+ "type": "number"
+ },
+ "exclude": {
+ "description": "Span query whose matches must not overlap those returned.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanQuery"
+ }
+ ]
+ },
+ "include": {
+ "description": "Span query whose matches are filtered.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanQuery"
+ }
+ ]
+ },
+ "post": {
+ "description": "The number of tokens after the include span that can’t have overlap with the exclude span.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "pre": {
+ "description": "The number of tokens before the include span that can’t have overlap with the exclude span.",
+ "default": 0.0,
+ "type": "number"
+ }
+ },
+ "required": [
+ "exclude",
+ "include"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.SpanOrQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "clauses": {
+ "description": "Array of one or more other span type queries.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanQuery"
+ }
+ }
+ },
+ "required": [
+ "clauses"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.SpanTermQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.FieldValue"
+ }
+ ]
+ }
+ },
+ "required": [
+ "value"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.SpanWithinQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "big": {
+ "description": "Can be any span query.\nMatching spans from `little` that are enclosed within `big` are returned.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanQuery"
+ }
+ ]
+ },
+ "little": {
+ "description": "Can be any span query.\nMatching spans from `little` that are enclosed within `big` are returned.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SpanQuery"
+ }
+ ]
+ }
+ },
+ "required": [
+ "big",
+ "little"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.SparseVectorQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-sparse-vector-query"
+ },
+ "allOf": [
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The name of the field that contains the token-weight pairs to be searched against.\nThis field must be a mapped sparse_vector field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "query": {
+ "description": "The query text you want to use for search.\nIf inference_id is specified, query must also be specified.",
+ "type": "string"
+ },
+ "prune": {
+ "description": "Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance.\nIf prune is true but the pruning_config is not specified, pruning will occur but default values will be used.\nDefault: false",
+ "x-state": "Generally available",
+ "type": "boolean"
+ },
+ "pruning_config": {
+ "description": "Optional pruning configuration.\nIf enabled, this will omit non-significant tokens from the query in order to improve query performance.\nThis is only used if prune is set to true.\nIf prune is set to true but pruning_config is not specified, default values will be used.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.TokenPruningConfig"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "query_vector": {
+ "description": "Dictionary of precomputed sparse vectors and their associated weights.\nOnly one of inference_id or query_vector may be supplied in a request.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "number"
+ }
+ },
+ "inference_id": {
+ "description": "The inference ID to use to convert the query text into token-weight pairs.\nIt must be the same inference ID that was used to create the tokens from the input text.\nOnly one of inference_id and query_vector is allowed.\nIf inference_id is specified, query must also be specified.\nOnly one of inference_id or query_vector may be supplied in a request.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ }
+ ]
+ }
+ ]
+ },
+ "_types.TokenPruningConfig": {
+ "type": "object",
+ "properties": {
+ "tokens_freq_ratio_threshold": {
+ "description": "Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned.",
+ "default": 5.0,
+ "type": "number"
+ },
+ "tokens_weight_threshold": {
+ "description": "Tokens whose weight is less than this threshold are considered nonsignificant and pruned.",
+ "default": 0.4,
+ "type": "number"
+ },
+ "only_score_pruned_tokens": {
+ "description": "Whether to only score pruned tokens, vs only scoring kept tokens.",
+ "default": false,
+ "type": "boolean"
+ }
+ }
+ },
+ "_types.query_dsl.TermQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Term you wish to find in the provided field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.FieldValue"
+ }
+ ]
+ },
+ "case_insensitive": {
+ "description": "Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.\nWhen `false`, the case sensitivity of matching depends on the underlying field’s mapping.",
+ "default": false,
+ "x-state": "Generally available",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "value"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.TermsQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.query_dsl.TermsSetQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "minimum_should_match": {
+ "description": "Specification describing number of matching terms required to return a document.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.MinimumShouldMatch"
+ }
+ ]
+ },
+ "minimum_should_match_field": {
+ "description": "Numeric field containing the number of matching terms required to return a document.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "minimum_should_match_script": {
+ "description": "Custom script containing the number of matching terms required to return a document.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "terms": {
+ "description": "Array of terms you wish to find in the provided field.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.FieldValue"
+ }
+ }
+ },
+ "required": [
+ "terms"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.TextExpansionQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "model_id": {
+ "description": "The text expansion NLP model to use",
+ "type": "string"
+ },
+ "model_text": {
+ "description": "The query text",
+ "type": "string"
+ },
+ "pruning_config": {
+ "description": "Token pruning configurations",
+ "x-state": "Technical preview",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.TokenPruningConfig"
+ }
+ ]
+ }
+ },
+ "required": [
+ "model_id",
+ "model_text"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.WeightedTokensQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "tokens": {
+ "description": "The tokens representing this query",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "type": "number"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "pruning_config": {
+ "description": "Token pruning configurations",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.TokenPruningConfig"
+ }
+ ]
+ }
+ },
+ "required": [
+ "tokens"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.WildcardQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "case_insensitive": {
+ "description": "Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping.",
+ "x-state": "Generally available",
+ "type": "boolean"
+ },
+ "rewrite": {
+ "description": "Method used to rewrite the query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.MultiTermQueryRewrite"
+ }
+ ]
+ },
+ "value": {
+ "description": "Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set.",
+ "type": "string"
+ },
+ "wildcard": {
+ "description": "Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set.",
+ "type": "string"
+ }
+ }
+ }
+ ]
+ },
+ "_types.query_dsl.WrapperQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "query": {
+ "description": "A base64 encoded query.\nThe binary data format can be any of JSON, YAML, CBOR or SMILE encodings",
+ "type": "string"
+ }
+ },
+ "required": [
+ "query"
+ ]
+ }
+ ]
+ },
+ "_types.query_dsl.TypeQuery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "value"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketAggregationBase": {
+ "description": "Base type for bucket aggregations. These aggregations also accept sub-aggregations.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.Aggregation"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.Aggregation": {
+ "type": "object"
+ },
+ "_types.aggregations.AutoDateHistogramAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "description": "The target number of buckets.",
+ "default": 10.0,
+ "type": "number"
+ },
+ "field": {
+ "description": "The field on which to run the aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "format": {
+ "description": "The date format used to format `key_as_string` in the response.\nIf no `format` is specified, the first date format specified in the field mapping is used.",
+ "type": "string"
+ },
+ "minimum_interval": {
+ "description": "The minimum rounding interval.\nThis can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than `minimum_interval`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MinimumInterval"
+ }
+ ]
+ },
+ "missing": {
+ "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "offset": {
+ "description": "Time zone specified as a ISO 8601 UTC offset.",
+ "type": "string"
+ },
+ "params": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "script": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "time_zone": {
+ "description": "Time zone ID.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.TimeZone"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.MinimumInterval": {
+ "type": "string",
+ "enum": [
+ "second",
+ "minute",
+ "hour",
+ "day",
+ "month",
+ "year"
+ ]
+ },
+ "_types.aggregations.AverageAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.FormatMetricAggregationBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.FormatMetricAggregationBase": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MetricAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "format": {
+ "type": "string"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.MetricAggregationBase": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The field on which to run the aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "missing": {
+ "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.Missing"
+ }
+ ]
+ },
+ "script": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ }
+ }
+ },
+ "_types.aggregations.Missing": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ }
+ ]
+ },
+ "_types.aggregations.AverageBucketAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.PipelineAggregationBase": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketPathAggregation"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "format": {
+ "description": "`DecimalFormat` pattern for the output value.\nIf specified, the formatted value is returned in the aggregation’s `value_as_string` property.",
+ "type": "string"
+ },
+ "gap_policy": {
+ "description": "Policy to apply when gaps are found in the data.\n\nSupported values include:\n - `skip`: Treats missing data as if the bucket does not exist. It will skip the bucket and\ncontinue calculating using the next available value.\n - `insert_zeros`: Replace missing values with a zero (0) and pipeline aggregation computation will proceed as normal.\n - `keep_values`: Similar to skip, except if the metric provides a non-null, non-NaN value this value is used,\notherwise the empty bucket is skipped.\n\n",
+ "default": "skip",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.GapPolicy"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.GapPolicy": {
+ "type": "string",
+ "enum": [
+ "skip",
+ "insert_zeros",
+ "keep_values"
+ ]
+ },
+ "_types.aggregations.BucketPathAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.Aggregation"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "buckets_path": {
+ "description": "Path to the buckets that contain one set of values to correlate.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsPath"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.BucketsPath": {
+ "description": "Buckets path can be expressed in different ways, and an aggregation may accept some or all of these\nforms depending on its type. Please refer to each aggregation's documentation to know what buckets\npath forms they accept.",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.BoxplotAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MetricAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "compression": {
+ "description": "Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error.",
+ "type": "number"
+ },
+ "execution_hint": {
+ "description": "The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases).\nTo use an implementation optimized for accuracy, set this parameter to high_accuracy instead.",
+ "default": "default",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TDigestExecutionHint"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.TDigestExecutionHint": {
+ "type": "string",
+ "enum": [
+ "default",
+ "high_accuracy"
+ ]
+ },
+ "_types.aggregations.BucketScriptAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "script": {
+ "description": "The script to run for this aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.BucketSelectorAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "script": {
+ "description": "The script to run for this aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.BucketSortAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.Aggregation"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "Buckets in positions prior to `from` will be truncated.",
+ "type": "number"
+ },
+ "gap_policy": {
+ "description": "The policy to apply when gaps are found in the data.\n\nSupported values include:\n - `skip`: Treats missing data as if the bucket does not exist. It will skip the bucket and\ncontinue calculating using the next available value.\n - `insert_zeros`: Replace missing values with a zero (0) and pipeline aggregation computation will proceed as normal.\n - `keep_values`: Similar to skip, except if the metric provides a non-null, non-NaN value this value is used,\notherwise the empty bucket is skipped.\n\n",
+ "default": "skip",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.GapPolicy"
+ }
+ ]
+ },
+ "size": {
+ "description": "The number of buckets to return.\nDefaults to all buckets of the parent aggregation.",
+ "type": "number"
+ },
+ "sort": {
+ "description": "The list of fields to sort on.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Sort"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.BucketKsAggregation": {
+ "description": "A sibling pipeline aggregation which executes a two sample Kolmogorov–Smirnov test (referred\nto as a \"K-S test\" from now on) against a provided distribution, and the distribution implied\nby the documents counts in the configured sibling aggregation. Specifically, for some metric,\nassuming that the percentile intervals of the metric are known beforehand or have been computed\nby an aggregation, then one would use range aggregation for the sibling to compute the p-value\nof the distribution difference between the metric and the restriction of that metric to a subset\nof the documents. A natural use case is if the sibling aggregation range aggregation nested in a\nterms aggregation, in which case one compares the overall distribution of metric to its restriction\nto each term.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketPathAggregation"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "alternative": {
+ "description": "A list of string values indicating which K-S test alternative to calculate. The valid values\nare: \"greater\", \"less\", \"two_sided\". This parameter is key for determining the K-S statistic used\nwhen calculating the K-S test. Default value is all possible alternative hypotheses.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "fractions": {
+ "description": "A list of doubles indicating the distribution of the samples with which to compare to the `buckets_path` results.\nIn typical usage this is the overall proportion of documents in each bucket, which is compared with the actual\ndocument proportions in each bucket from the sibling aggregation counts. The default is to assume that overall\ndocuments are uniformly distributed on these buckets, which they would be if one used equal percentiles of a\nmetric to define the bucket end points.",
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ },
+ "sampling_method": {
+ "description": "Indicates the sampling methodology when calculating the K-S test. Note, this is sampling of the returned values.\nThis determines the cumulative distribution function (CDF) points used comparing the two samples. Default is\n`upper_tail`, which emphasizes the upper end of the CDF points. Valid options are: `upper_tail`, `uniform`,\nand `lower_tail`.",
+ "type": "string"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.BucketCorrelationAggregation": {
+ "description": "A sibling pipeline aggregation which executes a correlation function on the configured sibling multi-bucket aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketPathAggregation"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "function": {
+ "description": "The correlation function to execute.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketCorrelationFunction"
+ }
+ ]
+ }
+ },
+ "required": [
+ "function"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.BucketCorrelationFunction": {
+ "type": "object",
+ "properties": {
+ "count_correlation": {
+ "description": "The configuration to calculate a count correlation. This function is designed for determining the correlation of a term value and a given metric.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketCorrelationFunctionCountCorrelation"
+ }
+ ]
+ }
+ },
+ "required": [
+ "count_correlation"
+ ]
+ },
+ "_types.aggregations.BucketCorrelationFunctionCountCorrelation": {
+ "type": "object",
+ "properties": {
+ "indicator": {
+ "description": "The indicator with which to correlate the configured `bucket_path` values.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator"
+ }
+ ]
+ }
+ },
+ "required": [
+ "indicator"
+ ]
+ },
+ "_types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator": {
+ "type": "object",
+ "properties": {
+ "doc_count": {
+ "description": "The total number of documents that initially created the expectations. It’s required to be greater\nthan or equal to the sum of all values in the buckets_path as this is the originating superset of data\nto which the term values are correlated.",
+ "type": "number"
+ },
+ "expectations": {
+ "description": "An array of numbers with which to correlate the configured `bucket_path` values.\nThe length of this value must always equal the number of buckets returned by the `bucket_path`.",
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ },
+ "fractions": {
+ "description": "An array of fractions to use when averaging and calculating variance. This should be used if\nthe pre-calculated data and the buckets_path have known gaps. The length of fractions, if provided,\nmust equal expectations.",
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ },
+ "required": [
+ "doc_count",
+ "expectations"
+ ]
+ },
+ "_types.aggregations.CardinalityAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MetricAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "precision_threshold": {
+ "description": "A unique count below which counts are expected to be close to accurate.\nThis allows to trade memory for accuracy.",
+ "default": 3000.0,
+ "type": "number"
+ },
+ "rehash": {
+ "type": "boolean"
+ },
+ "execution_hint": {
+ "description": "Mechanism by which cardinality aggregations is run.\n\nSupported values include:\n - `global_ordinals`: Run the aggregation by using global ordinals of the field and resolving those values after finishing a shard.\n - `segment_ordinals`: Run the aggregation by using segment ordinal values and resolving those values after each segment.\n - `direct`: Run the aggregation by using field values directly.\n - `save_memory_heuristic`: Heuristic-based mode, default in Elasticsearch 8.3 and earlier.\n - `save_time_heuristic`: Heuristic-based mode, default in Elasticsearch 8.4 and later.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CardinalityExecutionMode"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.CardinalityExecutionMode": {
+ "type": "string",
+ "enum": [
+ "global_ordinals",
+ "segment_ordinals",
+ "direct",
+ "save_memory_heuristic",
+ "save_time_heuristic"
+ ]
+ },
+ "_types.aggregations.CategorizeTextAggregation": {
+ "description": "A multi-bucket aggregation that groups semi-structured text into buckets. Each text\nfield is re-analyzed using a custom analyzer. The resulting tokens are then categorized\ncreating buckets of similarly formatted text values. This aggregation works best with machine\ngenerated text like system logs. Only the first 100 analyzed tokens are used to categorize the text.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.Aggregation"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The semi-structured text field to categorize.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "max_unique_tokens": {
+ "description": "The maximum number of unique tokens at any position up to max_matched_tokens. Must be larger than 1.\nSmaller values use less memory and create fewer categories. Larger values will use more memory and\ncreate narrower categories. Max allowed value is 100.",
+ "default": 50.0,
+ "type": "number"
+ },
+ "max_matched_tokens": {
+ "description": "The maximum number of token positions to match on before attempting to merge categories. Larger\nvalues will use more memory and create narrower categories. Max allowed value is 100.",
+ "default": 5.0,
+ "type": "number"
+ },
+ "similarity_threshold": {
+ "description": "The minimum percentage of tokens that must match for text to be added to the category bucket. Must\nbe between 1 and 100. The larger the value the narrower the categories. Larger values will increase memory\nusage and create narrower categories.",
+ "default": 50.0,
+ "type": "number"
+ },
+ "categorization_filters": {
+ "description": "This property expects an array of regular expressions. The expressions are used to filter out matching\nsequences from the categorization field values. You can use this functionality to fine tune the categorization\nby excluding sequences from consideration when categories are defined. For example, you can exclude SQL\nstatements that appear in your log files. This property cannot be used at the same time as categorization_analyzer.\nIf you only want to define simple regular expression filters that are applied prior to tokenization, setting\nthis property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering,\nuse the categorization_analyzer property instead and include the filters as pattern_replace character filters.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "categorization_analyzer": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-analyze"
+ },
+ "description": "The categorization analyzer specifies how the text is analyzed and tokenized before being categorized.\nThe syntax is very similar to that used to define the analyzer in the analyze API. This property\ncannot be used at the same time as `categorization_filters`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CategorizeTextAnalyzer"
+ }
+ ]
+ },
+ "shard_size": {
+ "description": "The number of categorization buckets to return from each shard before merging all the results.",
+ "type": "number"
+ },
+ "size": {
+ "description": "The number of buckets to return.",
+ "default": 10.0,
+ "type": "number"
+ },
+ "min_doc_count": {
+ "description": "The minimum number of documents in a bucket to be returned to the results.",
+ "type": "number"
+ },
+ "shard_min_doc_count": {
+ "description": "The minimum number of documents in a bucket to be returned from the shard before merging.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "field"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.CategorizeTextAnalyzer": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CustomCategorizeTextAnalyzer"
+ }
+ ]
+ },
+ "_types.aggregations.CustomCategorizeTextAnalyzer": {
+ "type": "object",
+ "properties": {
+ "char_filter": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "tokenizer": {
+ "type": "string"
+ },
+ "filter": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "_types.aggregations.ChildrenAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The child type that should be selected.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RelationName"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.CompositeAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "after": {
+ "description": "When paginating, use the `after_key` value returned in the previous response to retrieve the next page.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CompositeAggregateKey"
+ }
+ ]
+ },
+ "size": {
+ "description": "The number of composite buckets that should be returned.",
+ "default": 10.0,
+ "type": "number"
+ },
+ "sources": {
+ "description": "The value sources used to build composite buckets.\nKeys are returned in the order of the `sources` definition.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.CompositeAggregationSource"
+ }
+ }
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.CompositeAggregationSource": {
+ "type": "object",
+ "properties": {
+ "terms": {
+ "description": "A terms aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CompositeTermsAggregation"
+ }
+ ]
+ },
+ "histogram": {
+ "description": "A histogram aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CompositeHistogramAggregation"
+ }
+ ]
+ },
+ "date_histogram": {
+ "description": "A date histogram aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CompositeDateHistogramAggregation"
+ }
+ ]
+ },
+ "geotile_grid": {
+ "description": "A geotile grid aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CompositeGeoTileGridAggregation"
+ }
+ ]
+ }
+ }
+ },
+ "_types.aggregations.CompositeTermsAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CompositeAggregationBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.CompositeAggregationBase": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "Either `field` or `script` must be present",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "missing_bucket": {
+ "type": "boolean"
+ },
+ "missing_order": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MissingOrder"
+ }
+ ]
+ },
+ "script": {
+ "description": "Either `field` or `script` must be present",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "value_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ValueType"
+ }
+ ]
+ },
+ "order": {
+ "description": "\n\nSupported values include:\n - `asc`: Ascending (smallest to largest)\n - `desc`: Descending (largest to smallest)\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SortOrder"
+ }
+ ]
+ }
+ }
+ },
+ "_types.aggregations.MissingOrder": {
+ "type": "string",
+ "enum": [
+ "first",
+ "last",
+ "default"
+ ]
+ },
+ "_types.aggregations.ValueType": {
+ "type": "string",
+ "enum": [
+ "string",
+ "long",
+ "double",
+ "number",
+ "date",
+ "date_nanos",
+ "ip",
+ "numeric",
+ "geo_point",
+ "boolean"
+ ]
+ },
+ "_types.aggregations.CompositeHistogramAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CompositeAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "interval": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "interval"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.CompositeDateHistogramAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CompositeAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "format": {
+ "type": "string"
+ },
+ "calendar_interval": {
+ "description": "Either `calendar_interval` or `fixed_interval` must be present",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationLarge"
+ }
+ ]
+ },
+ "fixed_interval": {
+ "description": "Either `calendar_interval` or `fixed_interval` must be present",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationLarge"
+ }
+ ]
+ },
+ "offset": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "time_zone": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.TimeZone"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.CompositeGeoTileGridAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CompositeAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "precision": {
+ "type": "number"
+ },
+ "bounds": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoBounds"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.CumulativeCardinalityAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.CumulativeSumAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.DateHistogramAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "calendar_interval": {
+ "description": "Calendar-aware interval.\nCan be specified using the unit name, such as `month`, or as a single unit quantity, such as `1M`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CalendarInterval"
+ }
+ ]
+ },
+ "extended_bounds": {
+ "description": "Enables extending the bounds of the histogram beyond the data itself.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ExtendedBoundsFieldDateMath"
+ }
+ ]
+ },
+ "hard_bounds": {
+ "description": "Limits the histogram to specified bounds.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ExtendedBoundsFieldDateMath"
+ }
+ ]
+ },
+ "field": {
+ "description": "The date field whose values are use to build a histogram.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "fixed_interval": {
+ "description": "Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "format": {
+ "description": "The date format used to format `key_as_string` in the response.\nIf no `format` is specified, the first date format specified in the field mapping is used.",
+ "type": "string"
+ },
+ "interval": {
+ "deprecated": true,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "min_doc_count": {
+ "description": "Only returns buckets that have `min_doc_count` number of documents.\nBy default, all buckets between the first bucket that matches documents and the last one are returned.",
+ "type": "number"
+ },
+ "missing": {
+ "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "offset": {
+ "description": "Changes the start value of each bucket by the specified positive (`+`) or negative offset (`-`) duration.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "order": {
+ "description": "The sort order of the returned buckets.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateOrder"
+ }
+ ]
+ },
+ "params": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "script": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "time_zone": {
+ "description": "Time zone used for bucketing and rounding.\nDefaults to Coordinated Universal Time (UTC).",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.TimeZone"
+ }
+ ]
+ },
+ "keyed": {
+ "description": "Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array.",
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.CalendarInterval": {
+ "type": "string",
+ "enum": [
+ "second",
+ "1s",
+ "minute",
+ "1m",
+ "hour",
+ "1h",
+ "day",
+ "1d",
+ "week",
+ "1w",
+ "month",
+ "1M",
+ "quarter",
+ "1q",
+ "year",
+ "1y"
+ ]
+ },
+ "_types.aggregations.ExtendedBoundsFieldDateMath": {
+ "type": "object",
+ "properties": {
+ "max": {
+ "description": "Maximum value for the bound.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.FieldDateMath"
+ }
+ ]
+ },
+ "min": {
+ "description": "Minimum value for the bound.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.FieldDateMath"
+ }
+ ]
+ }
+ }
+ },
+ "_types.aggregations.FieldDateMath": {
+ "description": "A date range limit, represented either as a DateMath expression or a number expressed\naccording to the target field's precision.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateMath"
+ },
+ {
+ "type": "number"
+ }
+ ]
+ },
+ "_types.aggregations.AggregateOrder": {
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.SortOrder"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.SortOrder"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ }
+ }
+ ]
+ },
+ "_types.aggregations.DateRangeAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The date field whose values are use to build ranges.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "format": {
+ "description": "The date format used to format `from` and `to` in the response.",
+ "type": "string"
+ },
+ "missing": {
+ "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.Missing"
+ }
+ ]
+ },
+ "ranges": {
+ "description": "Array of date ranges.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.DateRangeExpression"
+ }
+ },
+ "time_zone": {
+ "description": "Time zone used to convert dates from another time zone to UTC.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.TimeZone"
+ }
+ ]
+ },
+ "keyed": {
+ "description": "Set to `true` to associate a unique string key with each bucket and returns the ranges as a hash rather than an array.",
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.DateRangeExpression": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "Start of the range (inclusive).",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.FieldDateMath"
+ }
+ ]
+ },
+ "key": {
+ "description": "Custom key to return the range with.",
+ "type": "string"
+ },
+ "to": {
+ "description": "End of the range (exclusive).",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.FieldDateMath"
+ }
+ ]
+ }
+ }
+ },
+ "_types.aggregations.DerivativeAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.DiversifiedSamplerAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "execution_hint": {
+ "description": "The type of value used for de-duplication.\n\nSupported values include:\n - `map`: Hold field values directly.\n - `global_ordinals`: Hold ordinals of the field as determined by the Lucene index.\n - `bytes_hash`: Hold hashes of the field values - with potential for hash collisions.\n\n",
+ "default": "global_ordinals",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SamplerAggregationExecutionHint"
+ }
+ ]
+ },
+ "max_docs_per_value": {
+ "description": "Limits how many documents are permitted per choice of de-duplicating value.",
+ "default": 1.0,
+ "type": "number"
+ },
+ "script": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "shard_size": {
+ "description": "Limits how many top-scoring documents are collected in the sample processed on each shard.",
+ "default": 100.0,
+ "type": "number"
+ },
+ "field": {
+ "description": "The field used to provide values used for de-duplication.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.SamplerAggregationExecutionHint": {
+ "type": "string",
+ "enum": [
+ "map",
+ "global_ordinals",
+ "bytes_hash"
+ ]
+ },
+ "_types.aggregations.ExtendedStatsAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.FormatMetricAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "sigma": {
+ "description": "The number of standard deviations above/below the mean to display.",
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.ExtendedStatsBucketAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "sigma": {
+ "description": "The number of standard deviations above/below the mean to display.",
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.FrequentItemSetsAggregation": {
+ "type": "object",
+ "properties": {
+ "fields": {
+ "description": "Fields to analyze.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.FrequentItemSetsField"
+ }
+ },
+ "minimum_set_size": {
+ "description": "The minimum size of one item set.",
+ "default": 1.0,
+ "type": "number"
+ },
+ "minimum_support": {
+ "description": "The minimum support of one item set.",
+ "default": 0.1,
+ "type": "number"
+ },
+ "size": {
+ "description": "The number of top item sets to return.",
+ "default": 10.0,
+ "type": "number"
+ },
+ "filter": {
+ "description": "Query that filters documents from analysis.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ }
+ },
+ "required": [
+ "fields"
+ ]
+ },
+ "_types.aggregations.FrequentItemSetsField": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "exclude": {
+ "description": "Values to exclude.\nCan be regular expression strings or arrays of strings of exact terms.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsExclude"
+ }
+ ]
+ },
+ "include": {
+ "description": "Values to include.\nCan be regular expression strings or arrays of strings of exact terms.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsInclude"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field"
+ ]
+ },
+ "_types.aggregations.TermsExclude": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.TermsInclude": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsPartition"
+ }
+ ]
+ },
+ "_types.aggregations.TermsPartition": {
+ "type": "object",
+ "properties": {
+ "num_partitions": {
+ "description": "The number of partitions.",
+ "type": "number"
+ },
+ "partition": {
+ "description": "The partition number for this request.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "num_partitions",
+ "partition"
+ ]
+ },
+ "_types.aggregations.FiltersAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "filters": {
+ "description": "Collection of queries from which to build buckets.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsQueryContainer"
+ }
+ ]
+ },
+ "other_bucket": {
+ "description": "Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters.",
+ "type": "boolean"
+ },
+ "other_bucket_key": {
+ "description": "The key with which the other bucket is returned.",
+ "default": "_other_",
+ "type": "string"
+ },
+ "keyed": {
+ "description": "By default, the named filters aggregation returns the buckets as an object.\nSet to `false` to return the buckets as an array of objects.",
+ "default": true,
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.BucketsQueryContainer": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ }
+ ]
+ },
+ "_types.aggregations.GeoBoundsAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MetricAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "wrap_longitude": {
+ "description": "Specifies whether the bounding box should be allowed to overlap the international date line.",
+ "default": true,
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.GeoCentroidAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MetricAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number"
+ },
+ "location": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoLocation"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.GeoDistanceAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "distance_type": {
+ "description": "The distance calculation type.\n\nSupported values include:\n - `arc`: The `arc` calculation is the most accurate.\n - `plane`: The `plane` calculation is faster but less accurate.\n\n",
+ "default": "arc",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoDistanceType"
+ }
+ ]
+ },
+ "field": {
+ "description": "A field of type `geo_point` used to evaluate the distance.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "origin": {
+ "description": "The origin used to evaluate the distance.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoLocation"
+ }
+ ]
+ },
+ "ranges": {
+ "description": "An array of ranges used to bucket documents.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.AggregationRange"
+ }
+ },
+ "unit": {
+ "description": "The distance unit.",
+ "default": "m",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DistanceUnit"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.AggregationRange": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "Start of the range (inclusive).",
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "key": {
+ "description": "Custom key to return the range with.",
+ "type": "string"
+ },
+ "to": {
+ "description": "End of the range (exclusive).",
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "_types.aggregations.GeoHashGridAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "bounds": {
+ "description": "The bounding box to filter the points in each bucket.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoBounds"
+ }
+ ]
+ },
+ "field": {
+ "description": "Field containing indexed `geo_point` or `geo_shape` values.\nIf the field contains an array, `geohash_grid` aggregates all array values.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "precision": {
+ "description": "The string length of the geohashes used to define cells/buckets in the results.",
+ "default": "5",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoHashPrecision"
+ }
+ ]
+ },
+ "shard_size": {
+ "description": "Allows for more accurate counting of the top cells returned in the final result the aggregation.\nDefaults to returning `max(10,(size x number-of-shards))` buckets from each shard.",
+ "type": "number"
+ },
+ "size": {
+ "description": "The maximum number of geohash buckets to return.",
+ "default": 10000.0,
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "_types.GeoHashPrecision": {
+ "description": "A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like \"1km\", \"10m\".",
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "_types.aggregations.GeoLineAggregation": {
+ "type": "object",
+ "properties": {
+ "point": {
+ "description": "The name of the geo_point field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.GeoLinePoint"
+ }
+ ]
+ },
+ "sort": {
+ "description": "The name of the numeric field to use as the sort key for ordering the points.\nWhen the `geo_line` aggregation is nested inside a `time_series` aggregation, this field defaults to `@timestamp`, and any other value will result in error.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.GeoLineSort"
+ }
+ ]
+ },
+ "include_sort": {
+ "description": "When `true`, returns an additional array of the sort values in the feature properties.",
+ "type": "boolean"
+ },
+ "sort_order": {
+ "description": "The order in which the line is sorted (ascending or descending).\n\nSupported values include:\n - `asc`: Ascending (smallest to largest)\n - `desc`: Descending (largest to smallest)\n\n",
+ "default": "asc",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SortOrder"
+ }
+ ]
+ },
+ "size": {
+ "description": "The maximum length of the line represented in the aggregation.\nValid sizes are between 1 and 10000.",
+ "default": 10000.0,
+ "type": "number"
+ }
+ },
+ "required": [
+ "point",
+ "sort"
+ ]
+ },
+ "_types.aggregations.GeoLinePoint": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The name of the geo_point field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field"
+ ]
+ },
+ "_types.aggregations.GeoLineSort": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The name of the numeric field to use as the sort key for ordering the points.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field"
+ ]
+ },
+ "_types.aggregations.GeoTileGridAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "Field containing indexed `geo_point` or `geo_shape` values.\nIf the field contains an array, `geotile_grid` aggregates all array values.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "precision": {
+ "description": "Integer zoom of the key used to define cells/buckets in the results.\nValues outside of the range [0,29] will be rejected.",
+ "default": "7",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoTilePrecision"
+ }
+ ]
+ },
+ "shard_size": {
+ "description": "Allows for more accurate counting of the top cells returned in the final result the aggregation.\nDefaults to returning `max(10,(size x number-of-shards))` buckets from each shard.",
+ "type": "number"
+ },
+ "size": {
+ "description": "The maximum number of buckets to return.",
+ "default": 10000.0,
+ "type": "number"
+ },
+ "bounds": {
+ "description": "A bounding box to filter the geo-points or geo-shapes in each bucket.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoBounds"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.GeoTilePrecision": {
+ "type": "number"
+ },
+ "_types.aggregations.GeohexGridAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "Field containing indexed `geo_point` or `geo_shape` values.\nIf the field contains an array, `geohex_grid` aggregates all array values.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "precision": {
+ "description": "Integer zoom of the key used to defined cells or buckets\nin the results. Value should be between 0-15.",
+ "default": 6.0,
+ "type": "number"
+ },
+ "bounds": {
+ "description": "Bounding box used to filter the geo-points in each bucket.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoBounds"
+ }
+ ]
+ },
+ "size": {
+ "description": "Maximum number of buckets to return.",
+ "default": 10000.0,
+ "type": "number"
+ },
+ "shard_size": {
+ "description": "Number of buckets returned from each shard.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "field"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.GlobalAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.HistogramAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "extended_bounds": {
+ "description": "Enables extending the bounds of the histogram beyond the data itself.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ExtendedBoundsdouble"
+ }
+ ]
+ },
+ "hard_bounds": {
+ "description": "Limits the range of buckets in the histogram.\nIt is particularly useful in the case of open data ranges that can result in a very large number of buckets.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ExtendedBoundsdouble"
+ }
+ ]
+ },
+ "field": {
+ "description": "The name of the field to aggregate on.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "interval": {
+ "description": "The interval for the buckets.\nMust be a positive decimal.",
+ "type": "number"
+ },
+ "min_doc_count": {
+ "description": "Only returns buckets that have `min_doc_count` number of documents.\nBy default, the response will fill gaps in the histogram with empty buckets.",
+ "type": "number"
+ },
+ "missing": {
+ "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.",
+ "type": "number"
+ },
+ "offset": {
+ "description": "By default, the bucket keys start with 0 and then continue in even spaced steps of `interval`.\nThe bucket boundaries can be shifted by using the `offset` option.",
+ "type": "number"
+ },
+ "order": {
+ "description": "The sort order of the returned buckets.\nBy default, the returned buckets are sorted by their key ascending.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateOrder"
+ }
+ ]
+ },
+ "script": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "format": {
+ "type": "string"
+ },
+ "keyed": {
+ "description": "If `true`, returns buckets as a hash instead of an array, keyed by the bucket keys.",
+ "default": false,
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.ExtendedBoundsdouble": {
+ "type": "object",
+ "properties": {
+ "max": {
+ "description": "Maximum value for the bound.",
+ "type": "number"
+ },
+ "min": {
+ "description": "Minimum value for the bound.",
+ "type": "number"
+ }
+ }
+ },
+ "_types.aggregations.IpRangeAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The date field whose values are used to build ranges.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "ranges": {
+ "description": "Array of IP ranges.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.IpRangeAggregationRange"
+ }
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.IpRangeAggregationRange": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "Start of the range.",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "mask": {
+ "description": "IP range defined as a CIDR mask.",
+ "type": "string"
+ },
+ "to": {
+ "description": "End of the range.",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "_types.aggregations.IpPrefixAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The IP address field to aggregation on. The field mapping type must be `ip`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "prefix_length": {
+ "description": "Length of the network prefix. For IPv4 addresses the accepted range is [0, 32].\nFor IPv6 addresses the accepted range is [0, 128].",
+ "type": "number"
+ },
+ "is_ipv6": {
+ "description": "Defines whether the prefix applies to IPv6 addresses.",
+ "default": false,
+ "type": "boolean"
+ },
+ "append_prefix_length": {
+ "description": "Defines whether the prefix length is appended to IP address keys in the response.",
+ "default": false,
+ "type": "boolean"
+ },
+ "keyed": {
+ "description": "Defines whether buckets are returned as a hash rather than an array in the response.",
+ "type": "boolean"
+ },
+ "min_doc_count": {
+ "description": "Minimum number of documents in a bucket for it to be included in the response.",
+ "default": 1.0,
+ "type": "number"
+ }
+ },
+ "required": [
+ "field",
+ "prefix_length"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.InferenceAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "model_id": {
+ "description": "The ID or alias for the trained model.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "inference_config": {
+ "description": "Contains the inference type and its options.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.InferenceConfigContainer"
+ }
+ ]
+ }
+ },
+ "required": [
+ "model_id"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.InferenceConfigContainer": {
+ "type": "object",
+ "properties": {
+ "regression": {
+ "description": "Regression configuration for inference.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.RegressionInferenceOptions"
+ }
+ ]
+ },
+ "classification": {
+ "description": "Classification configuration for inference.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.ClassificationInferenceOptions"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "ml._types.RegressionInferenceOptions": {
+ "type": "object",
+ "properties": {
+ "results_field": {
+ "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "num_top_feature_importance_values": {
+ "description": "Specifies the maximum number of feature importance values per document.",
+ "default": 0.0,
+ "type": "number"
+ }
+ }
+ },
+ "ml._types.ClassificationInferenceOptions": {
+ "type": "object",
+ "properties": {
+ "num_top_classes": {
+ "description": "Specifies the number of top class predictions to return. Defaults to 0.",
+ "type": "number"
+ },
+ "num_top_feature_importance_values": {
+ "description": "Specifies the maximum number of feature importance values per document.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "prediction_field_type": {
+ "description": "Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false.",
+ "type": "string"
+ },
+ "results_field": {
+ "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
+ "type": "string"
+ },
+ "top_classes_results_field": {
+ "description": "Specifies the field to which the top classes are written. Defaults to top_classes.",
+ "type": "string"
+ }
+ }
+ },
+ "_types.aggregations.MatrixStatsAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MatrixAggregation"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "mode": {
+ "description": "Array value the aggregation will use for array or multi-valued fields.",
+ "default": "avg",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SortMode"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.MatrixAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.Aggregation"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "fields": {
+ "description": "An array of fields for computing the statistics.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ },
+ "missing": {
+ "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.MaxAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.FormatMetricAggregationBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.MaxBucketAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.MedianAbsoluteDeviationAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.FormatMetricAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "compression": {
+ "description": "Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error.",
+ "default": 1000.0,
+ "type": "number"
+ },
+ "execution_hint": {
+ "description": "The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases).\nTo use an implementation optimized for accuracy, set this parameter to high_accuracy instead.",
+ "default": "default",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TDigestExecutionHint"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.MinAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.FormatMetricAggregationBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.MinBucketAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.MissingAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The name of the field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "missing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.Missing"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.MovingAverageAggregation": {
+ "discriminator": {
+ "propertyName": "model"
+ },
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.LinearMovingAverageAggregation"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.SimpleMovingAverageAggregation"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.EwmaMovingAverageAggregation"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.HoltMovingAverageAggregation"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.HoltWintersMovingAverageAggregation"
+ }
+ ]
+ },
+ "_types.aggregations.LinearMovingAverageAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MovingAverageAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "model": {
+ "type": "string",
+ "enum": [
+ "linear"
+ ]
+ },
+ "settings": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EmptyObject"
+ }
+ ]
+ }
+ },
+ "required": [
+ "model",
+ "settings"
+ ]
+ }
+ ]
+ },
+ "_types.EmptyObject": {
+ "description": "For empty Class assignments",
+ "type": "object"
+ },
+ "_types.aggregations.MovingAverageAggregationBase": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "minimize": {
+ "type": "boolean"
+ },
+ "predict": {
+ "type": "number"
+ },
+ "window": {
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.SimpleMovingAverageAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MovingAverageAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "model": {
+ "type": "string",
+ "enum": [
+ "simple"
+ ]
+ },
+ "settings": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EmptyObject"
+ }
+ ]
+ }
+ },
+ "required": [
+ "model",
+ "settings"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.EwmaMovingAverageAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MovingAverageAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "model": {
+ "type": "string",
+ "enum": [
+ "ewma"
+ ]
+ },
+ "settings": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.EwmaModelSettings"
+ }
+ ]
+ }
+ },
+ "required": [
+ "model",
+ "settings"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.EwmaModelSettings": {
+ "type": "object",
+ "properties": {
+ "alpha": {
+ "type": "number"
+ }
+ }
+ },
+ "_types.aggregations.HoltMovingAverageAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MovingAverageAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "model": {
+ "type": "string",
+ "enum": [
+ "holt"
+ ]
+ },
+ "settings": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.HoltLinearModelSettings"
+ }
+ ]
+ }
+ },
+ "required": [
+ "model",
+ "settings"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.HoltLinearModelSettings": {
+ "type": "object",
+ "properties": {
+ "alpha": {
+ "type": "number"
+ },
+ "beta": {
+ "type": "number"
+ }
+ }
+ },
+ "_types.aggregations.HoltWintersMovingAverageAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MovingAverageAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "model": {
+ "type": "string",
+ "enum": [
+ "holt_winters"
+ ]
+ },
+ "settings": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.HoltWintersModelSettings"
+ }
+ ]
+ }
+ },
+ "required": [
+ "model",
+ "settings"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.HoltWintersModelSettings": {
+ "type": "object",
+ "properties": {
+ "alpha": {
+ "type": "number"
+ },
+ "beta": {
+ "type": "number"
+ },
+ "gamma": {
+ "type": "number"
+ },
+ "pad": {
+ "type": "boolean"
+ },
+ "period": {
+ "type": "number"
+ },
+ "type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.HoltWintersType"
+ }
+ ]
+ }
+ }
+ },
+ "_types.aggregations.HoltWintersType": {
+ "type": "string",
+ "enum": [
+ "add",
+ "mult"
+ ]
+ },
+ "_types.aggregations.MovingPercentilesAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "window": {
+ "description": "The size of window to \"slide\" across the histogram.",
+ "type": "number"
+ },
+ "shift": {
+ "description": "By default, the window consists of the last n values excluding the current bucket.\nIncreasing `shift` by 1, moves the starting window position by 1 to the right.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "keyed": {
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.MovingFunctionAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "script": {
+ "description": "The script that should be executed on each window of data.",
+ "type": "string"
+ },
+ "shift": {
+ "description": "By default, the window consists of the last n values excluding the current bucket.\nIncreasing `shift` by 1, moves the starting window position by 1 to the right.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "window": {
+ "description": "The size of window to \"slide\" across the histogram.",
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.MultiTermsAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "collect_mode": {
+ "description": "Specifies the strategy for data collection.\n\nSupported values include:\n - `depth_first`: Expands all branches of the aggregation tree in one depth-first pass, before any pruning occurs.\n - `breadth_first`: Caches the set of documents that fall into the uppermost buckets for subsequent replay.\n\n",
+ "default": "breadth_first",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsAggregationCollectMode"
+ }
+ ]
+ },
+ "order": {
+ "description": "Specifies the sort order of the buckets.\nDefaults to sorting by descending document count.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateOrder"
+ }
+ ]
+ },
+ "min_doc_count": {
+ "description": "The minimum number of documents in a bucket for it to be returned.",
+ "default": 1.0,
+ "type": "number"
+ },
+ "shard_min_doc_count": {
+ "description": "The minimum number of documents in a bucket on each shard for it to be returned.",
+ "default": 1.0,
+ "type": "number"
+ },
+ "shard_size": {
+ "description": "The number of candidate terms produced by each shard.\nBy default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter.",
+ "type": "number"
+ },
+ "show_term_doc_count_error": {
+ "description": "Calculates the doc count error on per term basis.",
+ "default": false,
+ "type": "boolean"
+ },
+ "size": {
+ "description": "The number of term buckets should be returned out of the overall terms list.",
+ "default": 10.0,
+ "type": "number"
+ },
+ "terms": {
+ "description": "The field from which to generate sets of terms.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.MultiTermLookup"
+ }
+ }
+ },
+ "required": [
+ "terms"
+ ]
+ }
+ ]
+ },
+ "_types.aggregations.TermsAggregationCollectMode": {
+ "type": "string",
+ "enum": [
+ "depth_first",
+ "breadth_first"
+ ]
+ },
+ "_types.aggregations.MultiTermLookup": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "A fields from which to retrieve terms.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "missing": {
+ "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.Missing"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field"
+ ]
+ },
+ "_types.aggregations.NestedAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "path": {
+ "description": "The path to the field of type `nested`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.NormalizeAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "method": {
+ "description": "The specific method to apply.\n\nSupported values include:\n - `rescale_0_1`: This method rescales the data such that the minimum number is 0, and the maximum number is 1, with the rest normalized linearly in-between.\n - `rescale_0_100`: This method rescales the data such that the minimum number is 0, and the maximum number is 100, with the rest normalized linearly in-between.\n - `percent_of_sum`: This method normalizes each value so that it represents a percentage of the total sum it attributes to.\n - `mean`: This method normalizes such that each value is normalized by how much it differs from the average.\n - `z-score`: This method normalizes such that each value represents how far it is from the mean relative to the standard deviation.\n - `softmax`: This method normalizes such that each value is exponentiated and relative to the sum of the exponents of the original values.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.NormalizeMethod"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.NormalizeMethod": {
+ "type": "string",
+ "enum": [
+ "rescale_0_1",
+ "rescale_0_100",
+ "percent_of_sum",
+ "mean",
+ "z-score",
+ "softmax"
+ ]
+ },
+ "_types.aggregations.ParentAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The child type that should be selected.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RelationName"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.PercentileRanksAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.FormatMetricAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "keyed": {
+ "description": "By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array.\nSet to `false` to disable this behavior.",
+ "default": true,
+ "type": "boolean"
+ },
+ "values": {
+ "description": "An array of values for which to calculate the percentile ranks.",
+ "oneOf": [
+ {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "hdr": {
+ "description": "Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.HdrMethod"
+ }
+ ]
+ },
+ "tdigest": {
+ "description": "Sets parameters for the default TDigest algorithm used to calculate percentile ranks.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TDigest"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.HdrMethod": {
+ "type": "object",
+ "properties": {
+ "number_of_significant_value_digits": {
+ "description": "Specifies the resolution of values for the histogram in number of significant digits.",
+ "type": "number"
+ }
+ }
+ },
+ "_types.aggregations.TDigest": {
+ "type": "object",
+ "properties": {
+ "compression": {
+ "description": "Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error.",
+ "type": "number"
+ },
+ "execution_hint": {
+ "description": "The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases).\nTo use an implementation optimized for accuracy, set this parameter to high_accuracy instead.",
+ "default": "default",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TDigestExecutionHint"
+ }
+ ]
+ }
+ }
+ },
+ "_types.aggregations.PercentilesAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.FormatMetricAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "keyed": {
+ "description": "By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array.\nSet to `false` to disable this behavior.",
+ "default": true,
+ "type": "boolean"
+ },
+ "percents": {
+ "description": "The percentiles to calculate.",
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ },
+ "hdr": {
+ "description": "Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.HdrMethod"
+ }
+ ]
+ },
+ "tdigest": {
+ "description": "Sets parameters for the default TDigest algorithm used to calculate percentiles.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TDigest"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.PercentilesBucketAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "percents": {
+ "description": "The list of percentiles to calculate.",
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.RangeAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The date field whose values are use to build ranges.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "missing": {
+ "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.",
+ "type": "number"
+ },
+ "ranges": {
+ "description": "An array of ranges used to bucket documents.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.AggregationRange"
+ }
+ },
+ "script": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "keyed": {
+ "description": "Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array.",
+ "type": "boolean"
+ },
+ "format": {
+ "type": "string"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.RareTermsAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "exclude": {
+ "description": "Terms that should be excluded from the aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsExclude"
+ }
+ ]
+ },
+ "field": {
+ "description": "The field from which to return rare terms.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "include": {
+ "description": "Terms that should be included in the aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsInclude"
+ }
+ ]
+ },
+ "max_doc_count": {
+ "description": "The maximum number of documents a term should appear in.",
+ "default": 1.0,
+ "type": "number"
+ },
+ "missing": {
+ "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.Missing"
+ }
+ ]
+ },
+ "precision": {
+ "description": "The precision of the internal CuckooFilters.\nSmaller precision leads to better approximation, but higher memory usage.",
+ "default": 0.001,
+ "type": "number"
+ },
+ "value_type": {
+ "type": "string"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.RateAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.FormatMetricAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "unit": {
+ "description": "The interval used to calculate the rate.\nBy default, the interval of the `date_histogram` is used.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CalendarInterval"
+ }
+ ]
+ },
+ "mode": {
+ "description": "How the rate is calculated.\n\nSupported values include:\n - `sum`: Calculates the sum of all values of the field.\n - `value_count`: Uses the number of values of the field.\n\n",
+ "default": "sum",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.RateMode"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.RateMode": {
+ "type": "string",
+ "enum": [
+ "sum",
+ "value_count"
+ ]
+ },
+ "_types.aggregations.ReverseNestedAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "path": {
+ "description": "Defines the nested object field that should be joined back to.\nThe default is empty, which means that it joins back to the root/main document level.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.SamplerAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "shard_size": {
+ "description": "Limits how many top-scoring documents are collected in the sample processed on each shard.",
+ "default": 100.0,
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.ScriptedMetricAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MetricAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "combine_script": {
+ "description": "Runs once on each shard after document collection is complete.\nAllows the aggregation to consolidate the state returned from each shard.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "init_script": {
+ "description": "Runs prior to any collection of documents.\nAllows the aggregation to set up any initial state.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "map_script": {
+ "description": "Run once per document collected.\nIf no `combine_script` is specified, the resulting state needs to be stored in the `state` object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "params": {
+ "description": "A global object with script parameters for `init`, `map` and `combine` scripts.\nIt is shared between the scripts.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "reduce_script": {
+ "description": "Runs once on the coordinating node after all shards have returned their results.\nThe script is provided with access to a variable `states`, which is an array of the result of the `combine_script` on each shard.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.SerialDifferencingAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "lag": {
+ "description": "The historical bucket to subtract from the current value.\nMust be a positive, non-zero integer.",
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.SignificantTermsAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "background_filter": {
+ "description": "A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "chi_square": {
+ "description": "Use Chi square, as described in \"Information Retrieval\", Manning et al., Chapter 13.5.2, as the significance score.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ChiSquareHeuristic"
+ }
+ ]
+ },
+ "exclude": {
+ "description": "Terms to exclude.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsExclude"
+ }
+ ]
+ },
+ "execution_hint": {
+ "description": "Mechanism by which the aggregation should be executed: using field values directly or using global ordinals.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsAggregationExecutionHint"
+ }
+ ]
+ },
+ "field": {
+ "description": "The field from which to return significant terms.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "gnd": {
+ "description": "Use Google normalized distance as described in \"The Google Similarity Distance\", Cilibrasi and Vitanyi, 2007, as the significance score.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.GoogleNormalizedDistanceHeuristic"
+ }
+ ]
+ },
+ "include": {
+ "description": "Terms to include.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsInclude"
+ }
+ ]
+ },
+ "jlh": {
+ "description": "Use JLH score as the significance score.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EmptyObject"
+ }
+ ]
+ },
+ "min_doc_count": {
+ "description": "Only return terms that are found in more than `min_doc_count` hits.",
+ "default": 3.0,
+ "type": "number"
+ },
+ "mutual_information": {
+ "description": "Use mutual information as described in \"Information Retrieval\", Manning et al., Chapter 13.5.1, as the significance score.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MutualInformationHeuristic"
+ }
+ ]
+ },
+ "percentage": {
+ "description": "A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PercentageScoreHeuristic"
+ }
+ ]
+ },
+ "script_heuristic": {
+ "description": "Customized score, implemented via a script.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ScriptedHeuristic"
+ }
+ ]
+ },
+ "shard_min_doc_count": {
+ "description": "Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`.\nTerms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`.",
+ "type": "number"
+ },
+ "shard_size": {
+ "description": "Can be used to control the volumes of candidate terms produced by each shard.\nBy default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter.",
+ "type": "number"
+ },
+ "size": {
+ "description": "The number of buckets returned out of the overall terms list.",
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.ChiSquareHeuristic": {
+ "type": "object",
+ "properties": {
+ "background_is_superset": {
+ "description": "Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to.",
+ "type": "boolean"
+ },
+ "include_negatives": {
+ "description": "Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "background_is_superset",
+ "include_negatives"
+ ]
+ },
+ "_types.aggregations.TermsAggregationExecutionHint": {
+ "type": "string",
+ "enum": [
+ "map",
+ "global_ordinals",
+ "global_ordinals_hash",
+ "global_ordinals_low_cardinality"
+ ]
+ },
+ "_types.aggregations.GoogleNormalizedDistanceHeuristic": {
+ "type": "object",
+ "properties": {
+ "background_is_superset": {
+ "description": "Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to.",
+ "type": "boolean"
+ }
+ }
+ },
+ "_types.aggregations.MutualInformationHeuristic": {
+ "type": "object",
+ "properties": {
+ "background_is_superset": {
+ "description": "Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to.",
+ "type": "boolean"
+ },
+ "include_negatives": {
+ "description": "Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset.",
+ "type": "boolean"
+ }
+ }
+ },
+ "_types.aggregations.PercentageScoreHeuristic": {
+ "type": "object"
+ },
+ "_types.aggregations.ScriptedHeuristic": {
+ "type": "object",
+ "properties": {
+ "script": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ }
+ },
+ "required": [
+ "script"
+ ]
+ },
+ "_types.aggregations.SignificantTextAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "background_filter": {
+ "description": "A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "chi_square": {
+ "description": "Use Chi square, as described in \"Information Retrieval\", Manning et al., Chapter 13.5.2, as the significance score.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ChiSquareHeuristic"
+ }
+ ]
+ },
+ "exclude": {
+ "description": "Values to exclude.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsExclude"
+ }
+ ]
+ },
+ "execution_hint": {
+ "description": "Determines whether the aggregation will use field values directly or global ordinals.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsAggregationExecutionHint"
+ }
+ ]
+ },
+ "field": {
+ "description": "The field from which to return significant text.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "filter_duplicate_text": {
+ "description": "Whether to out duplicate text to deal with noisy data.",
+ "type": "boolean"
+ },
+ "gnd": {
+ "description": "Use Google normalized distance as described in \"The Google Similarity Distance\", Cilibrasi and Vitanyi, 2007, as the significance score.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.GoogleNormalizedDistanceHeuristic"
+ }
+ ]
+ },
+ "include": {
+ "description": "Values to include.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsInclude"
+ }
+ ]
+ },
+ "jlh": {
+ "description": "Use JLH score as the significance score.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EmptyObject"
+ }
+ ]
+ },
+ "min_doc_count": {
+ "description": "Only return values that are found in more than `min_doc_count` hits.",
+ "default": 3.0,
+ "type": "number"
+ },
+ "mutual_information": {
+ "description": "Use mutual information as described in \"Information Retrieval\", Manning et al., Chapter 13.5.1, as the significance score.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MutualInformationHeuristic"
+ }
+ ]
+ },
+ "percentage": {
+ "description": "A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PercentageScoreHeuristic"
+ }
+ ]
+ },
+ "script_heuristic": {
+ "description": "Customized score, implemented via a script.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ScriptedHeuristic"
+ }
+ ]
+ },
+ "shard_min_doc_count": {
+ "description": "Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count.\nValues will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`.",
+ "type": "number"
+ },
+ "shard_size": {
+ "description": "The number of candidate terms produced by each shard.\nBy default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter.",
+ "type": "number"
+ },
+ "size": {
+ "description": "The number of buckets returned out of the overall terms list.",
+ "type": "number"
+ },
+ "source_fields": {
+ "description": "Overrides the JSON `_source` fields from which text will be analyzed.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.StatsAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.FormatMetricAggregationBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.StatsBucketAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.StringStatsAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MetricAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "show_distribution": {
+ "description": "Shows the probability distribution for all characters.",
+ "default": false,
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.SumAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.FormatMetricAggregationBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.SumBucketAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.PipelineAggregationBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.TermsAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "collect_mode": {
+ "description": "Determines how child aggregations should be calculated: breadth-first or depth-first.\n\nSupported values include:\n - `depth_first`: Expands all branches of the aggregation tree in one depth-first pass, before any pruning occurs.\n - `breadth_first`: Caches the set of documents that fall into the uppermost buckets for subsequent replay.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsAggregationCollectMode"
+ }
+ ]
+ },
+ "exclude": {
+ "description": "Values to exclude.\nAccepts regular expressions and partitions.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsExclude"
+ }
+ ]
+ },
+ "execution_hint": {
+ "description": "Determines whether the aggregation will use field values directly or global ordinals.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsAggregationExecutionHint"
+ }
+ ]
+ },
+ "field": {
+ "description": "The field from which to return terms.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "include": {
+ "description": "Values to include.\nAccepts regular expressions and partitions.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsInclude"
+ }
+ ]
+ },
+ "min_doc_count": {
+ "description": "Only return values that are found in more than `min_doc_count` hits.",
+ "default": 1.0,
+ "type": "number"
+ },
+ "missing": {
+ "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.Missing"
+ }
+ ]
+ },
+ "missing_order": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MissingOrder"
+ }
+ ]
+ },
+ "missing_bucket": {
+ "type": "boolean"
+ },
+ "value_type": {
+ "description": "Coerced unmapped fields into the specified type.",
+ "type": "string"
+ },
+ "order": {
+ "description": "Specifies the sort order of the buckets.\nDefaults to sorting by descending document count.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.AggregateOrder"
+ }
+ ]
+ },
+ "script": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "shard_min_doc_count": {
+ "description": "Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`.\nTerms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`.",
+ "type": "number"
+ },
+ "shard_size": {
+ "description": "The number of candidate terms produced by each shard.\nBy default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter.",
+ "type": "number"
+ },
+ "show_term_doc_count_error": {
+ "description": "Set to `true` to return the `doc_count_error_upper_bound`, which is an upper bound to the error on the `doc_count` returned by each shard.",
+ "type": "boolean"
+ },
+ "size": {
+ "description": "The number of buckets returned out of the overall terms list.",
+ "default": 10.0,
+ "type": "number"
+ },
+ "format": {
+ "type": "string"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.TimeSeriesAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "size": {
+ "description": "The maximum number of results to return.",
+ "default": 10000.0,
+ "type": "number"
+ },
+ "keyed": {
+ "description": "Set to `true` to associate a unique string key with each bucket and returns the ranges as a hash rather than an array.",
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.TopHitsAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MetricAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "docvalue_fields": {
+ "description": "Fields for which to return doc values.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
+ }
+ },
+ "explain": {
+ "description": "If `true`, returns detailed information about score computation as part of a hit.",
+ "default": false,
+ "type": "boolean"
+ },
+ "fields": {
+ "description": "Array of wildcard (*) patterns. The request returns values for field names\nmatching these patterns in the hits.fields property of the response.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
+ }
+ },
+ "from": {
+ "description": "Starting document offset.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "highlight": {
+ "description": "Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.Highlight"
+ }
+ ]
+ },
+ "script_fields": {
+ "description": "Returns the result of one or more script evaluations for each hit.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.ScriptField"
+ }
+ },
+ "size": {
+ "description": "The maximum number of top matching hits to return per bucket.",
+ "default": 3.0,
+ "type": "number"
+ },
+ "sort": {
+ "description": "Sort order of the top matching hits.\nBy default, the hits are sorted by the score of the main query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Sort"
+ }
+ ]
+ },
+ "_source": {
+ "description": "Selects the fields of the source that are returned.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.SourceConfig"
+ }
+ ]
+ },
+ "stored_fields": {
+ "description": "Returns values for the specified stored fields (fields that use the `store` mapping option).",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ },
+ "track_scores": {
+ "description": "If `true`, calculates and returns document scores, even if the scores are not used for sorting.",
+ "default": false,
+ "type": "boolean"
+ },
+ "version": {
+ "description": "If `true`, returns document version as part of a hit.",
+ "default": false,
+ "type": "boolean"
+ },
+ "seq_no_primary_term": {
+ "description": "If `true`, returns sequence number and primary term of the last modification of each hit.",
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.TTestAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.Aggregation"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "a": {
+ "description": "Test population A.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TestPopulation"
+ }
+ ]
+ },
+ "b": {
+ "description": "Test population B.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TestPopulation"
+ }
+ ]
+ },
+ "type": {
+ "description": "The type of test.\n\nSupported values include:\n - `paired`: Performs paired t-test.\n - `homoscedastic`: Performs two-sample equal variance test.\n - `heteroscedastic`: Performs two-sample unequal variance test.\n\n",
+ "default": "heteroscedastic",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TTestType"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.TestPopulation": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The field to aggregate.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "script": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "filter": {
+ "description": "A filter used to define a set of records to run unpaired t-test on.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field"
+ ]
+ },
+ "_types.aggregations.TTestType": {
+ "type": "string",
+ "enum": [
+ "paired",
+ "homoscedastic",
+ "heteroscedastic"
+ ]
+ },
+ "_types.aggregations.TopMetricsAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MetricAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "metrics": {
+ "description": "The fields of the top document to return.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TopMetricsValue"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.aggregations.TopMetricsValue"
+ }
+ }
+ ]
+ },
+ "size": {
+ "description": "The number of top documents from which to return metrics.",
+ "default": 1.0,
+ "type": "number"
+ },
+ "sort": {
+ "description": "The sort order of the documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Sort"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.TopMetricsValue": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "A field to return as a metric.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field"
+ ]
+ },
+ "_types.aggregations.ValueCountAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.FormattableMetricAggregation"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_types.aggregations.FormattableMetricAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MetricAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "format": {
+ "type": "string"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.WeightedAverageAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.Aggregation"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "format": {
+ "description": "A numeric response formatter.",
+ "type": "string"
+ },
+ "value": {
+ "description": "Configuration for the field that provides the values.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.WeightedAverageValue"
+ }
+ ]
+ },
+ "value_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ValueType"
+ }
+ ]
+ },
+ "weight": {
+ "description": "Configuration for the field or script that provides the weights.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.WeightedAverageValue"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.WeightedAverageValue": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The field from which to extract the values or weights.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "missing": {
+ "description": "A value or weight to use if the field is missing.",
+ "type": "number"
+ },
+ "script": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ }
+ }
+ },
+ "_types.aggregations.VariableWidthHistogramAggregation": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The name of the field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "buckets": {
+ "description": "The target number of buckets.",
+ "default": 10.0,
+ "type": "number"
+ },
+ "shard_size": {
+ "description": "The number of buckets that the coordinating node will request from each shard.\nDefaults to `buckets * 50`.",
+ "type": "number"
+ },
+ "initial_buffer": {
+ "description": "Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run.\nDefaults to `min(10 * shard_size, 50000)`.",
+ "type": "number"
+ },
+ "script": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ }
+ }
+ },
+ "_types.Refresh": {
+ "type": "string",
+ "enum": [
+ "true",
+ "false",
+ "wait_for"
+ ]
+ },
+ "_types.WaitForActiveShards": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "$ref": "#/components/schemas/_types.WaitForActiveShardOptions"
+ }
+ ]
+ },
+ "_types.WaitForActiveShardOptions": {
+ "type": "string",
+ "enum": [
+ "all",
+ "index-setting"
+ ]
+ },
+ "_global.bulk.OperationContainer": {
+ "type": "object",
+ "properties": {
+ "index": {
+ "description": "Index the specified document.\nIf the document exists, it replaces the document and increments the version.\nThe following line must contain the source data to be indexed.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.bulk.IndexOperation"
+ }
+ ]
+ },
+ "create": {
+ "description": "Index the specified document if it does not already exist.\nThe following line must contain the source data to be indexed.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.bulk.CreateOperation"
+ }
+ ]
+ },
+ "update": {
+ "description": "Perform a partial document update.\nThe following line must contain the partial document and update options.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.bulk.UpdateOperation"
+ }
+ ]
+ },
+ "delete": {
+ "description": "Remove the specified document from the index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.bulk.DeleteOperation"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "_global.bulk.IndexOperation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.bulk.WriteOperation"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_global.bulk.WriteOperation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.bulk.OperationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "dynamic_templates": {
+ "description": "A map from the full name of fields to the name of dynamic templates.\nIt defaults to an empty map.\nIf a name matches a dynamic template, that template will be applied regardless of other match predicates defined in the template.\nIf a field is already defined in the mapping, then this parameter won't be used.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "pipeline": {
+ "description": "The ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request.\nIf a final pipeline is configured, it will always run regardless of the value of this parameter.",
+ "type": "string"
+ },
+ "require_alias": {
+ "description": "If `true`, the request's actions must target an index alias.",
+ "default": false,
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "_global.bulk.OperationBase": {
+ "type": "object",
+ "properties": {
+ "_id": {
+ "description": "The document ID.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "_index": {
+ "description": "The name of the index or index alias to perform the action on.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "routing": {
+ "description": "A custom value used to route operations to a specific shard.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Routing"
+ }
+ ]
+ },
+ "if_primary_term": {
+ "type": "number"
+ },
+ "if_seq_no": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SequenceNumber"
+ }
+ ]
+ },
+ "version": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ }
+ ]
+ },
+ "version_type": {
+ "description": "\n\nSupported values include:\n - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n - `force`: This option is deprecated because it can cause primary and replica shards to diverge.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionType"
+ }
+ ]
+ }
+ }
+ },
+ "_global.bulk.CreateOperation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.bulk.WriteOperation"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_global.bulk.UpdateOperation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.bulk.OperationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "require_alias": {
+ "description": "If `true`, the request's actions must target an index alias.",
+ "default": false,
+ "type": "boolean"
+ },
+ "retry_on_conflict": {
+ "description": "The number of times an update should be retried in the case of a version conflict.",
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "_global.bulk.DeleteOperation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.bulk.OperationBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_global.bulk.UpdateAction": {
+ "type": "object",
+ "properties": {
+ "detect_noop": {
+ "description": "If true, the `result` in the response is set to 'noop' when no changes to the document occur.",
+ "default": true,
+ "type": "boolean"
+ },
+ "doc": {
+ "description": "A partial update to an existing document.",
+ "type": "object"
+ },
+ "doc_as_upsert": {
+ "description": "Set to `true` to use the contents of `doc` as the value of `upsert`.",
+ "default": false,
+ "type": "boolean"
+ },
+ "script": {
+ "description": "The script to run to update the document.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "scripted_upsert": {
+ "description": "Set to `true` to run the script whether or not the document exists.",
+ "default": false,
+ "type": "boolean"
+ },
+ "_source": {
+ "description": "If `false`, source retrieval is turned off.\nYou can also specify a comma-separated list of the fields you want to retrieve.",
+ "default": "true",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.SourceConfig"
+ }
+ ]
+ },
+ "upsert": {
+ "description": "If the document does not already exist, the contents of `upsert` are inserted as a new document.\nIf the document exists, the `script` is run.",
+ "type": "object"
+ }
+ }
+ },
+ "_global.bulk.ResponseItem": {
+ "type": "object",
+ "properties": {
+ "_id": {
+ "description": "The document ID associated with the operation.",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "_index": {
+ "description": "The name of the index associated with the operation.\nIf the operation targeted a data stream, this is the backing index into which the document was written.",
+ "type": "string"
+ },
+ "status": {
+ "description": "The HTTP status code returned for the operation.",
+ "type": "number"
+ },
+ "failure_store": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.bulk.FailureStoreStatus"
+ }
+ ]
+ },
+ "error": {
+ "description": "Additional information about the failed operation.\nThe property is returned only for failed operations.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ErrorCause"
+ }
+ ]
+ },
+ "_primary_term": {
+ "description": "The primary term assigned to the document for the operation.\nThis property is returned only for successful operations.",
+ "type": "number"
+ },
+ "result": {
+ "description": "The result of the operation.\nSuccessful values are `created`, `deleted`, and `updated`.",
+ "type": "string"
+ },
+ "_seq_no": {
+ "description": "The sequence number assigned to the document for the operation.\nSequence numbers are used to ensure an older version of a document doesn't overwrite a newer version.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SequenceNumber"
+ }
+ ]
+ },
+ "_shards": {
+ "description": "Shard information for the operation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ShardStatistics"
+ }
+ ]
+ },
+ "_version": {
+ "description": "The document version associated with the operation.\nThe document version is incremented each time the document is updated.\nThis property is returned only for successful actions.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ }
+ ]
+ },
+ "forced_refresh": {
+ "type": "boolean"
+ },
+ "get": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.InlineGetDictUserDefined"
+ }
+ ]
+ }
+ },
+ "required": [
+ "_index",
+ "status"
+ ]
+ },
+ "_global.bulk.FailureStoreStatus": {
+ "type": "string",
+ "enum": [
+ "not_applicable_or_unknown",
+ "used",
+ "not_enabled",
+ "failed"
+ ]
+ },
+ "_types.InlineGetDictUserDefined": {
+ "type": "object",
+ "properties": {
+ "fields": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "found": {
+ "type": "boolean"
+ },
+ "_seq_no": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SequenceNumber"
+ }
+ ]
+ },
+ "_primary_term": {
+ "type": "number"
+ },
+ "_routing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Routing"
+ }
+ ]
+ },
+ "_source": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "required": [
+ "found"
+ ]
+ },
+ "_types.Names": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ }
+ ]
+ },
+ "cat._types.CatAliasesColumns": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/cat._types.CatAliasesColumn"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/cat._types.CatAliasesColumn"
+ }
+ }
+ ]
+ },
+ "cat._types.CatAliasesColumn": {
+ "anyOf": [
+ {
+ "type": "string",
+ "enum": [
+ "alias",
+ "a",
+ "index",
+ "i",
+ "idx",
+ "filter",
+ "f",
+ "fi",
+ "routing.index",
+ "ri",
+ "routingIndex",
+ "routing.search",
+ "rs",
+ "routingSearch",
+ "is_write_index",
+ "w",
+ "isWriteIndex"
+ ]
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "cat.aliases.AliasesRecord": {
+ "type": "object",
+ "properties": {
+ "alias": {
+ "description": "alias name",
+ "type": "string"
+ },
+ "index": {
+ "description": "index alias points to",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "filter": {
+ "description": "filter",
+ "type": "string"
+ },
+ "routing.index": {
+ "description": "index routing",
+ "type": "string"
+ },
+ "routing.search": {
+ "description": "search routing",
+ "type": "string"
+ },
+ "is_write_index": {
+ "description": "write index",
+ "type": "string"
+ }
+ }
+ },
+ "cat._types.CatComponentColumns": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/cat._types.CatComponentColumn"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/cat._types.CatComponentColumn"
+ }
+ }
+ ]
+ },
+ "cat._types.CatComponentColumn": {
+ "anyOf": [
+ {
+ "type": "string",
+ "enum": [
+ "name",
+ "n",
+ "version",
+ "v",
+ "alias_count",
+ "a",
+ "mapping_count",
+ "m",
+ "settings_count",
+ "s",
+ "metadata_count",
+ "me",
+ "included_in",
+ "i"
+ ]
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "cat.component_templates.ComponentTemplate": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "version": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "alias_count": {
+ "type": "string"
+ },
+ "mapping_count": {
+ "type": "string"
+ },
+ "settings_count": {
+ "type": "string"
+ },
+ "metadata_count": {
+ "type": "string"
+ },
+ "included_in": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "version",
+ "alias_count",
+ "mapping_count",
+ "settings_count",
+ "metadata_count",
+ "included_in"
+ ]
+ },
+ "cat._types.CatCountColumns": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/cat._types.CatCountColumn"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/cat._types.CatCountColumn"
+ }
+ }
+ ]
+ },
+ "cat._types.CatCountColumn": {
+ "anyOf": [
+ {
+ "type": "string",
+ "enum": [
+ "epoch",
+ "t",
+ "time",
+ "timestamp",
+ "ts",
+ "hms",
+ "hhmmss",
+ "count",
+ "dc",
+ "docs.count",
+ "docsCount"
+ ]
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "cat.count.CountRecord": {
+ "type": "object",
+ "properties": {
+ "epoch": {
+ "description": "seconds since 1970-01-01 00:00:00",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.StringifiedEpochTimeUnitSeconds"
+ }
+ ]
+ },
+ "timestamp": {
+ "description": "time in HH:MM:SS",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.TimeOfDay"
+ }
+ ]
+ },
+ "count": {
+ "description": "the document count",
+ "type": "string"
+ }
+ }
+ },
+ "_spec_utils.StringifiedEpochTimeUnitSeconds": {
+ "description": "Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior\nis used to capture this behavior while keeping the semantics of the field type.\n\nDepending on the target language, code generators can keep the union or remove it and leniently parse\nstrings to the target type.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitSeconds"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "_types.EpochTimeUnitSeconds": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.UnitSeconds"
+ }
+ ]
+ },
+ "_types.UnitSeconds": {
+ "description": "Time unit for seconds",
+ "type": "number"
+ },
+ "_types.TimeOfDay": {
+ "description": "Time of day, expressed as HH:MM:SS",
+ "type": "string"
+ },
+ "_types.Bytes": {
+ "type": "string",
+ "enum": [
+ "b",
+ "kb",
+ "mb",
+ "gb",
+ "tb",
+ "pb"
+ ]
+ },
+ "_types.HealthStatus": {
+ "type": "string",
+ "enum": [
+ "green",
+ "GREEN",
+ "yellow",
+ "YELLOW",
+ "red",
+ "RED",
+ "unknown",
+ "unavailable"
+ ]
+ },
+ "_types.TimeUnit": {
+ "type": "string",
+ "enum": [
+ "nanos",
+ "micros",
+ "ms",
+ "s",
+ "m",
+ "h",
+ "d"
+ ]
+ },
+ "cat.indices.IndicesRecord": {
+ "type": "object",
+ "properties": {
+ "health": {
+ "description": "current health status",
+ "type": "string"
+ },
+ "status": {
+ "description": "open/close status",
+ "type": "string"
+ },
+ "index": {
+ "description": "index name",
+ "type": "string"
+ },
+ "uuid": {
+ "description": "index uuid",
+ "type": "string"
+ },
+ "pri": {
+ "description": "number of primary shards",
+ "type": "string"
+ },
+ "rep": {
+ "description": "number of replica shards",
+ "type": "string"
+ },
+ "docs.count": {
+ "description": "available docs",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "docs.deleted": {
+ "description": "deleted docs",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "creation.date": {
+ "description": "index creation date (millisecond value)",
+ "type": "string"
+ },
+ "creation.date.string": {
+ "description": "index creation date (as string)",
+ "type": "string"
+ },
+ "store.size": {
+ "description": "store size of primaries & replicas",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "pri.store.size": {
+ "description": "store size of primaries",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "dataset.size": {
+ "description": "total size of dataset (including the cache for partially mounted indices)",
+ "x-state": "Generally available",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "completion.size": {
+ "description": "size of completion",
+ "type": "string"
+ },
+ "pri.completion.size": {
+ "description": "size of completion",
+ "type": "string"
+ },
+ "fielddata.memory_size": {
+ "description": "used fielddata cache",
+ "type": "string"
+ },
+ "pri.fielddata.memory_size": {
+ "description": "used fielddata cache",
+ "type": "string"
+ },
+ "fielddata.evictions": {
+ "description": "fielddata evictions",
+ "type": "string"
+ },
+ "pri.fielddata.evictions": {
+ "description": "fielddata evictions",
+ "type": "string"
+ },
+ "query_cache.memory_size": {
+ "description": "used query cache",
+ "type": "string"
+ },
+ "pri.query_cache.memory_size": {
+ "description": "used query cache",
+ "type": "string"
+ },
+ "query_cache.evictions": {
+ "description": "query cache evictions",
+ "type": "string"
+ },
+ "pri.query_cache.evictions": {
+ "description": "query cache evictions",
+ "type": "string"
+ },
+ "request_cache.memory_size": {
+ "description": "used request cache",
+ "type": "string"
+ },
+ "pri.request_cache.memory_size": {
+ "description": "used request cache",
+ "type": "string"
+ },
+ "request_cache.evictions": {
+ "description": "request cache evictions",
+ "type": "string"
+ },
+ "pri.request_cache.evictions": {
+ "description": "request cache evictions",
+ "type": "string"
+ },
+ "request_cache.hit_count": {
+ "description": "request cache hit count",
+ "type": "string"
+ },
+ "pri.request_cache.hit_count": {
+ "description": "request cache hit count",
+ "type": "string"
+ },
+ "request_cache.miss_count": {
+ "description": "request cache miss count",
+ "type": "string"
+ },
+ "pri.request_cache.miss_count": {
+ "description": "request cache miss count",
+ "type": "string"
+ },
+ "flush.total": {
+ "description": "number of flushes",
+ "type": "string"
+ },
+ "pri.flush.total": {
+ "description": "number of flushes",
+ "type": "string"
+ },
+ "flush.total_time": {
+ "description": "time spent in flush",
+ "type": "string"
+ },
+ "pri.flush.total_time": {
+ "description": "time spent in flush",
+ "type": "string"
+ },
+ "get.current": {
+ "description": "number of current get ops",
+ "type": "string"
+ },
+ "pri.get.current": {
+ "description": "number of current get ops",
+ "type": "string"
+ },
+ "get.time": {
+ "description": "time spent in get",
+ "type": "string"
+ },
+ "pri.get.time": {
+ "description": "time spent in get",
+ "type": "string"
+ },
+ "get.total": {
+ "description": "number of get ops",
+ "type": "string"
+ },
+ "pri.get.total": {
+ "description": "number of get ops",
+ "type": "string"
+ },
+ "get.exists_time": {
+ "description": "time spent in successful gets",
+ "type": "string"
+ },
+ "pri.get.exists_time": {
+ "description": "time spent in successful gets",
+ "type": "string"
+ },
+ "get.exists_total": {
+ "description": "number of successful gets",
+ "type": "string"
+ },
+ "pri.get.exists_total": {
+ "description": "number of successful gets",
+ "type": "string"
+ },
+ "get.missing_time": {
+ "description": "time spent in failed gets",
+ "type": "string"
+ },
+ "pri.get.missing_time": {
+ "description": "time spent in failed gets",
+ "type": "string"
+ },
+ "get.missing_total": {
+ "description": "number of failed gets",
+ "type": "string"
+ },
+ "pri.get.missing_total": {
+ "description": "number of failed gets",
+ "type": "string"
+ },
+ "indexing.delete_current": {
+ "description": "number of current deletions",
+ "type": "string"
+ },
+ "pri.indexing.delete_current": {
+ "description": "number of current deletions",
+ "type": "string"
+ },
+ "indexing.delete_time": {
+ "description": "time spent in deletions",
+ "type": "string"
+ },
+ "pri.indexing.delete_time": {
+ "description": "time spent in deletions",
+ "type": "string"
+ },
+ "indexing.delete_total": {
+ "description": "number of delete ops",
+ "type": "string"
+ },
+ "pri.indexing.delete_total": {
+ "description": "number of delete ops",
+ "type": "string"
+ },
+ "indexing.index_current": {
+ "description": "number of current indexing ops",
+ "type": "string"
+ },
+ "pri.indexing.index_current": {
+ "description": "number of current indexing ops",
+ "type": "string"
+ },
+ "indexing.index_time": {
+ "description": "time spent in indexing",
+ "type": "string"
+ },
+ "pri.indexing.index_time": {
+ "description": "time spent in indexing",
+ "type": "string"
+ },
+ "indexing.index_total": {
+ "description": "number of indexing ops",
+ "type": "string"
+ },
+ "pri.indexing.index_total": {
+ "description": "number of indexing ops",
+ "type": "string"
+ },
+ "indexing.index_failed": {
+ "description": "number of failed indexing ops",
+ "type": "string"
+ },
+ "pri.indexing.index_failed": {
+ "description": "number of failed indexing ops",
+ "type": "string"
+ },
+ "merges.current": {
+ "description": "number of current merges",
+ "type": "string"
+ },
+ "pri.merges.current": {
+ "description": "number of current merges",
+ "type": "string"
+ },
+ "merges.current_docs": {
+ "description": "number of current merging docs",
+ "type": "string"
+ },
+ "pri.merges.current_docs": {
+ "description": "number of current merging docs",
+ "type": "string"
+ },
+ "merges.current_size": {
+ "description": "size of current merges",
+ "type": "string"
+ },
+ "pri.merges.current_size": {
+ "description": "size of current merges",
+ "type": "string"
+ },
+ "merges.total": {
+ "description": "number of completed merge ops",
+ "type": "string"
+ },
+ "pri.merges.total": {
+ "description": "number of completed merge ops",
+ "type": "string"
+ },
+ "merges.total_docs": {
+ "description": "docs merged",
+ "type": "string"
+ },
+ "pri.merges.total_docs": {
+ "description": "docs merged",
+ "type": "string"
+ },
+ "merges.total_size": {
+ "description": "size merged",
+ "type": "string"
+ },
+ "pri.merges.total_size": {
+ "description": "size merged",
+ "type": "string"
+ },
+ "merges.total_time": {
+ "description": "time spent in merges",
+ "type": "string"
+ },
+ "pri.merges.total_time": {
+ "description": "time spent in merges",
+ "type": "string"
+ },
+ "refresh.total": {
+ "description": "total refreshes",
+ "type": "string"
+ },
+ "pri.refresh.total": {
+ "description": "total refreshes",
+ "type": "string"
+ },
+ "refresh.time": {
+ "description": "time spent in refreshes",
+ "type": "string"
+ },
+ "pri.refresh.time": {
+ "description": "time spent in refreshes",
+ "type": "string"
+ },
+ "refresh.external_total": {
+ "description": "total external refreshes",
+ "type": "string"
+ },
+ "pri.refresh.external_total": {
+ "description": "total external refreshes",
+ "type": "string"
+ },
+ "refresh.external_time": {
+ "description": "time spent in external refreshes",
+ "type": "string"
+ },
+ "pri.refresh.external_time": {
+ "description": "time spent in external refreshes",
+ "type": "string"
+ },
+ "refresh.listeners": {
+ "description": "number of pending refresh listeners",
+ "type": "string"
+ },
+ "pri.refresh.listeners": {
+ "description": "number of pending refresh listeners",
+ "type": "string"
+ },
+ "search.fetch_current": {
+ "description": "current fetch phase ops",
+ "type": "string"
+ },
+ "pri.search.fetch_current": {
+ "description": "current fetch phase ops",
+ "type": "string"
+ },
+ "search.fetch_time": {
+ "description": "time spent in fetch phase",
+ "type": "string"
+ },
+ "pri.search.fetch_time": {
+ "description": "time spent in fetch phase",
+ "type": "string"
+ },
+ "search.fetch_total": {
+ "description": "total fetch ops",
+ "type": "string"
+ },
+ "pri.search.fetch_total": {
+ "description": "total fetch ops",
+ "type": "string"
+ },
+ "search.open_contexts": {
+ "description": "open search contexts",
+ "type": "string"
+ },
+ "pri.search.open_contexts": {
+ "description": "open search contexts",
+ "type": "string"
+ },
+ "search.query_current": {
+ "description": "current query phase ops",
+ "type": "string"
+ },
+ "pri.search.query_current": {
+ "description": "current query phase ops",
+ "type": "string"
+ },
+ "search.query_time": {
+ "description": "time spent in query phase",
+ "type": "string"
+ },
+ "pri.search.query_time": {
+ "description": "time spent in query phase",
+ "type": "string"
+ },
+ "search.query_total": {
+ "description": "total query phase ops",
+ "type": "string"
+ },
+ "pri.search.query_total": {
+ "description": "total query phase ops",
+ "type": "string"
+ },
+ "search.scroll_current": {
+ "description": "open scroll contexts",
+ "type": "string"
+ },
+ "pri.search.scroll_current": {
+ "description": "open scroll contexts",
+ "type": "string"
+ },
+ "search.scroll_time": {
+ "description": "time scroll contexts held open",
+ "type": "string"
+ },
+ "pri.search.scroll_time": {
+ "description": "time scroll contexts held open",
+ "type": "string"
+ },
+ "search.scroll_total": {
+ "description": "completed scroll contexts",
+ "type": "string"
+ },
+ "pri.search.scroll_total": {
+ "description": "completed scroll contexts",
+ "type": "string"
+ },
+ "segments.count": {
+ "description": "number of segments",
+ "type": "string"
+ },
+ "pri.segments.count": {
+ "description": "number of segments",
+ "type": "string"
+ },
+ "segments.memory": {
+ "description": "memory used by segments",
+ "type": "string"
+ },
+ "pri.segments.memory": {
+ "description": "memory used by segments",
+ "type": "string"
+ },
+ "segments.index_writer_memory": {
+ "description": "memory used by index writer",
+ "type": "string"
+ },
+ "pri.segments.index_writer_memory": {
+ "description": "memory used by index writer",
+ "type": "string"
+ },
+ "segments.version_map_memory": {
+ "description": "memory used by version map",
+ "type": "string"
+ },
+ "pri.segments.version_map_memory": {
+ "description": "memory used by version map",
+ "type": "string"
+ },
+ "segments.fixed_bitset_memory": {
+ "description": "memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields",
+ "type": "string"
+ },
+ "pri.segments.fixed_bitset_memory": {
+ "description": "memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields",
+ "type": "string"
+ },
+ "warmer.current": {
+ "description": "current warmer ops",
+ "type": "string"
+ },
+ "pri.warmer.current": {
+ "description": "current warmer ops",
+ "type": "string"
+ },
+ "warmer.total": {
+ "description": "total warmer ops",
+ "type": "string"
+ },
+ "pri.warmer.total": {
+ "description": "total warmer ops",
+ "type": "string"
+ },
+ "warmer.total_time": {
+ "description": "time spent in warmers",
+ "type": "string"
+ },
+ "pri.warmer.total_time": {
+ "description": "time spent in warmers",
+ "type": "string"
+ },
+ "suggest.current": {
+ "description": "number of current suggest ops",
+ "type": "string"
+ },
+ "pri.suggest.current": {
+ "description": "number of current suggest ops",
+ "type": "string"
+ },
+ "suggest.time": {
+ "description": "time spend in suggest",
+ "type": "string"
+ },
+ "pri.suggest.time": {
+ "description": "time spend in suggest",
+ "type": "string"
+ },
+ "suggest.total": {
+ "description": "number of suggest ops",
+ "type": "string"
+ },
+ "pri.suggest.total": {
+ "description": "number of suggest ops",
+ "type": "string"
+ },
+ "memory.total": {
+ "description": "total used memory",
+ "type": "string"
+ },
+ "pri.memory.total": {
+ "description": "total user memory",
+ "type": "string"
+ },
+ "search.throttled": {
+ "description": "indicates if the index is search throttled",
+ "type": "string"
+ },
+ "bulk.total_operations": {
+ "description": "number of bulk shard ops",
+ "type": "string"
+ },
+ "pri.bulk.total_operations": {
+ "description": "number of bulk shard ops",
+ "type": "string"
+ },
+ "bulk.total_time": {
+ "description": "time spend in shard bulk",
+ "type": "string"
+ },
+ "pri.bulk.total_time": {
+ "description": "time spend in shard bulk",
+ "type": "string"
+ },
+ "bulk.total_size_in_bytes": {
+ "description": "total size in bytes of shard bulk",
+ "type": "string"
+ },
+ "pri.bulk.total_size_in_bytes": {
+ "description": "total size in bytes of shard bulk",
+ "type": "string"
+ },
+ "bulk.avg_time": {
+ "description": "average time spend in shard bulk",
+ "type": "string"
+ },
+ "pri.bulk.avg_time": {
+ "description": "average time spend in shard bulk",
+ "type": "string"
+ },
+ "bulk.avg_size_in_bytes": {
+ "description": "average size in bytes of shard bulk",
+ "type": "string"
+ },
+ "pri.bulk.avg_size_in_bytes": {
+ "description": "average size in bytes of shard bulk",
+ "type": "string"
+ }
+ }
+ },
+ "cat._types.CatDfaColumns": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/cat._types.CatDfaColumn"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/cat._types.CatDfaColumn"
+ }
+ }
+ ]
+ },
+ "cat._types.CatDfaColumn": {
+ "type": "string",
+ "enum": [
+ "assignment_explanation",
+ "ae",
+ "create_time",
+ "ct",
+ "createTime",
+ "description",
+ "d",
+ "dest_index",
+ "di",
+ "destIndex",
+ "failure_reason",
+ "fr",
+ "failureReason",
+ "id",
+ "model_memory_limit",
+ "mml",
+ "modelMemoryLimit",
+ "node.address",
+ "na",
+ "nodeAddress",
+ "node.ephemeral_id",
+ "ne",
+ "nodeEphemeralId",
+ "node.id",
+ "ni",
+ "nodeId",
+ "node.name",
+ "nn",
+ "nodeName",
+ "progress",
+ "p",
+ "source_index",
+ "si",
+ "sourceIndex",
+ "state",
+ "s",
+ "type",
+ "t",
+ "version",
+ "v"
+ ]
+ },
+ "cat.ml_data_frame_analytics.DataFrameAnalyticsRecord": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The identifier for the job.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "type": {
+ "description": "The type of analysis that the job performs.",
+ "type": "string"
+ },
+ "create_time": {
+ "description": "The time when the job was created.",
+ "type": "string"
+ },
+ "version": {
+ "description": "The version of Elasticsearch when the job was created.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ },
+ "source_index": {
+ "description": "The name of the source index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "dest_index": {
+ "description": "The name of the destination index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "description": {
+ "description": "A description of the job.",
+ "type": "string"
+ },
+ "model_memory_limit": {
+ "description": "The approximate maximum amount of memory resources that are permitted for the job.",
+ "type": "string"
+ },
+ "state": {
+ "description": "The current status of the job.",
+ "type": "string"
+ },
+ "failure_reason": {
+ "description": "Messages about the reason why the job failed.",
+ "type": "string"
+ },
+ "progress": {
+ "description": "The progress report for the job by phase.",
+ "type": "string"
+ },
+ "assignment_explanation": {
+ "description": "Messages related to the selection of a node.",
+ "type": "string"
+ },
+ "node.id": {
+ "description": "The unique identifier of the assigned node.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "node.name": {
+ "description": "The name of the assigned node.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "node.ephemeral_id": {
+ "description": "The ephemeral identifier of the assigned node.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "node.address": {
+ "description": "The network address of the assigned node.",
+ "type": "string"
+ }
+ }
+ },
+ "_types.VersionString": {
+ "type": "string"
+ },
+ "cat._types.CatDatafeedColumns": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/cat._types.CatDatafeedColumn"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/cat._types.CatDatafeedColumn"
+ }
+ }
+ ]
+ },
+ "cat._types.CatDatafeedColumn": {
+ "type": "string",
+ "enum": [
+ "ae",
+ "assignment_explanation",
+ "bc",
+ "buckets.count",
+ "bucketsCount",
+ "id",
+ "na",
+ "node.address",
+ "nodeAddress",
+ "ne",
+ "node.ephemeral_id",
+ "nodeEphemeralId",
+ "ni",
+ "node.id",
+ "nodeId",
+ "nn",
+ "node.name",
+ "nodeName",
+ "sba",
+ "search.bucket_avg",
+ "searchBucketAvg",
+ "sc",
+ "search.count",
+ "searchCount",
+ "seah",
+ "search.exp_avg_hour",
+ "searchExpAvgHour",
+ "st",
+ "search.time",
+ "searchTime",
+ "s",
+ "state"
+ ]
+ },
+ "cat.ml_datafeeds.DatafeedsRecord": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The datafeed identifier.",
+ "type": "string"
+ },
+ "state": {
+ "description": "The status of the datafeed.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DatafeedState"
+ }
+ ]
+ },
+ "assignment_explanation": {
+ "description": "For started datafeeds only, contains messages relating to the selection of a node.",
+ "type": "string"
+ },
+ "buckets.count": {
+ "description": "The number of buckets processed.",
+ "type": "string"
+ },
+ "search.count": {
+ "description": "The number of searches run by the datafeed.",
+ "type": "string"
+ },
+ "search.time": {
+ "description": "The total time the datafeed spent searching, in milliseconds.",
+ "type": "string"
+ },
+ "search.bucket_avg": {
+ "description": "The average search time per bucket, in milliseconds.",
+ "type": "string"
+ },
+ "search.exp_avg_hour": {
+ "description": "The exponential average search time per hour, in milliseconds.",
+ "type": "string"
+ },
+ "node.id": {
+ "description": "The unique identifier of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.",
+ "type": "string"
+ },
+ "node.name": {
+ "description": "The name of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.",
+ "type": "string"
+ },
+ "node.ephemeral_id": {
+ "description": "The ephemeral identifier of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.",
+ "type": "string"
+ },
+ "node.address": {
+ "description": "The network address of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.",
+ "type": "string"
+ }
+ }
+ },
+ "ml._types.DatafeedState": {
+ "type": "string",
+ "enum": [
+ "started",
+ "stopped",
+ "starting",
+ "stopping"
+ ]
+ },
+ "cat._types.CatAnomalyDetectorColumns": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/cat._types.CatAnomalyDetectorColumn"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/cat._types.CatAnomalyDetectorColumn"
+ }
+ }
+ ]
+ },
+ "cat._types.CatAnomalyDetectorColumn": {
+ "type": "string",
+ "enum": [
+ "assignment_explanation",
+ "ae",
+ "buckets.count",
+ "bc",
+ "bucketsCount",
+ "buckets.time.exp_avg",
+ "btea",
+ "bucketsTimeExpAvg",
+ "buckets.time.exp_avg_hour",
+ "bteah",
+ "bucketsTimeExpAvgHour",
+ "buckets.time.max",
+ "btmax",
+ "bucketsTimeMax",
+ "buckets.time.min",
+ "btmin",
+ "bucketsTimeMin",
+ "buckets.time.total",
+ "btt",
+ "bucketsTimeTotal",
+ "data.buckets",
+ "db",
+ "dataBuckets",
+ "data.earliest_record",
+ "der",
+ "dataEarliestRecord",
+ "data.empty_buckets",
+ "deb",
+ "dataEmptyBuckets",
+ "data.input_bytes",
+ "dib",
+ "dataInputBytes",
+ "data.input_fields",
+ "dif",
+ "dataInputFields",
+ "data.input_records",
+ "dir",
+ "dataInputRecords",
+ "data.invalid_dates",
+ "did",
+ "dataInvalidDates",
+ "data.last",
+ "dl",
+ "dataLast",
+ "data.last_empty_bucket",
+ "dleb",
+ "dataLastEmptyBucket",
+ "data.last_sparse_bucket",
+ "dlsb",
+ "dataLastSparseBucket",
+ "data.latest_record",
+ "dlr",
+ "dataLatestRecord",
+ "data.missing_fields",
+ "dmf",
+ "dataMissingFields",
+ "data.out_of_order_timestamps",
+ "doot",
+ "dataOutOfOrderTimestamps",
+ "data.processed_fields",
+ "dpf",
+ "dataProcessedFields",
+ "data.processed_records",
+ "dpr",
+ "dataProcessedRecords",
+ "data.sparse_buckets",
+ "dsb",
+ "dataSparseBuckets",
+ "forecasts.memory.avg",
+ "fmavg",
+ "forecastsMemoryAvg",
+ "forecasts.memory.max",
+ "fmmax",
+ "forecastsMemoryMax",
+ "forecasts.memory.min",
+ "fmmin",
+ "forecastsMemoryMin",
+ "forecasts.memory.total",
+ "fmt",
+ "forecastsMemoryTotal",
+ "forecasts.records.avg",
+ "fravg",
+ "forecastsRecordsAvg",
+ "forecasts.records.max",
+ "frmax",
+ "forecastsRecordsMax",
+ "forecasts.records.min",
+ "frmin",
+ "forecastsRecordsMin",
+ "forecasts.records.total",
+ "frt",
+ "forecastsRecordsTotal",
+ "forecasts.time.avg",
+ "ftavg",
+ "forecastsTimeAvg",
+ "forecasts.time.max",
+ "ftmax",
+ "forecastsTimeMax",
+ "forecasts.time.min",
+ "ftmin",
+ "forecastsTimeMin",
+ "forecasts.time.total",
+ "ftt",
+ "forecastsTimeTotal",
+ "forecasts.total",
+ "ft",
+ "forecastsTotal",
+ "id",
+ "model.bucket_allocation_failures",
+ "mbaf",
+ "modelBucketAllocationFailures",
+ "model.by_fields",
+ "mbf",
+ "modelByFields",
+ "model.bytes",
+ "mb",
+ "modelBytes",
+ "model.bytes_exceeded",
+ "mbe",
+ "modelBytesExceeded",
+ "model.categorization_status",
+ "mcs",
+ "modelCategorizationStatus",
+ "model.categorized_doc_count",
+ "mcdc",
+ "modelCategorizedDocCount",
+ "model.dead_category_count",
+ "mdcc",
+ "modelDeadCategoryCount",
+ "model.failed_category_count",
+ "mdcc",
+ "modelFailedCategoryCount",
+ "model.frequent_category_count",
+ "mfcc",
+ "modelFrequentCategoryCount",
+ "model.log_time",
+ "mlt",
+ "modelLogTime",
+ "model.memory_limit",
+ "mml",
+ "modelMemoryLimit",
+ "model.memory_status",
+ "mms",
+ "modelMemoryStatus",
+ "model.over_fields",
+ "mof",
+ "modelOverFields",
+ "model.partition_fields",
+ "mpf",
+ "modelPartitionFields",
+ "model.rare_category_count",
+ "mrcc",
+ "modelRareCategoryCount",
+ "model.timestamp",
+ "mt",
+ "modelTimestamp",
+ "model.total_category_count",
+ "mtcc",
+ "modelTotalCategoryCount",
+ "node.address",
+ "na",
+ "nodeAddress",
+ "node.ephemeral_id",
+ "ne",
+ "nodeEphemeralId",
+ "node.id",
+ "ni",
+ "nodeId",
+ "node.name",
+ "nn",
+ "nodeName",
+ "opened_time",
+ "ot",
+ "state",
+ "s"
+ ]
+ },
+ "cat.ml_jobs.JobsRecord": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The anomaly detection job identifier.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "state": {
+ "description": "The status of the anomaly detection job.\n\nSupported values include:\n - `closing`: The job close action is in progress and has not yet completed. A closing job cannot accept further data.\n - `closed`: The job finished successfully with its model state persisted. The job must be opened before it can accept further data.\n - `opened`: The job is available to receive and process data.\n - `failed`: The job did not finish successfully due to an error.\nThis situation can occur due to invalid input data, a fatal error occurring during the analysis, or an external interaction such as the process being killed by the Linux out of memory (OOM) killer.\nIf the job had irrevocably failed, it must be force closed and then deleted.\nIf the datafeed can be corrected, the job can be closed and then re-opened.\n - `opening`: The job open action is in progress and has not yet completed.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.JobState"
+ }
+ ]
+ },
+ "opened_time": {
+ "description": "For open jobs only, the amount of time the job has been opened.",
+ "type": "string"
+ },
+ "assignment_explanation": {
+ "description": "For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job.",
+ "type": "string"
+ },
+ "data.processed_records": {
+ "description": "The number of input documents that have been processed by the anomaly detection job.\nThis value includes documents with missing fields, since they are nonetheless analyzed.\nIf you use datafeeds and have aggregations in your search query, the `processed_record_count` is the number of aggregation results processed, not the number of Elasticsearch documents.",
+ "type": "string"
+ },
+ "data.processed_fields": {
+ "description": "The total number of fields in all the documents that have been processed by the anomaly detection job.\nOnly fields that are specified in the detector configuration object contribute to this count.\nThe timestamp is not included in this count.",
+ "type": "string"
+ },
+ "data.input_bytes": {
+ "description": "The number of bytes of input data posted to the anomaly detection job.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "data.input_records": {
+ "description": "The number of input documents posted to the anomaly detection job.",
+ "type": "string"
+ },
+ "data.input_fields": {
+ "description": "The total number of fields in input documents posted to the anomaly detection job.\nThis count includes fields that are not used in the analysis.\nHowever, be aware that if you are using a datafeed, it extracts only the required fields from the documents it retrieves before posting them to the job.",
+ "type": "string"
+ },
+ "data.invalid_dates": {
+ "description": "The number of input documents with either a missing date field or a date that could not be parsed.",
+ "type": "string"
+ },
+ "data.missing_fields": {
+ "description": "The number of input documents that are missing a field that the anomaly detection job is configured to analyze.\nInput documents with missing fields are still processed because it is possible that not all fields are missing.\nIf you are using datafeeds or posting data to the job in JSON format, a high `missing_field_count` is often not an indication of data issues.\nIt is not necessarily a cause for concern.",
+ "type": "string"
+ },
+ "data.out_of_order_timestamps": {
+ "description": "The number of input documents that have a timestamp chronologically preceding the start of the current anomaly detection bucket offset by the latency window.\nThis information is applicable only when you provide data to the anomaly detection job by using the post data API.\nThese out of order documents are discarded, since jobs require time series data to be in ascending chronological order.",
+ "type": "string"
+ },
+ "data.empty_buckets": {
+ "description": "The number of buckets which did not contain any data.\nIf your data contains many empty buckets, consider increasing your `bucket_span` or using functions that are tolerant to gaps in data such as mean, `non_null_sum` or `non_zero_count`.",
+ "type": "string"
+ },
+ "data.sparse_buckets": {
+ "description": "The number of buckets that contained few data points compared to the expected number of data points.\nIf your data contains many sparse buckets, consider using a longer `bucket_span`.",
+ "type": "string"
+ },
+ "data.buckets": {
+ "description": "The total number of buckets processed.",
+ "type": "string"
+ },
+ "data.earliest_record": {
+ "description": "The timestamp of the earliest chronologically input document.",
+ "type": "string"
+ },
+ "data.latest_record": {
+ "description": "The timestamp of the latest chronologically input document.",
+ "type": "string"
+ },
+ "data.last": {
+ "description": "The timestamp at which data was last analyzed, according to server time.",
+ "type": "string"
+ },
+ "data.last_empty_bucket": {
+ "description": "The timestamp of the last bucket that did not contain any data.",
+ "type": "string"
+ },
+ "data.last_sparse_bucket": {
+ "description": "The timestamp of the last bucket that was considered sparse.",
+ "type": "string"
+ },
+ "model.bytes": {
+ "description": "The number of bytes of memory used by the models.\nThis is the maximum value since the last time the model was persisted.\nIf the job is closed, this value indicates the latest size.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "model.memory_status": {
+ "description": "The status of the mathematical models.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.MemoryStatus"
+ }
+ ]
+ },
+ "model.bytes_exceeded": {
+ "description": "The number of bytes over the high limit for memory usage at the last allocation failure.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "model.memory_limit": {
+ "description": "The upper limit for model memory usage, checked on increasing values.",
+ "type": "string"
+ },
+ "model.by_fields": {
+ "description": "The number of `by` field values that were analyzed by the models.\nThis value is cumulative for all detectors in the job.",
+ "type": "string"
+ },
+ "model.over_fields": {
+ "description": "The number of `over` field values that were analyzed by the models.\nThis value is cumulative for all detectors in the job.",
+ "type": "string"
+ },
+ "model.partition_fields": {
+ "description": "The number of `partition` field values that were analyzed by the models.\nThis value is cumulative for all detectors in the job.",
+ "type": "string"
+ },
+ "model.bucket_allocation_failures": {
+ "description": "The number of buckets for which new entities in incoming data were not processed due to insufficient model memory.\nThis situation is also signified by a `hard_limit: memory_status` property value.",
+ "type": "string"
+ },
+ "model.categorization_status": {
+ "description": "The status of categorization for the job.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.CategorizationStatus"
+ }
+ ]
+ },
+ "model.categorized_doc_count": {
+ "description": "The number of documents that have had a field categorized.",
+ "type": "string"
+ },
+ "model.total_category_count": {
+ "description": "The number of categories created by categorization.",
+ "type": "string"
+ },
+ "model.frequent_category_count": {
+ "description": "The number of categories that match more than 1% of categorized documents.",
+ "type": "string"
+ },
+ "model.rare_category_count": {
+ "description": "The number of categories that match just one categorized document.",
+ "type": "string"
+ },
+ "model.dead_category_count": {
+ "description": "The number of categories created by categorization that will never be assigned again because another category’s definition makes it a superset of the dead category.\nDead categories are a side effect of the way categorization has no prior training.",
+ "type": "string"
+ },
+ "model.failed_category_count": {
+ "description": "The number of times that categorization wanted to create a new category but couldn’t because the job had hit its `model_memory_limit`.\nThis count does not track which specific categories failed to be created.\nTherefore you cannot use this value to determine the number of unique categories that were missed.",
+ "type": "string"
+ },
+ "model.log_time": {
+ "description": "The timestamp when the model stats were gathered, according to server time.",
+ "type": "string"
+ },
+ "model.timestamp": {
+ "description": "The timestamp of the last record when the model stats were gathered.",
+ "type": "string"
+ },
+ "forecasts.total": {
+ "description": "The number of individual forecasts currently available for the job.\nA value of one or more indicates that forecasts exist.",
+ "type": "string"
+ },
+ "forecasts.memory.min": {
+ "description": "The minimum memory usage in bytes for forecasts related to the anomaly detection job.",
+ "type": "string"
+ },
+ "forecasts.memory.max": {
+ "description": "The maximum memory usage in bytes for forecasts related to the anomaly detection job.",
+ "type": "string"
+ },
+ "forecasts.memory.avg": {
+ "description": "The average memory usage in bytes for forecasts related to the anomaly detection job.",
+ "type": "string"
+ },
+ "forecasts.memory.total": {
+ "description": "The total memory usage in bytes for forecasts related to the anomaly detection job.",
+ "type": "string"
+ },
+ "forecasts.records.min": {
+ "description": "The minimum number of `model_forecast` documents written for forecasts related to the anomaly detection job.",
+ "type": "string"
+ },
+ "forecasts.records.max": {
+ "description": "The maximum number of `model_forecast` documents written for forecasts related to the anomaly detection job.",
+ "type": "string"
+ },
+ "forecasts.records.avg": {
+ "description": "The average number of `model_forecast` documents written for forecasts related to the anomaly detection job.",
+ "type": "string"
+ },
+ "forecasts.records.total": {
+ "description": "The total number of `model_forecast` documents written for forecasts related to the anomaly detection job.",
+ "type": "string"
+ },
+ "forecasts.time.min": {
+ "description": "The minimum runtime in milliseconds for forecasts related to the anomaly detection job.",
+ "type": "string"
+ },
+ "forecasts.time.max": {
+ "description": "The maximum runtime in milliseconds for forecasts related to the anomaly detection job.",
+ "type": "string"
+ },
+ "forecasts.time.avg": {
+ "description": "The average runtime in milliseconds for forecasts related to the anomaly detection job.",
+ "type": "string"
+ },
+ "forecasts.time.total": {
+ "description": "The total runtime in milliseconds for forecasts related to the anomaly detection job.",
+ "type": "string"
+ },
+ "node.id": {
+ "description": "The uniqe identifier of the assigned node.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.NodeId"
+ }
+ ]
+ },
+ "node.name": {
+ "description": "The name of the assigned node.",
+ "type": "string"
+ },
+ "node.ephemeral_id": {
+ "description": "The ephemeral identifier of the assigned node.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.NodeId"
+ }
+ ]
+ },
+ "node.address": {
+ "description": "The network address of the assigned node.",
+ "type": "string"
+ },
+ "buckets.count": {
+ "description": "The number of bucket results produced by the job.",
+ "type": "string"
+ },
+ "buckets.time.total": {
+ "description": "The sum of all bucket processing times, in milliseconds.",
+ "type": "string"
+ },
+ "buckets.time.min": {
+ "description": "The minimum of all bucket processing times, in milliseconds.",
+ "type": "string"
+ },
+ "buckets.time.max": {
+ "description": "The maximum of all bucket processing times, in milliseconds.",
+ "type": "string"
+ },
+ "buckets.time.exp_avg": {
+ "description": "The exponential moving average of all bucket processing times, in milliseconds.",
+ "type": "string"
+ },
+ "buckets.time.exp_avg_hour": {
+ "description": "The exponential moving average of bucket processing times calculated in a one hour time window, in milliseconds.",
+ "type": "string"
+ }
+ }
+ },
+ "ml._types.JobState": {
+ "type": "string",
+ "enum": [
+ "closing",
+ "closed",
+ "opened",
+ "failed",
+ "opening"
+ ]
+ },
+ "_types.ByteSize": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "ml._types.MemoryStatus": {
+ "type": "string",
+ "enum": [
+ "ok",
+ "soft_limit",
+ "hard_limit"
+ ]
+ },
+ "ml._types.CategorizationStatus": {
+ "type": "string",
+ "enum": [
+ "ok",
+ "warn"
+ ]
+ },
+ "cat._types.CatTrainedModelsColumns": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/cat._types.CatTrainedModelsColumn"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/cat._types.CatTrainedModelsColumn"
+ }
+ }
+ ]
+ },
+ "cat._types.CatTrainedModelsColumn": {
+ "type": "string",
+ "enum": [
+ "create_time",
+ "ct",
+ "created_by",
+ "c",
+ "createdBy",
+ "data_frame_analytics_id",
+ "df",
+ "dataFrameAnalytics",
+ "dfid",
+ "description",
+ "d",
+ "heap_size",
+ "hs",
+ "modelHeapSize",
+ "id",
+ "ingest.count",
+ "ic",
+ "ingestCount",
+ "ingest.current",
+ "icurr",
+ "ingestCurrent",
+ "ingest.failed",
+ "if",
+ "ingestFailed",
+ "ingest.pipelines",
+ "ip",
+ "ingestPipelines",
+ "ingest.time",
+ "it",
+ "ingestTime",
+ "license",
+ "l",
+ "operations",
+ "o",
+ "modelOperations",
+ "version",
+ "v"
+ ]
+ },
+ "cat.ml_trained_models.TrainedModelsRecord": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The model identifier.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "created_by": {
+ "description": "Information about the creator of the model.",
+ "type": "string"
+ },
+ "heap_size": {
+ "description": "The estimated heap size to keep the model in memory.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "operations": {
+ "description": "The estimated number of operations to use the model.\nThis number helps to measure the computational complexity of the model.",
+ "type": "string"
+ },
+ "license": {
+ "description": "The license level of the model.",
+ "type": "string"
+ },
+ "create_time": {
+ "description": "The time the model was created.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "version": {
+ "description": "The version of Elasticsearch when the model was created.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ },
+ "description": {
+ "description": "A description of the model.",
+ "type": "string"
+ },
+ "ingest.pipelines": {
+ "description": "The number of pipelines that are referencing the model.",
+ "type": "string"
+ },
+ "ingest.count": {
+ "description": "The total number of documents that are processed by the model.",
+ "type": "string"
+ },
+ "ingest.time": {
+ "description": "The total time spent processing documents with thie model.",
+ "type": "string"
+ },
+ "ingest.current": {
+ "description": "The total number of documents that are currently being handled by the model.",
+ "type": "string"
+ },
+ "ingest.failed": {
+ "description": "The total number of failed ingest attempts with the model.",
+ "type": "string"
+ },
+ "data_frame.id": {
+ "description": "The identifier for the data frame analytics job that created the model.\nOnly displayed if the job is still available.",
+ "type": "string"
+ },
+ "data_frame.create_time": {
+ "description": "The time the data frame analytics job was created.",
+ "type": "string"
+ },
+ "data_frame.source_index": {
+ "description": "The source index used to train in the data frame analysis.",
+ "type": "string"
+ },
+ "data_frame.analysis": {
+ "description": "The analysis used by the data frame to build the model.",
+ "type": "string"
+ },
+ "type": {
+ "x-state": "Generally available",
+ "type": "string"
+ }
+ }
+ },
+ "cat._types.CatTransformColumns": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/cat._types.CatTransformColumn"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/cat._types.CatTransformColumn"
+ }
+ }
+ ]
+ },
+ "cat._types.CatTransformColumn": {
+ "type": "string",
+ "enum": [
+ "changes_last_detection_time",
+ "cldt",
+ "checkpoint",
+ "cp",
+ "checkpoint_duration_time_exp_avg",
+ "cdtea",
+ "checkpointTimeExpAvg",
+ "checkpoint_progress",
+ "c",
+ "checkpointProgress",
+ "create_time",
+ "ct",
+ "createTime",
+ "delete_time",
+ "dtime",
+ "description",
+ "d",
+ "dest_index",
+ "di",
+ "destIndex",
+ "documents_deleted",
+ "docd",
+ "documents_indexed",
+ "doci",
+ "docs_per_second",
+ "dps",
+ "documents_processed",
+ "docp",
+ "frequency",
+ "f",
+ "id",
+ "index_failure",
+ "if",
+ "index_time",
+ "itime",
+ "index_total",
+ "it",
+ "indexed_documents_exp_avg",
+ "idea",
+ "last_search_time",
+ "lst",
+ "lastSearchTime",
+ "max_page_search_size",
+ "mpsz",
+ "pages_processed",
+ "pp",
+ "pipeline",
+ "p",
+ "processed_documents_exp_avg",
+ "pdea",
+ "processing_time",
+ "pt",
+ "reason",
+ "r",
+ "search_failure",
+ "sf",
+ "search_time",
+ "stime",
+ "search_total",
+ "st",
+ "source_index",
+ "si",
+ "sourceIndex",
+ "state",
+ "s",
+ "transform_type",
+ "tt",
+ "trigger_count",
+ "tc",
+ "version",
+ "v"
+ ]
+ },
+ "cat.transforms.TransformsRecord": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The transform identifier.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "state": {
+ "description": "The status of the transform.\nReturned values include:\n`aborting`: The transform is aborting.\n`failed: The transform failed. For more information about the failure, check the `reason` field.\n`indexing`: The transform is actively processing data and creating new documents.\n`started`: The transform is running but not actively indexing data.\n`stopped`: The transform is stopped.\n`stopping`: The transform is stopping.",
+ "type": "string"
+ },
+ "checkpoint": {
+ "description": "The sequence number for the checkpoint.",
+ "type": "string"
+ },
+ "documents_processed": {
+ "description": "The number of documents that have been processed from the source index of the transform.",
+ "type": "string"
+ },
+ "checkpoint_progress": {
+ "description": "The progress of the next checkpoint that is currently in progress.",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "last_search_time": {
+ "description": "The timestamp of the last search in the source indices.\nThis field is shown only if the transform is running.",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "changes_last_detection_time": {
+ "description": "The timestamp when changes were last detected in the source indices.",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "create_time": {
+ "description": "The time the transform was created.",
+ "type": "string"
+ },
+ "version": {
+ "description": "The version of Elasticsearch that existed on the node when the transform was created.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ },
+ "source_index": {
+ "description": "The source indices for the transform.",
+ "type": "string"
+ },
+ "dest_index": {
+ "description": "The destination index for the transform.",
+ "type": "string"
+ },
+ "pipeline": {
+ "description": "The unique identifier for the ingest pipeline.",
+ "type": "string"
+ },
+ "description": {
+ "description": "The description of the transform.",
+ "type": "string"
+ },
+ "transform_type": {
+ "description": "The type of transform: `batch` or `continuous`.",
+ "type": "string"
+ },
+ "frequency": {
+ "description": "The interval between checks for changes in the source indices when the transform is running continuously.",
+ "type": "string"
+ },
+ "max_page_search_size": {
+ "description": "The initial page size that is used for the composite aggregation for each checkpoint.",
+ "type": "string"
+ },
+ "docs_per_second": {
+ "description": "The number of input documents per second.",
+ "type": "string"
+ },
+ "reason": {
+ "description": "If a transform has a `failed` state, these details describe the reason for failure.",
+ "type": "string"
+ },
+ "search_total": {
+ "description": "The total number of search operations on the source index for the transform.",
+ "type": "string"
+ },
+ "search_failure": {
+ "description": "The total number of search failures.",
+ "type": "string"
+ },
+ "search_time": {
+ "description": "The total amount of search time, in milliseconds.",
+ "type": "string"
+ },
+ "index_total": {
+ "description": "The total number of index operations done by the transform.",
+ "type": "string"
+ },
+ "index_failure": {
+ "description": "The total number of indexing failures.",
+ "type": "string"
+ },
+ "index_time": {
+ "description": "The total time spent indexing documents, in milliseconds.",
+ "type": "string"
+ },
+ "documents_indexed": {
+ "description": "The number of documents that have been indexed into the destination index for the transform.",
+ "type": "string"
+ },
+ "delete_time": {
+ "description": "The total time spent deleting documents, in milliseconds.",
+ "type": "string"
+ },
+ "documents_deleted": {
+ "description": "The number of documents deleted from the destination index due to the retention policy for the transform.",
+ "type": "string"
+ },
+ "trigger_count": {
+ "description": "The number of times the transform has been triggered by the scheduler.\nFor example, the scheduler triggers the transform indexer to check for updates or ingest new data at an interval specified in the `frequency` property.",
+ "type": "string"
+ },
+ "pages_processed": {
+ "description": "The number of search or bulk index operations processed.\nDocuments are processed in batches instead of individually.",
+ "type": "string"
+ },
+ "processing_time": {
+ "description": "The total time spent processing results, in milliseconds.",
+ "type": "string"
+ },
+ "checkpoint_duration_time_exp_avg": {
+ "description": "The exponential moving average of the duration of the checkpoint, in milliseconds.",
+ "type": "string"
+ },
+ "indexed_documents_exp_avg": {
+ "description": "The exponential moving average of the number of new documents that have been indexed.",
+ "type": "string"
+ },
+ "processed_documents_exp_avg": {
+ "description": "The exponential moving average of the number of documents that have been processed.",
+ "type": "string"
+ }
+ }
+ },
+ "_types.ScrollIds": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScrollId"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.ScrollId"
+ }
+ }
+ ]
+ },
+ "cluster._types.ComponentTemplate": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "component_template": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/cluster._types.ComponentTemplateNode"
+ }
+ ]
+ }
+ },
+ "required": [
+ "name",
+ "component_template"
+ ]
+ },
+ "cluster._types.ComponentTemplateNode": {
+ "type": "object",
+ "properties": {
+ "template": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/cluster._types.ComponentTemplateSummary"
+ }
+ ]
+ },
+ "version": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ }
+ ]
+ },
+ "_meta": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ },
+ "deprecated": {
+ "type": "boolean"
+ },
+ "created_date": {
+ "description": "Date and time when the component template was created. Only returned if the `human` query parameter is `true`.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "created_date_millis": {
+ "description": "Date and time when the component template was created, in milliseconds since the epoch.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "modified_date": {
+ "description": "Date and time when the component template was last modified. Only returned if the `human` query parameter is `true`.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "modified_date_millis": {
+ "description": "Date and time when the component template was last modified, in milliseconds since the epoch.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ }
+ },
+ "required": [
+ "template"
+ ]
+ },
+ "cluster._types.ComponentTemplateSummary": {
+ "type": "object",
+ "properties": {
+ "_meta": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ },
+ "version": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ }
+ ]
+ },
+ "settings": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/indices._types.IndexSettings"
+ }
+ },
+ "mappings": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.TypeMapping"
+ }
+ ]
+ },
+ "aliases": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/indices._types.AliasDefinition"
+ }
+ },
+ "lifecycle": {
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover"
+ }
+ ]
+ },
+ "data_stream_options": {
+ "x-state": "Generally available",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.DataStreamOptionsTemplate"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.IndexSettings": {
+ "type": "object",
+ "properties": {
+ "index": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexSettings"
+ }
+ ]
+ },
+ "mode": {
+ "type": "string"
+ },
+ "routing_path": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "soft_deletes": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.SoftDeletes"
+ }
+ ]
+ },
+ "sort": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexSegmentSort"
+ }
+ ]
+ },
+ "number_of_routing_shards": {
+ "type": "number"
+ },
+ "check_on_startup": {
+ "default": "false",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexCheckOnStartup"
+ }
+ ]
+ },
+ "codec": {
+ "default": "LZ4",
+ "type": "string"
+ },
+ "routing_partition_size": {
+ "default": "1",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger"
+ }
+ ]
+ },
+ "load_fixed_bitset_filters_eagerly": {
+ "default": true,
+ "type": "boolean"
+ },
+ "hidden": {
+ "default": "false",
+ "oneOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "auto_expand_replicas": {
+ "default": "false",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/_spec_utils.NullValue"
+ }
+ ]
+ },
+ "merge": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.Merge"
+ }
+ ]
+ },
+ "search": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.SettingsSearch"
+ }
+ ]
+ },
+ "refresh_interval": {
+ "default": "1s",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "max_result_window": {
+ "default": 10000.0,
+ "type": "number"
+ },
+ "max_inner_result_window": {
+ "default": 100.0,
+ "type": "number"
+ },
+ "max_rescore_window": {
+ "default": 10000.0,
+ "type": "number"
+ },
+ "max_docvalue_fields_search": {
+ "default": 100.0,
+ "type": "number"
+ },
+ "max_script_fields": {
+ "default": 32.0,
+ "type": "number"
+ },
+ "max_ngram_diff": {
+ "default": 1.0,
+ "type": "number"
+ },
+ "max_shingle_diff": {
+ "default": 3.0,
+ "type": "number"
+ },
+ "blocks": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexSettingBlocks"
+ }
+ ]
+ },
+ "max_refresh_listeners": {
+ "type": "number"
+ },
+ "analyze": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/manage-data/data-store/text-analysis/specify-an-analyzer#update-analyzers-on-existing-indices"
+ },
+ "description": "Settings to define analyzers, tokenizers, token filters and character filters.\nRefer to the linked documentation for step-by-step examples of updating analyzers on existing indices.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.SettingsAnalyze"
+ }
+ ]
+ },
+ "highlight": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.SettingsHighlight"
+ }
+ ]
+ },
+ "max_terms_count": {
+ "default": 65536.0,
+ "type": "number"
+ },
+ "max_regex_length": {
+ "default": 1000.0,
+ "type": "number"
+ },
+ "routing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexRouting"
+ }
+ ]
+ },
+ "gc_deletes": {
+ "default": "60s",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "default_pipeline": {
+ "default": "_none",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.PipelineName"
+ }
+ ]
+ },
+ "final_pipeline": {
+ "default": "_none",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.PipelineName"
+ }
+ ]
+ },
+ "lifecycle": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexSettingsLifecycle"
+ }
+ ]
+ },
+ "provided_name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "creation_date": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.StringifiedEpochTimeUnitMillis"
+ }
+ ]
+ },
+ "creation_date_string": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "uuid": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Uuid"
+ }
+ ]
+ },
+ "version": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexVersioning"
+ }
+ ]
+ },
+ "verified_before_close": {
+ "oneOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "format": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "number"
+ }
+ ]
+ },
+ "max_slices_per_scroll": {
+ "type": "number"
+ },
+ "translog": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.Translog"
+ }
+ ]
+ },
+ "query_string": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.SettingsQueryString"
+ }
+ ]
+ },
+ "priority": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "top_metrics_max_size": {
+ "type": "number"
+ },
+ "analysis": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexSettingsAnalysis"
+ }
+ ]
+ },
+ "settings": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexSettings"
+ }
+ ]
+ },
+ "time_series": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexSettingsTimeSeries"
+ }
+ ]
+ },
+ "queries": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.Queries"
+ }
+ ]
+ },
+ "similarity": {
+ "description": "Configure custom similarity settings to customize how search results are scored.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/indices._types.SettingsSimilarity"
+ }
+ },
+ "mapping": {
+ "description": "Enable or disable dynamic mapping for an index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.MappingLimitSettings"
+ }
+ ]
+ },
+ "indexing.slowlog": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexingSlowlogSettings"
+ }
+ ]
+ },
+ "indexing_pressure": {
+ "description": "Configure indexing back pressure limits.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexingPressure"
+ }
+ ]
+ },
+ "store": {
+ "description": "The store module allows you to control how index data is stored and accessed on disk.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.Storage"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.SoftDeletes": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "description": "Indicates whether soft deletes are enabled on the index.",
+ "default": true,
+ "type": "boolean"
+ },
+ "retention_lease": {
+ "description": "The maximum period to retain a shard history retention lease before it is considered expired.\nShard history retention leases ensure that soft deletes are retained during merges on the Lucene\nindex. If a soft delete is merged away before it can be replicated to a follower the following\nprocess will fail due to incomplete history on the leader.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.RetentionLease"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.RetentionLease": {
+ "type": "object",
+ "properties": {
+ "period": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ }
+ },
+ "required": [
+ "period"
+ ]
+ },
+ "indices._types.IndexSegmentSort": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ },
+ "order": {
+ "description": "\n\nSupported values include: `asc` (or `ASC`), `desc` (or `DESC`)\n\n",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.SegmentSortOrder"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/indices._types.SegmentSortOrder"
+ }
+ }
+ ]
+ },
+ "mode": {
+ "description": "\n\nSupported values include: `min` (or `MIN`), `max` (or `MAX`)\n\n",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.SegmentSortMode"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/indices._types.SegmentSortMode"
+ }
+ }
+ ]
+ },
+ "missing": {
+ "description": "\n\nSupported values include: `_last`, `_first`\n\n",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.SegmentSortMissing"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/indices._types.SegmentSortMissing"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.SegmentSortOrder": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "ASC",
+ "desc",
+ "DESC"
+ ]
+ },
+ "indices._types.SegmentSortMode": {
+ "type": "string",
+ "enum": [
+ "min",
+ "MIN",
+ "max",
+ "MAX"
+ ]
+ },
+ "indices._types.SegmentSortMissing": {
+ "type": "string",
+ "enum": [
+ "_last",
+ "_first"
+ ]
+ },
+ "indices._types.IndexCheckOnStartup": {
+ "type": "string",
+ "enum": [
+ "true",
+ "false",
+ "checksum"
+ ]
+ },
+ "_spec_utils.Stringifiedinteger": {
+ "description": "Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior\nis used to capture this behavior while keeping the semantics of the field type.\n\nDepending on the target language, code generators can keep the union or remove it and leniently parse\nstrings to the target type.",
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "_spec_utils.NullValue": {
+ "nullable": true,
+ "description": "A `null` value that is to be interpreted as an actual value, unless other uses of `null` that are equivalent\nto a missing value. It is used for exemple in settings, where using the `NullValue` for a setting will reset\nit to its default value.",
+ "type": "string"
+ },
+ "indices._types.Merge": {
+ "type": "object",
+ "properties": {
+ "scheduler": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.MergeScheduler"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.MergeScheduler": {
+ "type": "object",
+ "properties": {
+ "max_thread_count": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger"
+ }
+ ]
+ },
+ "max_merge_count": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.SettingsSearch": {
+ "type": "object",
+ "properties": {
+ "idle": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.SearchIdle"
+ }
+ ]
+ },
+ "slowlog": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.SlowlogSettings"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.SearchIdle": {
+ "type": "object",
+ "properties": {
+ "after": {
+ "default": "30s",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.SlowlogSettings": {
+ "type": "object",
+ "properties": {
+ "level": {
+ "type": "string"
+ },
+ "source": {
+ "type": "number"
+ },
+ "reformat": {
+ "type": "boolean"
+ },
+ "threshold": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.SlowlogTresholds"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.SlowlogTresholds": {
+ "type": "object",
+ "properties": {
+ "query": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.SlowlogTresholdLevels"
+ }
+ ]
+ },
+ "fetch": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.SlowlogTresholdLevels"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.SlowlogTresholdLevels": {
+ "type": "object",
+ "properties": {
+ "warn": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "info": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "debug": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "trace": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.IndexSettingBlocks": {
+ "type": "object",
+ "properties": {
+ "read_only": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
+ }
+ ]
+ },
+ "read_only_allow_delete": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
+ }
+ ]
+ },
+ "read": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
+ }
+ ]
+ },
+ "write": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
+ }
+ ]
+ },
+ "metadata": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
+ }
+ ]
+ }
+ }
+ },
+ "_spec_utils.Stringifiedboolean": {
+ "description": "Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior\nis used to capture this behavior while keeping the semantics of the field type.\n\nDepending on the target language, code generators can keep the union or remove it and leniently parse\nstrings to the target type.",
+ "oneOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "indices._types.SettingsAnalyze": {
+ "type": "object",
+ "properties": {
+ "max_token_count": {
+ "default": "10000",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.SettingsHighlight": {
+ "type": "object",
+ "properties": {
+ "max_analyzed_offset": {
+ "default": 1000000.0,
+ "type": "number"
+ }
+ }
+ },
+ "indices._types.IndexRouting": {
+ "type": "object",
+ "properties": {
+ "allocation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexRoutingAllocation"
+ }
+ ]
+ },
+ "rebalance": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexRoutingRebalance"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.IndexRoutingAllocation": {
+ "type": "object",
+ "properties": {
+ "enable": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexRoutingAllocationOptions"
+ }
+ ]
+ },
+ "include": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexRoutingAllocationInclude"
+ }
+ ]
+ },
+ "initial_recovery": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexRoutingAllocationInitialRecovery"
+ }
+ ]
+ },
+ "disk": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexRoutingAllocationDisk"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.IndexRoutingAllocationOptions": {
+ "type": "string",
+ "enum": [
+ "all",
+ "primaries",
+ "new_primaries",
+ "none"
+ ]
+ },
+ "indices._types.IndexRoutingAllocationInclude": {
+ "type": "object",
+ "properties": {
+ "_tier_preference": {
+ "type": "string"
+ },
+ "_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.IndexRoutingAllocationInitialRecovery": {
+ "type": "object",
+ "properties": {
+ "_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.IndexRoutingAllocationDisk": {
+ "type": "object",
+ "properties": {
+ "threshold_enabled": {
+ "oneOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.IndexRoutingRebalance": {
+ "type": "object",
+ "properties": {
+ "enable": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexRoutingRebalanceOptions"
+ }
+ ]
+ }
+ },
+ "required": [
+ "enable"
+ ]
+ },
+ "indices._types.IndexRoutingRebalanceOptions": {
+ "type": "string",
+ "enum": [
+ "all",
+ "primaries",
+ "replicas",
+ "none"
+ ]
+ },
+ "_types.PipelineName": {
+ "type": "string"
+ },
+ "indices._types.IndexSettingsLifecycle": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the policy to use to manage the index. For information about how Elasticsearch applies policy changes, see Policy updates.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "indexing_complete": {
+ "description": "Indicates whether or not the index has been rolled over. Automatically set to true when ILM completes the rollover action.\nYou can explicitly set it to skip rollover.",
+ "default": "false",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
+ }
+ ]
+ },
+ "origination_date": {
+ "description": "If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting\nif you create a new index that contains old data and want to use the original creation date to calculate the index\nage. Specified as a Unix epoch value in milliseconds.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "parse_origination_date": {
+ "description": "Set to true to parse the origination date from the index name. This origination date is used to calculate the index age\nfor its phase transitions. The index name must match the pattern ^.*-{date_format}-\\\\d+, where the date_format is\nyyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format,\nfor example logs-2016.10.31-000002). If the index name doesn’t match the pattern, index creation fails.",
+ "type": "boolean"
+ },
+ "step": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexSettingsLifecycleStep"
+ }
+ ]
+ },
+ "rollover_alias": {
+ "description": "The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action.\nWhen the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more\ninformation about rolling indices, see Rollover.",
+ "default": "",
+ "type": "string"
+ },
+ "prefer_ilm": {
+ "description": "Preference for the system that manages a data stream backing index (preferring ILM when both ILM and DLM are\napplicable for an index).",
+ "default": "true",
+ "oneOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.IndexSettingsLifecycleStep": {
+ "type": "object",
+ "properties": {
+ "wait_time_threshold": {
+ "description": "Time to wait for the cluster to resolve allocation issues during an ILM shrink action. Must be greater than 1h (1 hour).\nSee Shard allocation for shrink.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ }
+ }
+ },
+ "_spec_utils.StringifiedEpochTimeUnitMillis": {
+ "description": "Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior\nis used to capture this behavior while keeping the semantics of the field type.\n\nDepending on the target language, code generators can keep the union or remove it and leniently parse\nstrings to the target type.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "_types.Uuid": {
+ "type": "string"
+ },
+ "indices._types.IndexVersioning": {
+ "type": "object",
+ "properties": {
+ "created": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ },
+ "created_string": {
+ "type": "string"
+ }
+ }
+ },
+ "indices._types.Translog": {
+ "type": "object",
+ "properties": {
+ "sync_interval": {
+ "description": "How often the translog is fsynced to disk and committed, regardless of write operations.\nValues less than 100ms are not allowed.",
+ "default": "5s",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "durability": {
+ "description": "Whether or not to `fsync` and commit the translog after every index, delete, update, or bulk request.\n\nSupported values include:\n - `request` (or `REQUEST`): (default) fsync and commit after every request. In the event of hardware failure, all acknowledged writes\nwill already have been committed to disk.\n - `async` (or `ASYNC`): fsync and commit in the background every sync_interval. In the event of a failure, all acknowledged writes\nsince the last automatic commit will be discarded.\n\n",
+ "default": "string",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.TranslogDurability"
+ }
+ ]
+ },
+ "flush_threshold_size": {
+ "description": "The translog stores all operations that are not yet safely persisted in Lucene (i.e., are not\npart of a Lucene commit point). Although these operations are available for reads, they will need\nto be replayed if the shard was stopped and had to be recovered. This setting controls the\nmaximum total size of these operations, to prevent recoveries from taking too long. Once the\nmaximum size has been reached a flush will happen, generating a new Lucene commit point.",
+ "default": "512mb",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "retention": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.TranslogRetention"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.TranslogDurability": {
+ "type": "string",
+ "enum": [
+ "request",
+ "REQUEST",
+ "async",
+ "ASYNC"
+ ]
+ },
+ "indices._types.TranslogRetention": {
+ "type": "object",
+ "properties": {
+ "size": {
+ "description": "This controls the total size of translog files to keep for each shard. Keeping more translog files increases\nthe chance of performing an operation based sync when recovering a replica. If the translog files are not\nsufficient, replica recovery will fall back to a file based sync. This setting is ignored, and should not be\nset, if soft deletes are enabled. Soft deletes are enabled by default in indices created in Elasticsearch\nversions 7.0.0 and later.",
+ "default": "512mb",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "age": {
+ "description": "This controls the maximum duration for which translog files are kept by each shard. Keeping more\ntranslog files increases the chance of performing an operation based sync when recovering replicas. If\nthe translog files are not sufficient, replica recovery will fall back to a file based sync. This setting\nis ignored, and should not be set, if soft deletes are enabled. Soft deletes are enabled by default in\nindices created in Elasticsearch versions 7.0.0 and later.",
+ "default": "12h",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.SettingsQueryString": {
+ "type": "object",
+ "properties": {
+ "lenient": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
+ }
+ ]
+ }
+ },
+ "required": [
+ "lenient"
+ ]
+ },
+ "indices._types.IndexSettingsAnalysis": {
+ "type": "object",
+ "properties": {
+ "analyzer": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.analysis.Analyzer"
+ }
+ },
+ "char_filter": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.analysis.CharFilter"
+ }
+ },
+ "filter": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilter"
+ }
+ },
+ "normalizer": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.analysis.Normalizer"
+ }
+ },
+ "tokenizer": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.analysis.Tokenizer"
+ }
+ }
+ }
+ },
+ "_types.analysis.Analyzer": {
+ "discriminator": {
+ "propertyName": "type"
+ },
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.CustomAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.FingerprintAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.KeywordAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.NoriAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.PatternAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.SimpleAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.StandardAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.WhitespaceAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.IcuAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.KuromojiAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.SnowballAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.ArabicAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.ArmenianAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.BasqueAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.BengaliAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.BrazilianAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.BulgarianAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.CatalanAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.ChineseAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.CjkAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.CzechAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.DanishAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.DutchAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.EnglishAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.EstonianAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.FinnishAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.FrenchAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.GalicianAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.GermanAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.GreekAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.HindiAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.HungarianAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.IndonesianAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.IrishAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.ItalianAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.LatvianAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.LithuanianAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.NorwegianAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.PersianAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.PortugueseAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.RomanianAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.RussianAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.SerbianAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.SoraniAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.SpanishAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.SwedishAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.TurkishAnalyzer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.ThaiAnalyzer"
+ }
+ ]
+ },
+ "_types.analysis.CustomAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "custom"
+ ]
+ },
+ "char_filter": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "filter": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "position_increment_gap": {
+ "type": "number"
+ },
+ "position_offset_gap": {
+ "type": "number"
+ },
+ "tokenizer": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "tokenizer"
+ ]
+ },
+ "_types.analysis.FingerprintAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "fingerprint"
+ ]
+ },
+ "version": {
+ "deprecated": true,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ },
+ "max_output_size": {
+ "description": "The maximum token size to emit. Tokens larger than this size will be discarded.\nDefaults to `255`",
+ "default": 255.0,
+ "type": "number"
+ },
+ "separator": {
+ "description": "The character to use to concatenate the terms.\nDefaults to a space.",
+ "type": "string"
+ },
+ "stopwords": {
+ "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.",
+ "default": "_none_",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "description": "The path to a file containing stop words.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.KeywordAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "keyword"
+ ]
+ },
+ "version": {
+ "deprecated": true,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.NoriAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "nori"
+ ]
+ },
+ "version": {
+ "deprecated": true,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ },
+ "decompound_mode": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.NoriDecompoundMode"
+ }
+ ]
+ },
+ "stoptags": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "user_dictionary": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.NoriDecompoundMode": {
+ "type": "string",
+ "enum": [
+ "discard",
+ "none",
+ "mixed"
+ ]
+ },
+ "_types.analysis.PatternAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "pattern"
+ ]
+ },
+ "version": {
+ "deprecated": true,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ },
+ "flags": {
+ "description": "Java regular expression flags. Flags should be pipe-separated, eg \"CASE_INSENSITIVE|COMMENTS\".",
+ "type": "string"
+ },
+ "lowercase": {
+ "description": "Should terms be lowercased or not.\nDefaults to `true`.",
+ "default": true,
+ "type": "boolean"
+ },
+ "pattern": {
+ "description": "A Java regular expression.\nDefaults to `\\W+`.",
+ "default": "\\W+",
+ "type": "string"
+ },
+ "stopwords": {
+ "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.",
+ "default": "_none_",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "description": "The path to a file containing stop words.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.SimpleAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "simple"
+ ]
+ },
+ "version": {
+ "deprecated": true,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.StandardAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "standard"
+ ]
+ },
+ "max_token_length": {
+ "description": "The maximum token length. If a token is seen that exceeds this length then it is split at `max_token_length` intervals.\nDefaults to `255`.",
+ "default": 255.0,
+ "type": "number"
+ },
+ "stopwords": {
+ "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.",
+ "default": "_none_",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "description": "The path to a file containing stop words.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.StopAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "stop"
+ ]
+ },
+ "version": {
+ "deprecated": true,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ },
+ "stopwords": {
+ "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.",
+ "default": "_none_",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "description": "The path to a file containing stop words.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.WhitespaceAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "whitespace"
+ ]
+ },
+ "version": {
+ "deprecated": true,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.IcuAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "icu_analyzer"
+ ]
+ },
+ "method": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.IcuNormalizationType"
+ }
+ ]
+ },
+ "mode": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.IcuNormalizationMode"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "method",
+ "mode"
+ ]
+ },
+ "_types.analysis.IcuNormalizationType": {
+ "type": "string",
+ "enum": [
+ "nfc",
+ "nfkc",
+ "nfkc_cf"
+ ]
+ },
+ "_types.analysis.IcuNormalizationMode": {
+ "type": "string",
+ "enum": [
+ "decompose",
+ "compose"
+ ]
+ },
+ "_types.analysis.KuromojiAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "kuromoji"
+ ]
+ },
+ "mode": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.KuromojiTokenizationMode"
+ }
+ ]
+ },
+ "user_dictionary": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "mode"
+ ]
+ },
+ "_types.analysis.KuromojiTokenizationMode": {
+ "type": "string",
+ "enum": [
+ "normal",
+ "search",
+ "extended"
+ ]
+ },
+ "_types.analysis.SnowballAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "snowball"
+ ]
+ },
+ "version": {
+ "deprecated": true,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ },
+ "language": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.SnowballLanguage"
+ }
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "language"
+ ]
+ },
+ "_types.analysis.SnowballLanguage": {
+ "type": "string",
+ "enum": [
+ "Arabic",
+ "Armenian",
+ "Basque",
+ "Catalan",
+ "Danish",
+ "Dutch",
+ "English",
+ "Estonian",
+ "Finnish",
+ "French",
+ "German",
+ "German2",
+ "Hungarian",
+ "Italian",
+ "Irish",
+ "Kp",
+ "Lithuanian",
+ "Lovins",
+ "Norwegian",
+ "Porter",
+ "Portuguese",
+ "Romanian",
+ "Russian",
+ "Serbian",
+ "Spanish",
+ "Swedish",
+ "Turkish"
+ ]
+ },
+ "_types.analysis.ArabicAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "arabic"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.ArmenianAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "armenian"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.BasqueAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "basque"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.BengaliAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "bengali"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.BrazilianAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "brazilian"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.BulgarianAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "bulgarian"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.CatalanAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "catalan"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.ChineseAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "chinese"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.CjkAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "cjk"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.CzechAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "czech"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.DanishAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "danish"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.DutchAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "dutch"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.EnglishAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "english"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.EstonianAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "estonian"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.FinnishAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "finnish"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.FrenchAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "french"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.GalicianAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "galician"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.GermanAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "german"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.GreekAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "greek"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.HindiAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "hindi"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.HungarianAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "hungarian"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.IndonesianAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "indonesian"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.IrishAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "irish"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.ItalianAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "italian"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.LatvianAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "latvian"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.LithuanianAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "lithuanian"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.NorwegianAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "norwegian"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.PersianAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "persian"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.PortugueseAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "portuguese"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.RomanianAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "romanian"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.RussianAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "russian"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.SerbianAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "serbian"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.SoraniAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "sorani"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.SpanishAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "spanish"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.SwedishAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "swedish"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.TurkishAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "turkish"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ },
+ "stem_exclusion": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.ThaiAnalyzer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "thai"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.CharFilter": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/text-analysis/character-filter-reference"
+ },
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.CharFilterDefinition"
+ }
+ ]
+ },
+ "_types.analysis.CharFilterDefinition": {
+ "discriminator": {
+ "propertyName": "type"
+ },
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.HtmlStripCharFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.MappingCharFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.PatternReplaceCharFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.IcuNormalizationCharFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.KuromojiIterationMarkCharFilter"
+ }
+ ]
+ },
+ "_types.analysis.HtmlStripCharFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.CharFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "html_strip"
+ ]
+ },
+ "escaped_tags": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.CharFilterBase": {
+ "type": "object",
+ "properties": {
+ "version": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ }
+ }
+ },
+ "_types.analysis.MappingCharFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.CharFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "mapping"
+ ]
+ },
+ "mappings": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mappings_path": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.PatternReplaceCharFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.CharFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "pattern_replace"
+ ]
+ },
+ "flags": {
+ "type": "string"
+ },
+ "pattern": {
+ "type": "string"
+ },
+ "replacement": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "pattern"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.IcuNormalizationCharFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.CharFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "icu_normalizer"
+ ]
+ },
+ "mode": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.IcuNormalizationMode"
+ }
+ ]
+ },
+ "name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.IcuNormalizationType"
+ }
+ ]
+ },
+ "unicode_set_filter": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.KuromojiIterationMarkCharFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.CharFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "kuromoji_iteration_mark"
+ ]
+ },
+ "normalize_kana": {
+ "type": "boolean"
+ },
+ "normalize_kanji": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "type",
+ "normalize_kana",
+ "normalize_kanji"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.TokenFilter": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/text-analysis/token-filter-reference"
+ },
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterDefinition"
+ }
+ ]
+ },
+ "_types.analysis.TokenFilterDefinition": {
+ "discriminator": {
+ "propertyName": "type"
+ },
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.ApostropheTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.ArabicStemTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.ArabicNormalizationTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.AsciiFoldingTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.BengaliNormalizationTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.BrazilianStemTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.CjkBigramTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.CjkWidthTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.ClassicTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.CommonGramsTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.ConditionTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.CzechStemTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.DecimalDigitTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.DelimitedPayloadTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.DutchStemTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.EdgeNGramTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.ElisionTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.FingerprintTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.FlattenGraphTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.FrenchStemTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.GermanNormalizationTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.GermanStemTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.HindiNormalizationTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.HunspellTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.HyphenationDecompounderTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.IndicNormalizationTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.KeepTypesTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.KeepWordsTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.KeywordMarkerTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.KeywordRepeatTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.KStemTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.LengthTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.LimitTokenCountTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.LowercaseTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.MinHashTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.MultiplexerTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.NGramTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.NoriPartOfSpeechTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.PatternCaptureTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.PatternReplaceTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.PersianNormalizationTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.PersianStemTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.PorterStemTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.PredicateTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.RemoveDuplicatesTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.ReverseTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.RussianStemTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.ScandinavianFoldingTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.ScandinavianNormalizationTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.SerbianNormalizationTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.ShingleTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.SnowballTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.SoraniNormalizationTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.StemmerOverrideTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.StemmerTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.SynonymGraphTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.SynonymTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.TrimTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.TruncateTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.UniqueTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.UppercaseTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.WordDelimiterGraphTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.WordDelimiterTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.JaStopTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.KuromojiStemmerTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.KuromojiReadingFormTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.KuromojiPartOfSpeechTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.IcuCollationTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.IcuFoldingTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.IcuNormalizationTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.IcuTransformTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.PhoneticTokenFilter"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.DictionaryDecompounderTokenFilter"
+ }
+ ]
+ },
+ "_types.analysis.ApostropheTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "apostrophe"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.TokenFilterBase": {
+ "type": "object",
+ "properties": {
+ "version": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ }
+ }
+ },
+ "_types.analysis.ArabicStemTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "arabic_stem"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.ArabicNormalizationTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "arabic_normalization"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.AsciiFoldingTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "asciifolding"
+ ]
+ },
+ "preserve_original": {
+ "description": "If `true`, emit both original tokens and folded tokens. Defaults to `false`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.BengaliNormalizationTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "bengali_normalization"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.BrazilianStemTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "brazilian_stem"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.CjkBigramTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "cjk_bigram"
+ ]
+ },
+ "ignored_scripts": {
+ "description": "Array of character scripts for which to disable bigrams.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.analysis.CjkBigramIgnoredScript"
+ }
+ },
+ "output_unigrams": {
+ "description": "If `true`, emit tokens in both bigram and unigram form. If `false`, a CJK character is output in unigram form when it has no adjacent characters. Defaults to `false`.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.CjkBigramIgnoredScript": {
+ "type": "string",
+ "enum": [
+ "han",
+ "hangul",
+ "hiragana",
+ "katakana"
+ ]
+ },
+ "_types.analysis.CjkWidthTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "cjk_width"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.ClassicTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "classic"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.CommonGramsTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "common_grams"
+ ]
+ },
+ "common_words": {
+ "description": "A list of tokens. The filter generates bigrams for these tokens.\nEither this or the `common_words_path` parameter is required.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "common_words_path": {
+ "description": "Path to a file containing a list of tokens. The filter generates bigrams for these tokens.\nThis path must be absolute or relative to the `config` location. The file must be UTF-8 encoded. Each token in the file must be separated by a line break.\nEither this or the `common_words` parameter is required.",
+ "type": "string"
+ },
+ "ignore_case": {
+ "description": "If `true`, matches for common words matching are case-insensitive. Defaults to `false`.",
+ "type": "boolean"
+ },
+ "query_mode": {
+ "description": "If `true`, the filter excludes the following tokens from the output:\n- Unigrams for common words\n- Unigrams for terms followed by common words\nDefaults to `false`. We recommend enabling this parameter for search analyzers.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.ConditionTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "condition"
+ ]
+ },
+ "filter": {
+ "description": "Array of token filters. If a token matches the predicate script in the `script` parameter, these filters are applied to the token in the order provided.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "script": {
+ "description": "Predicate script used to apply token filters. If a token matches this script, the filters in the `filter` parameter are applied to the token.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "filter",
+ "script"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.CzechStemTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "czech_stem"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.DecimalDigitTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "decimal_digit"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.DelimitedPayloadTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "delimited_payload"
+ ]
+ },
+ "delimiter": {
+ "description": "Character used to separate tokens from payloads. Defaults to `|`.",
+ "type": "string"
+ },
+ "encoding": {
+ "description": "Data type for the stored payload.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.DelimitedPayloadEncoding"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.DelimitedPayloadEncoding": {
+ "type": "string",
+ "enum": [
+ "int",
+ "float",
+ "identity"
+ ]
+ },
+ "_types.analysis.DutchStemTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "dutch_stem"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.EdgeNGramTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "edge_ngram"
+ ]
+ },
+ "max_gram": {
+ "description": "Maximum character length of a gram. For custom token filters, defaults to `2`. For the built-in edge_ngram filter, defaults to `1`.",
+ "type": "number"
+ },
+ "min_gram": {
+ "description": "Minimum character length of a gram. Defaults to `1`.",
+ "type": "number"
+ },
+ "side": {
+ "description": "Indicates whether to truncate tokens from the `front` or `back`. Defaults to `front`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.EdgeNGramSide"
+ }
+ ]
+ },
+ "preserve_original": {
+ "description": "Emits original token when set to `true`. Defaults to `false`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.EdgeNGramSide": {
+ "type": "string",
+ "enum": [
+ "front",
+ "back"
+ ]
+ },
+ "_types.analysis.ElisionTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "elision"
+ ]
+ },
+ "articles": {
+ "description": "List of elisions to remove.\nTo be removed, the elision must be at the beginning of a token and be immediately followed by an apostrophe. Both the elision and apostrophe are removed.\nFor custom `elision` filters, either this parameter or `articles_path` must be specified.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "articles_path": {
+ "description": "Path to a file that contains a list of elisions to remove.\nThis path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each elision in the file must be separated by a line break.\nTo be removed, the elision must be at the beginning of a token and be immediately followed by an apostrophe. Both the elision and apostrophe are removed.\nFor custom `elision` filters, either this parameter or `articles` must be specified.",
+ "type": "string"
+ },
+ "articles_case": {
+ "description": "If `true`, elision matching is case insensitive. If `false`, elision matching is case sensitive. Defaults to `false`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.FingerprintTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "fingerprint"
+ ]
+ },
+ "max_output_size": {
+ "description": "Maximum character length, including whitespace, of the output token. Defaults to `255`. Concatenated tokens longer than this will result in no token output.",
+ "type": "number"
+ },
+ "separator": {
+ "description": "Character to use to concatenate the token stream input. Defaults to a space.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.FlattenGraphTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "flatten_graph"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.FrenchStemTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "french_stem"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.GermanNormalizationTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "german_normalization"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.GermanStemTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "german_stem"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.HindiNormalizationTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "hindi_normalization"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.HunspellTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "hunspell"
+ ]
+ },
+ "dedup": {
+ "description": "If `true`, duplicate tokens are removed from the filter’s output. Defaults to `true`.",
+ "type": "boolean"
+ },
+ "dictionary": {
+ "description": "One or more `.dic` files (e.g, `en_US.dic`, my_custom.dic) to use for the Hunspell dictionary.\nBy default, the `hunspell` filter uses all `.dic` files in the `<$ES_PATH_CONF>/hunspell/` directory specified using the `lang`, `language`, or `locale` parameter.",
+ "type": "string"
+ },
+ "locale": {
+ "description": "Locale directory used to specify the `.aff` and `.dic` files for a Hunspell dictionary.",
+ "type": "string"
+ },
+ "longest_only": {
+ "description": "If `true`, only the longest stemmed version of each token is included in the output. If `false`, all stemmed versions of the token are included. Defaults to `false`.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "type",
+ "locale"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.HyphenationDecompounderTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.CompoundWordTokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "hyphenation_decompounder"
+ ]
+ },
+ "hyphenation_patterns_path": {
+ "description": "Path to an Apache FOP (Formatting Objects Processor) XML hyphenation pattern file.\nThis path must be absolute or relative to the `config` location. Only FOP v1.2 compatible files are supported.",
+ "type": "string"
+ },
+ "no_sub_matches": {
+ "description": "If `true`, do not match sub tokens in tokens that are in the word list. Defaults to `false`.",
+ "type": "boolean"
+ },
+ "no_overlapping_matches": {
+ "description": "If `true`, do not allow overlapping tokens. Defaults to `false`.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "type",
+ "hyphenation_patterns_path"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.CompoundWordTokenFilterBase": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "max_subword_size": {
+ "description": "Maximum subword character length. Longer subword tokens are excluded from the output. Defaults to `15`.",
+ "type": "number"
+ },
+ "min_subword_size": {
+ "description": "Minimum subword character length. Shorter subword tokens are excluded from the output. Defaults to `2`.",
+ "type": "number"
+ },
+ "min_word_size": {
+ "description": "Minimum word character length. Shorter word tokens are excluded from the output. Defaults to `5`.",
+ "type": "number"
+ },
+ "only_longest_match": {
+ "description": "If `true`, only include the longest matching subword. Defaults to `false`.",
+ "type": "boolean"
+ },
+ "word_list": {
+ "description": "A list of subwords to look for in the token stream. If found, the subword is included in the token output.\nEither this parameter or `word_list_path` must be specified.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "word_list_path": {
+ "description": "Path to a file that contains a list of subwords to find in the token stream. If found, the subword is included in the token output.\nThis path must be absolute or relative to the config location, and the file must be UTF-8 encoded. Each token in the file must be separated by a line break.\nEither this parameter or `word_list` must be specified.",
+ "type": "string"
+ }
+ }
+ }
+ ]
+ },
+ "_types.analysis.IndicNormalizationTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "indic_normalization"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.KeepTypesTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "keep_types"
+ ]
+ },
+ "mode": {
+ "description": "Indicates whether to keep or remove the specified token types.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.KeepTypesMode"
+ }
+ ]
+ },
+ "types": {
+ "description": "List of token types to keep or remove.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type",
+ "types"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.KeepTypesMode": {
+ "type": "string",
+ "enum": [
+ "include",
+ "exclude"
+ ]
+ },
+ "_types.analysis.KeepWordsTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "keep"
+ ]
+ },
+ "keep_words": {
+ "description": "List of words to keep. Only tokens that match words in this list are included in the output.\nEither this parameter or `keep_words_path` must be specified.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "keep_words_case": {
+ "description": "If `true`, lowercase all keep words. Defaults to `false`.",
+ "type": "boolean"
+ },
+ "keep_words_path": {
+ "description": "Path to a file that contains a list of words to keep. Only tokens that match words in this list are included in the output.\nThis path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each word in the file must be separated by a line break.\nEither this parameter or `keep_words` must be specified.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.KeywordMarkerTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "keyword_marker"
+ ]
+ },
+ "ignore_case": {
+ "description": "If `true`, matching for the `keywords` and `keywords_path` parameters ignores letter case. Defaults to `false`.",
+ "type": "boolean"
+ },
+ "keywords": {
+ "description": "Array of keywords. Tokens that match these keywords are not stemmed.\nThis parameter, `keywords_path`, or `keywords_pattern` must be specified. You cannot specify this parameter and `keywords_pattern`.",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "keywords_path": {
+ "description": "Path to a file that contains a list of keywords. Tokens that match these keywords are not stemmed.\nThis path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each word in the file must be separated by a line break.\nThis parameter, `keywords`, or `keywords_pattern` must be specified. You cannot specify this parameter and `keywords_pattern`.",
+ "type": "string"
+ },
+ "keywords_pattern": {
+ "description": "Java regular expression used to match tokens. Tokens that match this expression are marked as keywords and not stemmed.\nThis parameter, `keywords`, or `keywords_path` must be specified. You cannot specify this parameter and `keywords` or `keywords_pattern`.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.KeywordRepeatTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "keyword_repeat"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.KStemTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "kstem"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.LengthTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "length"
+ ]
+ },
+ "max": {
+ "description": "Maximum character length of a token. Longer tokens are excluded from the output. Defaults to `Integer.MAX_VALUE`, which is `2^31-1` or `2147483647`.",
+ "type": "number"
+ },
+ "min": {
+ "description": "Minimum character length of a token. Shorter tokens are excluded from the output. Defaults to `0`.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.LimitTokenCountTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "limit"
+ ]
+ },
+ "consume_all_tokens": {
+ "description": "If `true`, the limit filter exhausts the token stream, even if the `max_token_count` has already been reached. Defaults to `false`.",
+ "type": "boolean"
+ },
+ "max_token_count": {
+ "description": "Maximum number of tokens to keep. Once this limit is reached, any remaining tokens are excluded from the output. Defaults to `1`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.LowercaseTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "lowercase"
+ ]
+ },
+ "language": {
+ "description": "Language-specific lowercase token filter to use.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.LowercaseTokenFilterLanguages"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.LowercaseTokenFilterLanguages": {
+ "type": "string",
+ "enum": [
+ "greek",
+ "irish",
+ "turkish"
+ ]
+ },
+ "_types.analysis.MinHashTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "min_hash"
+ ]
+ },
+ "bucket_count": {
+ "description": "Number of buckets to which hashes are assigned. Defaults to `512`.",
+ "type": "number"
+ },
+ "hash_count": {
+ "description": "Number of ways to hash each token in the stream. Defaults to `1`.",
+ "type": "number"
+ },
+ "hash_set_size": {
+ "description": "Number of hashes to keep from each bucket. Defaults to `1`.\nHashes are retained by ascending size, starting with the bucket’s smallest hash first.",
+ "type": "number"
+ },
+ "with_rotation": {
+ "description": "If `true`, the filter fills empty buckets with the value of the first non-empty bucket to its circular right if the `hash_set_size` is `1`. If the `bucket_count` argument is greater than 1, this parameter defaults to `true`. Otherwise, this parameter defaults to `false`.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.MultiplexerTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "multiplexer"
+ ]
+ },
+ "filters": {
+ "description": "A list of token filters to apply to incoming tokens.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "preserve_original": {
+ "description": "If `true` (the default) then emit the original token in addition to the filtered tokens.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "filters"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.NGramTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "ngram"
+ ]
+ },
+ "max_gram": {
+ "description": "Maximum length of characters in a gram. Defaults to `2`.",
+ "type": "number"
+ },
+ "min_gram": {
+ "description": "Minimum length of characters in a gram. Defaults to `1`.",
+ "type": "number"
+ },
+ "preserve_original": {
+ "description": "Emits original token when set to `true`. Defaults to `false`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.NoriPartOfSpeechTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "nori_part_of_speech"
+ ]
+ },
+ "stoptags": {
+ "description": "An array of part-of-speech tags that should be removed.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.PatternCaptureTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "pattern_capture"
+ ]
+ },
+ "patterns": {
+ "description": "A list of regular expressions to match.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "preserve_original": {
+ "description": "If set to `true` (the default) it will emit the original token.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "patterns"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.PatternReplaceTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "pattern_replace"
+ ]
+ },
+ "all": {
+ "description": "If `true`, all substrings matching the pattern parameter’s regular expression are replaced. If `false`, the filter replaces only the first matching substring in each token. Defaults to `true`.",
+ "type": "boolean"
+ },
+ "flags": {
+ "type": "string"
+ },
+ "pattern": {
+ "description": "Regular expression, written in Java’s regular expression syntax. The filter replaces token substrings matching this pattern with the substring in the `replacement` parameter.",
+ "type": "string"
+ },
+ "replacement": {
+ "description": "Replacement substring. Defaults to an empty substring (`\"\"`).",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "pattern"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.PersianNormalizationTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "persian_normalization"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.PersianStemTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "persian_stem"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.PorterStemTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "porter_stem"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.PredicateTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "predicate_token_filter"
+ ]
+ },
+ "script": {
+ "description": "Script containing a condition used to filter incoming tokens. Only tokens that match this script are included in the output.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "script"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.RemoveDuplicatesTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "remove_duplicates"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.ReverseTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "reverse"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.RussianStemTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "russian_stem"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.ScandinavianFoldingTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "scandinavian_folding"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.ScandinavianNormalizationTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "scandinavian_normalization"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.SerbianNormalizationTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "serbian_normalization"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.ShingleTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "shingle"
+ ]
+ },
+ "filler_token": {
+ "description": "String used in shingles as a replacement for empty positions that do not contain a token. This filler token is only used in shingles, not original unigrams. Defaults to an underscore (`_`).",
+ "type": "string"
+ },
+ "max_shingle_size": {
+ "description": "Maximum number of tokens to concatenate when creating shingles. Defaults to `2`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger"
+ }
+ ]
+ },
+ "min_shingle_size": {
+ "description": "Minimum number of tokens to concatenate when creating shingles. Defaults to `2`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger"
+ }
+ ]
+ },
+ "output_unigrams": {
+ "description": "If `true`, the output includes the original input tokens. If `false`, the output only includes shingles; the original input tokens are removed. Defaults to `true`.",
+ "type": "boolean"
+ },
+ "output_unigrams_if_no_shingles": {
+ "description": "If `true`, the output includes the original input tokens only if no shingles are produced; if shingles are produced, the output only includes shingles. Defaults to `false`.",
+ "type": "boolean"
+ },
+ "token_separator": {
+ "description": "Separator used to concatenate adjacent tokens to form a shingle. Defaults to a space (`\" \"`).",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.SnowballTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "snowball"
+ ]
+ },
+ "language": {
+ "description": "Controls the language used by the stemmer.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.SnowballLanguage"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.SoraniNormalizationTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "sorani_normalization"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.StemmerOverrideTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "stemmer_override"
+ ]
+ },
+ "rules": {
+ "description": "A list of mapping rules to use.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "rules_path": {
+ "description": "A path (either relative to `config` location, or absolute) to a list of mappings.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.StemmerTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "stemmer"
+ ]
+ },
+ "language": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.StopTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "stop"
+ ]
+ },
+ "ignore_case": {
+ "description": "If `true`, stop word matching is case insensitive. For example, if `true`, a stop word of the matches and removes `The`, `THE`, or `the`. Defaults to `false`.",
+ "type": "boolean"
+ },
+ "remove_trailing": {
+ "description": "If `true`, the last token of a stream is removed if it’s a stop word. Defaults to `true`.",
+ "type": "boolean"
+ },
+ "stopwords": {
+ "description": "Language value, such as `_arabic_` or `_thai_`. Defaults to `_english_`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ },
+ "stopwords_path": {
+ "description": "Path to a file that contains a list of stop words to remove.\nThis path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each stop word in the file must be separated by a line break.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.SynonymGraphTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.SynonymTokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "synonym_graph"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.SynonymTokenFilterBase": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "expand": {
+ "description": "Expands definitions for equivalent synonym rules. Defaults to `true`.",
+ "type": "boolean"
+ },
+ "format": {
+ "description": "Sets the synonym rules format.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.SynonymFormat"
+ }
+ ]
+ },
+ "lenient": {
+ "description": "If `true` ignores errors while parsing the synonym rules. It is important to note that only those synonym rules which cannot get parsed are ignored. Defaults to the value of the `updateable` setting.",
+ "type": "boolean"
+ },
+ "synonyms": {
+ "description": "Used to define inline synonyms.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "synonyms_path": {
+ "description": "Used to provide a synonym file. This path must be absolute or relative to the `config` location.",
+ "type": "string"
+ },
+ "synonyms_set": {
+ "description": "Provide a synonym set created via Synonyms Management APIs.",
+ "type": "string"
+ },
+ "tokenizer": {
+ "deprecated": true,
+ "description": "Controls the tokenizers that will be used to tokenize the synonym, this parameter is for backwards compatibility for indices that created before 6.0.",
+ "type": "string"
+ },
+ "updateable": {
+ "description": "If `true` allows reloading search analyzers to pick up changes to synonym files. Only to be used for search analyzers. Defaults to `false`.",
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "_types.analysis.SynonymFormat": {
+ "type": "string",
+ "enum": [
+ "solr",
+ "wordnet"
+ ]
+ },
+ "_types.analysis.SynonymTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.SynonymTokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "synonym"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.TrimTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "trim"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.TruncateTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "truncate"
+ ]
+ },
+ "length": {
+ "description": "Character limit for each token. Tokens exceeding this limit are truncated. Defaults to `10`.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.UniqueTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "unique"
+ ]
+ },
+ "only_on_same_position": {
+ "description": "If `true`, only remove duplicate tokens in the same position. Defaults to `false`.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.UppercaseTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "uppercase"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.WordDelimiterGraphTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.WordDelimiterTokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "word_delimiter_graph"
+ ]
+ },
+ "adjust_offsets": {
+ "description": "If `true`, the filter adjusts the offsets of split or catenated tokens to better reflect their actual position in the token stream. Defaults to `true`.",
+ "type": "boolean"
+ },
+ "ignore_keywords": {
+ "description": "If `true`, the filter skips tokens with a keyword attribute of true. Defaults to `false`.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.WordDelimiterTokenFilterBase": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "catenate_all": {
+ "description": "If `true`, the filter produces catenated tokens for chains of alphanumeric characters separated by non-alphabetic delimiters. Defaults to `false`.",
+ "type": "boolean"
+ },
+ "catenate_numbers": {
+ "description": "If `true`, the filter produces catenated tokens for chains of numeric characters separated by non-alphabetic delimiters. Defaults to `false`.",
+ "type": "boolean"
+ },
+ "catenate_words": {
+ "description": "If `true`, the filter produces catenated tokens for chains of alphabetical characters separated by non-alphabetic delimiters. Defaults to `false`.",
+ "type": "boolean"
+ },
+ "generate_number_parts": {
+ "description": "If `true`, the filter includes tokens consisting of only numeric characters in the output. If `false`, the filter excludes these tokens from the output. Defaults to `true`.",
+ "type": "boolean"
+ },
+ "generate_word_parts": {
+ "description": "If `true`, the filter includes tokens consisting of only alphabetical characters in the output. If `false`, the filter excludes these tokens from the output. Defaults to `true`.",
+ "type": "boolean"
+ },
+ "preserve_original": {
+ "description": "If `true`, the filter includes the original version of any split tokens in the output. This original version includes non-alphanumeric delimiters. Defaults to `false`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
+ }
+ ]
+ },
+ "protected_words": {
+ "description": "Array of tokens the filter won’t split.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "protected_words_path": {
+ "description": "Path to a file that contains a list of tokens the filter won’t split.\nThis path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each token in the file must be separated by a line break.",
+ "type": "string"
+ },
+ "split_on_case_change": {
+ "description": "If `true`, the filter splits tokens at letter case transitions. For example: camelCase -> [ camel, Case ]. Defaults to `true`.",
+ "type": "boolean"
+ },
+ "split_on_numerics": {
+ "description": "If `true`, the filter splits tokens at letter-number transitions. For example: j2se -> [ j, 2, se ]. Defaults to `true`.",
+ "type": "boolean"
+ },
+ "stem_english_possessive": {
+ "description": "If `true`, the filter removes the English possessive (`'s`) from the end of each token. For example: O'Neil's -> [ O, Neil ]. Defaults to `true`.",
+ "type": "boolean"
+ },
+ "type_table": {
+ "description": "Array of custom type mappings for characters. This allows you to map non-alphanumeric characters as numeric or alphanumeric to avoid splitting on those characters.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "type_table_path": {
+ "description": "Path to a file that contains custom type mappings for characters. This allows you to map non-alphanumeric characters as numeric or alphanumeric to avoid splitting on those characters.",
+ "type": "string"
+ }
+ }
+ }
+ ]
+ },
+ "_types.analysis.WordDelimiterTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.WordDelimiterTokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "word_delimiter"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.JaStopTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "ja_stop"
+ ]
+ },
+ "stopwords": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.StopWords"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.KuromojiStemmerTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "kuromoji_stemmer"
+ ]
+ },
+ "minimum_length": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "type",
+ "minimum_length"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.KuromojiReadingFormTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "kuromoji_readingform"
+ ]
+ },
+ "use_romaji": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "type",
+ "use_romaji"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.KuromojiPartOfSpeechTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "kuromoji_part_of_speech"
+ ]
+ },
+ "stoptags": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type",
+ "stoptags"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.IcuCollationTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "icu_collation"
+ ]
+ },
+ "alternate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.IcuCollationAlternate"
+ }
+ ]
+ },
+ "caseFirst": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.IcuCollationCaseFirst"
+ }
+ ]
+ },
+ "caseLevel": {
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "decomposition": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.IcuCollationDecomposition"
+ }
+ ]
+ },
+ "hiraganaQuaternaryMode": {
+ "type": "boolean"
+ },
+ "language": {
+ "type": "string"
+ },
+ "numeric": {
+ "type": "boolean"
+ },
+ "rules": {
+ "type": "string"
+ },
+ "strength": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.IcuCollationStrength"
+ }
+ ]
+ },
+ "variableTop": {
+ "type": "string"
+ },
+ "variant": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.IcuCollationAlternate": {
+ "type": "string",
+ "enum": [
+ "shifted",
+ "non-ignorable"
+ ]
+ },
+ "_types.analysis.IcuCollationCaseFirst": {
+ "type": "string",
+ "enum": [
+ "lower",
+ "upper"
+ ]
+ },
+ "_types.analysis.IcuCollationDecomposition": {
+ "type": "string",
+ "enum": [
+ "no",
+ "identical"
+ ]
+ },
+ "_types.analysis.IcuCollationStrength": {
+ "type": "string",
+ "enum": [
+ "primary",
+ "secondary",
+ "tertiary",
+ "quaternary",
+ "identical"
+ ]
+ },
+ "_types.analysis.IcuFoldingTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "icu_folding"
+ ]
+ },
+ "unicode_set_filter": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "unicode_set_filter"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.IcuNormalizationTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "icu_normalizer"
+ ]
+ },
+ "name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.IcuNormalizationType"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "name"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.IcuTransformTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "icu_transform"
+ ]
+ },
+ "dir": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.IcuTransformDirection"
+ }
+ ]
+ },
+ "id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "id"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.IcuTransformDirection": {
+ "type": "string",
+ "enum": [
+ "forward",
+ "reverse"
+ ]
+ },
+ "_types.analysis.PhoneticTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "phonetic"
+ ]
+ },
+ "encoder": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.PhoneticEncoder"
+ }
+ ]
+ },
+ "languageset": {
+ "description": "\n\nSupported values include: `any`, `common`, `cyrillic`, `english`, `french`, `german`, `hebrew`, `hungarian`, `polish`, `romanian`, `russian`, `spanish`\n\n",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.PhoneticLanguage"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.analysis.PhoneticLanguage"
+ }
+ }
+ ]
+ },
+ "max_code_len": {
+ "type": "number"
+ },
+ "name_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.PhoneticNameType"
+ }
+ ]
+ },
+ "replace": {
+ "type": "boolean"
+ },
+ "rule_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.PhoneticRuleType"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "encoder"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.PhoneticEncoder": {
+ "type": "string",
+ "enum": [
+ "metaphone",
+ "double_metaphone",
+ "soundex",
+ "refined_soundex",
+ "caverphone1",
+ "caverphone2",
+ "cologne",
+ "nysiis",
+ "koelnerphonetik",
+ "haasephonetik",
+ "beider_morse",
+ "daitch_mokotoff"
+ ]
+ },
+ "_types.analysis.PhoneticLanguage": {
+ "type": "string",
+ "enum": [
+ "any",
+ "common",
+ "cyrillic",
+ "english",
+ "french",
+ "german",
+ "hebrew",
+ "hungarian",
+ "polish",
+ "romanian",
+ "russian",
+ "spanish"
+ ]
+ },
+ "_types.analysis.PhoneticNameType": {
+ "type": "string",
+ "enum": [
+ "generic",
+ "ashkenazi",
+ "sephardic"
+ ]
+ },
+ "_types.analysis.PhoneticRuleType": {
+ "type": "string",
+ "enum": [
+ "approx",
+ "exact"
+ ]
+ },
+ "_types.analysis.DictionaryDecompounderTokenFilter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.CompoundWordTokenFilterBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "dictionary_decompounder"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.Normalizer": {
+ "discriminator": {
+ "propertyName": "type"
+ },
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.LowercaseNormalizer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.CustomNormalizer"
+ }
+ ]
+ },
+ "_types.analysis.LowercaseNormalizer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "lowercase"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.CustomNormalizer": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "custom"
+ ]
+ },
+ "char_filter": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "filter": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.analysis.Tokenizer": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/text-analysis/tokenizer-reference"
+ },
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenizerDefinition"
+ }
+ ]
+ },
+ "_types.analysis.TokenizerDefinition": {
+ "discriminator": {
+ "propertyName": "type"
+ },
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.CharGroupTokenizer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.ClassicTokenizer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.EdgeNGramTokenizer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.KeywordTokenizer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.LetterTokenizer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.LowercaseTokenizer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.NGramTokenizer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.PathHierarchyTokenizer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.PatternTokenizer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.SimplePatternTokenizer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.SimplePatternSplitTokenizer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.StandardTokenizer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.ThaiTokenizer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.UaxEmailUrlTokenizer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.WhitespaceTokenizer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.IcuTokenizer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.KuromojiTokenizer"
+ },
+ {
+ "$ref": "#/components/schemas/_types.analysis.NoriTokenizer"
+ }
+ ]
+ },
+ "_types.analysis.CharGroupTokenizer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenizerBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "char_group"
+ ]
+ },
+ "tokenize_on_chars": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "max_token_length": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "type",
+ "tokenize_on_chars"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.TokenizerBase": {
+ "type": "object",
+ "properties": {
+ "version": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ }
+ }
+ },
+ "_types.analysis.ClassicTokenizer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenizerBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "classic"
+ ]
+ },
+ "max_token_length": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.EdgeNGramTokenizer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenizerBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "edge_ngram"
+ ]
+ },
+ "custom_token_chars": {
+ "type": "string"
+ },
+ "max_gram": {
+ "type": "number"
+ },
+ "min_gram": {
+ "type": "number"
+ },
+ "token_chars": {
+ "default": [],
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.analysis.TokenChar"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.TokenChar": {
+ "type": "string",
+ "enum": [
+ "letter",
+ "digit",
+ "whitespace",
+ "punctuation",
+ "symbol",
+ "custom"
+ ]
+ },
+ "_types.analysis.KeywordTokenizer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenizerBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "keyword"
+ ]
+ },
+ "buffer_size": {
+ "default": 256.0,
+ "type": "number"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.LetterTokenizer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenizerBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "letter"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.LowercaseTokenizer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenizerBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "lowercase"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.NGramTokenizer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenizerBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "ngram"
+ ]
+ },
+ "custom_token_chars": {
+ "type": "string"
+ },
+ "max_gram": {
+ "type": "number"
+ },
+ "min_gram": {
+ "type": "number"
+ },
+ "token_chars": {
+ "default": [],
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.analysis.TokenChar"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.PathHierarchyTokenizer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenizerBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "path_hierarchy"
+ ]
+ },
+ "buffer_size": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger"
+ }
+ ]
+ },
+ "delimiter": {
+ "type": "string"
+ },
+ "replacement": {
+ "type": "string"
+ },
+ "reverse": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.Stringifiedboolean"
+ }
+ ]
+ },
+ "skip": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.Stringifiedinteger"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.PatternTokenizer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenizerBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "pattern"
+ ]
+ },
+ "flags": {
+ "type": "string"
+ },
+ "group": {
+ "type": "number"
+ },
+ "pattern": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.SimplePatternTokenizer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenizerBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "simple_pattern"
+ ]
+ },
+ "pattern": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.SimplePatternSplitTokenizer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenizerBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "simple_pattern_split"
+ ]
+ },
+ "pattern": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.StandardTokenizer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenizerBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "standard"
+ ]
+ },
+ "max_token_length": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.ThaiTokenizer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenizerBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "thai"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.UaxEmailUrlTokenizer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenizerBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "uax_url_email"
+ ]
+ },
+ "max_token_length": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.WhitespaceTokenizer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenizerBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "whitespace"
+ ]
+ },
+ "max_token_length": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.IcuTokenizer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenizerBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "icu_tokenizer"
+ ]
+ },
+ "rule_files": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "rule_files"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.KuromojiTokenizer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenizerBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "kuromoji_tokenizer"
+ ]
+ },
+ "discard_punctuation": {
+ "type": "boolean"
+ },
+ "mode": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.KuromojiTokenizationMode"
+ }
+ ]
+ },
+ "nbest_cost": {
+ "type": "number"
+ },
+ "nbest_examples": {
+ "type": "string"
+ },
+ "user_dictionary": {
+ "type": "string"
+ },
+ "user_dictionary_rules": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "discard_compound_token": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "type",
+ "mode"
+ ]
+ }
+ ]
+ },
+ "_types.analysis.NoriTokenizer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.TokenizerBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "nori_tokenizer"
+ ]
+ },
+ "decompound_mode": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.NoriDecompoundMode"
+ }
+ ]
+ },
+ "discard_punctuation": {
+ "type": "boolean"
+ },
+ "user_dictionary": {
+ "type": "string"
+ },
+ "user_dictionary_rules": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "indices._types.IndexSettingsTimeSeries": {
+ "type": "object",
+ "properties": {
+ "end_time": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "start_time": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.Queries": {
+ "type": "object",
+ "properties": {
+ "cache": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.CacheQueries"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.CacheQueries": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "enabled"
+ ]
+ },
+ "indices._types.SettingsSimilarity": {
+ "discriminator": {
+ "propertyName": "type"
+ },
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.SettingsSimilarityBm25"
+ },
+ {
+ "$ref": "#/components/schemas/indices._types.SettingsSimilarityBoolean"
+ },
+ {
+ "$ref": "#/components/schemas/indices._types.SettingsSimilarityDfi"
+ },
+ {
+ "$ref": "#/components/schemas/indices._types.SettingsSimilarityDfr"
+ },
+ {
+ "$ref": "#/components/schemas/indices._types.SettingsSimilarityIb"
+ },
+ {
+ "$ref": "#/components/schemas/indices._types.SettingsSimilarityLmd"
+ },
+ {
+ "$ref": "#/components/schemas/indices._types.SettingsSimilarityLmj"
+ },
+ {
+ "$ref": "#/components/schemas/indices._types.SettingsSimilarityScripted"
+ }
+ ]
+ },
+ "indices._types.SettingsSimilarityBm25": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "BM25"
+ ]
+ },
+ "b": {
+ "type": "number"
+ },
+ "discount_overlaps": {
+ "type": "boolean"
+ },
+ "k1": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "indices._types.SettingsSimilarityBoolean": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "boolean"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "indices._types.SettingsSimilarityDfi": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "DFI"
+ ]
+ },
+ "independence_measure": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DFIIndependenceMeasure"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "independence_measure"
+ ]
+ },
+ "_types.DFIIndependenceMeasure": {
+ "type": "string",
+ "enum": [
+ "standardized",
+ "saturated",
+ "chisquared"
+ ]
+ },
+ "indices._types.SettingsSimilarityDfr": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "DFR"
+ ]
+ },
+ "after_effect": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DFRAfterEffect"
+ }
+ ]
+ },
+ "basic_model": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DFRBasicModel"
+ }
+ ]
+ },
+ "normalization": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Normalization"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "after_effect",
+ "basic_model",
+ "normalization"
+ ]
+ },
+ "_types.DFRAfterEffect": {
+ "type": "string",
+ "enum": [
+ "no",
+ "b",
+ "l"
+ ]
+ },
+ "_types.DFRBasicModel": {
+ "type": "string",
+ "enum": [
+ "be",
+ "d",
+ "g",
+ "if",
+ "in",
+ "ine",
+ "p"
+ ]
+ },
+ "_types.Normalization": {
+ "type": "string",
+ "enum": [
+ "no",
+ "h1",
+ "h2",
+ "h3",
+ "z"
+ ]
+ },
+ "indices._types.SettingsSimilarityIb": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "IB"
+ ]
+ },
+ "distribution": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IBDistribution"
+ }
+ ]
+ },
+ "lambda": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IBLambda"
+ }
+ ]
+ },
+ "normalization": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Normalization"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "distribution",
+ "lambda",
+ "normalization"
+ ]
+ },
+ "_types.IBDistribution": {
+ "type": "string",
+ "enum": [
+ "ll",
+ "spl"
+ ]
+ },
+ "_types.IBLambda": {
+ "type": "string",
+ "enum": [
+ "df",
+ "ttf"
+ ]
+ },
+ "indices._types.SettingsSimilarityLmd": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "LMDirichlet"
+ ]
+ },
+ "mu": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "indices._types.SettingsSimilarityLmj": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "LMJelinekMercer"
+ ]
+ },
+ "lambda": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "indices._types.SettingsSimilarityScripted": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "scripted"
+ ]
+ },
+ "script": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "weight_script": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "script"
+ ]
+ },
+ "indices._types.MappingLimitSettings": {
+ "description": "Mapping Limit Settings",
+ "type": "object",
+ "properties": {
+ "coerce": {
+ "type": "boolean"
+ },
+ "total_fields": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.MappingLimitSettingsTotalFields"
+ }
+ ]
+ },
+ "depth": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.MappingLimitSettingsDepth"
+ }
+ ]
+ },
+ "nested_fields": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.MappingLimitSettingsNestedFields"
+ }
+ ]
+ },
+ "nested_objects": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.MappingLimitSettingsNestedObjects"
+ }
+ ]
+ },
+ "field_name_length": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.MappingLimitSettingsFieldNameLength"
+ }
+ ]
+ },
+ "dimension_fields": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.MappingLimitSettingsDimensionFields"
+ }
+ ]
+ },
+ "source": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.MappingLimitSettingsSourceFields"
+ }
+ ]
+ },
+ "ignore_malformed": {
+ "oneOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.MappingLimitSettingsTotalFields": {
+ "type": "object",
+ "properties": {
+ "limit": {
+ "description": "The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit.\nThe limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance\ndegradations and memory issues, especially in clusters with a high load or few resources.",
+ "default": "1000",
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "ignore_dynamic_beyond_limit": {
+ "description": "This setting determines what happens when a dynamically mapped field would exceed the total fields limit. When set\nto false (the default), the index request of the document that tries to add a dynamic field to the mapping will fail\nwith the message Limit of total fields [X] has been exceeded. When set to true, the index request will not fail.\nInstead, fields that would exceed the limit are not added to the mapping, similar to dynamic: false.\nThe fields that were not added to the mapping will be added to the _ignored field.",
+ "default": "false",
+ "oneOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.MappingLimitSettingsDepth": {
+ "type": "object",
+ "properties": {
+ "limit": {
+ "description": "The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined\nat the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc.",
+ "default": 20.0,
+ "type": "number"
+ }
+ }
+ },
+ "indices._types.MappingLimitSettingsNestedFields": {
+ "type": "object",
+ "properties": {
+ "limit": {
+ "description": "The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when\narrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this\nsetting limits the number of unique nested types per index.",
+ "default": 50.0,
+ "type": "number"
+ }
+ }
+ },
+ "indices._types.MappingLimitSettingsNestedObjects": {
+ "type": "object",
+ "properties": {
+ "limit": {
+ "description": "The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps\nto prevent out of memory errors when a document contains too many nested objects.",
+ "default": 10000.0,
+ "type": "number"
+ }
+ }
+ },
+ "indices._types.MappingLimitSettingsFieldNameLength": {
+ "type": "object",
+ "properties": {
+ "limit": {
+ "description": "Setting for the maximum length of a field name. This setting isn’t really something that addresses mappings explosion but\nmight still be useful if you want to limit the field length. It usually shouldn’t be necessary to set this setting. The\ndefault is okay unless a user starts to add a huge number of fields with really long names. Default is `Long.MAX_VALUE` (no limit).",
+ "type": "number"
+ }
+ }
+ },
+ "indices._types.MappingLimitSettingsDimensionFields": {
+ "type": "object",
+ "properties": {
+ "limit": {
+ "description": "[preview] This functionality is in technical preview and may be changed or removed in a future release.\nElastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.",
+ "type": "number"
+ }
+ }
+ },
+ "indices._types.MappingLimitSettingsSourceFields": {
+ "type": "object",
+ "properties": {
+ "mode": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.SourceMode"
+ }
+ ]
+ }
+ },
+ "required": [
+ "mode"
+ ]
+ },
+ "indices._types.SourceMode": {
+ "type": "string",
+ "enum": [
+ "disabled",
+ "stored",
+ "synthetic"
+ ]
+ },
+ "indices._types.IndexingSlowlogSettings": {
+ "type": "object",
+ "properties": {
+ "level": {
+ "type": "string"
+ },
+ "source": {
+ "type": "number"
+ },
+ "reformat": {
+ "type": "boolean"
+ },
+ "threshold": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexingSlowlogTresholds"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.IndexingSlowlogTresholds": {
+ "type": "object",
+ "properties": {
+ "index": {
+ "description": "The indexing slow log, similar in functionality to the search slow log. The log file name ends with `_index_indexing_slowlog.json`.\nLog and the thresholds are configured in the same way as the search slowlog.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.SlowlogTresholdLevels"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.IndexingPressure": {
+ "type": "object",
+ "properties": {
+ "memory": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexingPressureMemory"
+ }
+ ]
+ }
+ },
+ "required": [
+ "memory"
+ ]
+ },
+ "indices._types.IndexingPressureMemory": {
+ "type": "object",
+ "properties": {
+ "limit": {
+ "description": "Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded,\nthe node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit,\nthe node will reject new replica operations. Defaults to 10% of the heap.",
+ "type": "number"
+ }
+ }
+ },
+ "indices._types.Storage": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "\n\nSupported values include:\n - `fs`: Default file system implementation. This will pick the best implementation depending on the operating environment, which\nis currently hybridfs on all supported systems but is subject to change.\n - `niofs`: The NIO FS type stores the shard index on the file system (maps to Lucene NIOFSDirectory) using NIO. It allows multiple\nthreads to read from the same file concurrently. It is not recommended on Windows because of a bug in the SUN Java\nimplementation and disables some optimizations for heap memory usage.\n - `mmapfs`: The MMap FS type stores the shard index on the file system (maps to Lucene MMapDirectory) by mapping a file into\nmemory (mmap). Memory mapping uses up a portion of the virtual memory address space in your process equal to the size\nof the file being mapped. Before using this class, be sure you have allowed plenty of virtual address space.\n - `hybridfs`: The hybridfs type is a hybrid of niofs and mmapfs, which chooses the best file system type for each type of file\nbased on the read access pattern. Currently only the Lucene term dictionary, norms and doc values files are memory\nmapped. All other files are opened using Lucene NIOFSDirectory. Similarly to mmapfs be sure you have allowed\nplenty of virtual address space.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.StorageType"
+ }
+ ]
+ },
+ "allow_mmap": {
+ "description": "You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap.\nThis is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This\nsetting is useful, for example, if you are in an environment where you can not control the ability to create a lot\nof memory maps so you need disable the ability to use memory-mapping.",
+ "type": "boolean"
+ },
+ "stats_refresh_interval": {
+ "description": "How often store statistics are refreshed",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "indices._types.StorageType": {
+ "anyOf": [
+ {
+ "type": "string",
+ "enum": [
+ "fs",
+ "niofs",
+ "mmapfs",
+ "hybridfs"
+ ]
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "_types.mapping.TypeMapping": {
+ "type": "object",
+ "properties": {
+ "all_field": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.AllField"
+ }
+ ]
+ },
+ "date_detection": {
+ "type": "boolean"
+ },
+ "dynamic": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DynamicMapping"
+ }
+ ]
+ },
+ "dynamic_date_formats": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "dynamic_templates": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.mapping.DynamicTemplate"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ }
+ },
+ "_field_names": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.FieldNamesField"
+ }
+ ]
+ },
+ "index_field": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.IndexField"
+ }
+ ]
+ },
+ "_meta": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ },
+ "numeric_detection": {
+ "type": "boolean"
+ },
+ "properties": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.mapping.Property"
+ }
+ },
+ "_routing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RoutingField"
+ }
+ ]
+ },
+ "_size": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.SizeField"
+ }
+ ]
+ },
+ "_source": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.SourceField"
+ }
+ ]
+ },
+ "runtime": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.mapping.RuntimeField"
+ }
+ },
+ "enabled": {
+ "type": "boolean"
+ },
+ "subobjects": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.Subobjects"
+ }
+ ]
+ },
+ "_data_stream_timestamp": {
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DataStreamTimestamp"
+ }
+ ]
+ }
+ }
+ },
+ "_types.mapping.AllField": {
+ "type": "object",
+ "properties": {
+ "analyzer": {
+ "type": "string"
+ },
+ "enabled": {
+ "type": "boolean"
+ },
+ "omit_norms": {
+ "type": "boolean"
+ },
+ "search_analyzer": {
+ "type": "string"
+ },
+ "similarity": {
+ "type": "string"
+ },
+ "store": {
+ "type": "boolean"
+ },
+ "store_term_vector_offsets": {
+ "type": "boolean"
+ },
+ "store_term_vector_payloads": {
+ "type": "boolean"
+ },
+ "store_term_vector_positions": {
+ "type": "boolean"
+ },
+ "store_term_vectors": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "analyzer",
+ "enabled",
+ "omit_norms",
+ "search_analyzer",
+ "similarity",
+ "store",
+ "store_term_vector_offsets",
+ "store_term_vector_payloads",
+ "store_term_vector_positions",
+ "store_term_vectors"
+ ]
+ },
+ "_types.mapping.DynamicMapping": {
+ "type": "string",
+ "enum": [
+ "strict",
+ "runtime",
+ "true",
+ "false"
+ ]
+ },
+ "_types.mapping.DynamicTemplate": {
+ "allOf": [
+ {
+ "type": "object",
+ "properties": {
+ "match": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "path_match": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "unmatch": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "path_unmatch": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "match_mapping_type": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "unmatch_mapping_type": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "match_pattern": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.MatchType"
+ }
+ ]
+ }
+ }
+ },
+ {
+ "type": "object",
+ "properties": {
+ "mapping": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.Property"
+ }
+ ]
+ },
+ "runtime": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RuntimeField"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ }
+ ]
+ },
+ "_types.mapping.Property": {
+ "discriminator": {
+ "propertyName": "type"
+ },
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.BinaryProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.BooleanProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.DynamicProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.JoinProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.KeywordProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.MatchOnlyTextProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.PercolatorProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.RankFeatureProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.RankFeaturesProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.SearchAsYouTypeProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.TextProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.VersionProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.WildcardProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.DateNanosProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.DateProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.AggregateMetricDoubleProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.DenseVectorProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.FlattenedProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.NestedProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.ObjectProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.PassthroughObjectProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.RankVectorProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.SemanticTextProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.SparseVectorProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.CompletionProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.ConstantKeywordProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.CountedKeywordProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.FieldAliasProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.HistogramProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.IpProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.Murmur3HashProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.TokenCountProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.GeoPointProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.GeoShapeProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.PointProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.ShapeProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.ByteNumberProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.DoubleNumberProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.FloatNumberProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.HalfFloatNumberProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.IntegerNumberProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.LongNumberProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.ScaledFloatNumberProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.ShortNumberProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.UnsignedLongNumberProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.DateRangeProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.DoubleRangeProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.FloatRangeProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.IntegerRangeProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.IpRangeProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.LongRangeProperty"
+ },
+ {
+ "$ref": "#/components/schemas/_types.mapping.IcuCollationProperty"
+ }
+ ]
+ },
+ "_types.mapping.BinaryProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "binary"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.DocValuesPropertyBase": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.CorePropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "doc_values": {
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "_types.mapping.CorePropertyBase": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.PropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "copy_to": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ },
+ "store": {
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "_types.mapping.PropertyBase": {
+ "type": "object",
+ "properties": {
+ "meta": {
+ "description": "Metadata about the field.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "properties": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.mapping.Property"
+ }
+ },
+ "ignore_above": {
+ "type": "number"
+ },
+ "dynamic": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DynamicMapping"
+ }
+ ]
+ },
+ "fields": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.mapping.Property"
+ }
+ },
+ "synthetic_source_keep": {
+ "description": "\n\nSupported values include:\n - `none`: Synthetic source diverges from the original source (default)\n - `arrays`: Arrays of the corresponding field or object preserve the original element ordering and duplicate elements.\nThe synthetic source fragment for such arrays is not guaranteed to match the original source exactly,\ne.g. array [1, 2, [5], [[4, [3]]], 5] may appear as-is or in an equivalent format like [1, 2, 5, 4, 3, 5].\nThe exact format may change in the future, in an effort to reduce the storage overhead of this option.\n - `all`: The source for both singleton instances and arrays of the corresponding field or object gets recorded.\nWhen applied to objects, the source of all sub-objects and sub-fields gets captured.\nFurthermore, the original source of arrays gets captured and appears in synthetic source with no modifications.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.SyntheticSourceKeepEnum"
+ }
+ ]
+ }
+ }
+ },
+ "_types.mapping.SyntheticSourceKeepEnum": {
+ "type": "string",
+ "enum": [
+ "none",
+ "arrays",
+ "all"
+ ]
+ },
+ "_types.mapping.BooleanProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "boost": {
+ "type": "number"
+ },
+ "fielddata": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.NumericFielddata"
+ }
+ ]
+ },
+ "index": {
+ "type": "boolean"
+ },
+ "null_value": {
+ "type": "boolean"
+ },
+ "ignore_malformed": {
+ "type": "boolean"
+ },
+ "script": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "on_script_error": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.OnScriptError"
+ }
+ ]
+ },
+ "time_series_dimension": {
+ "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.",
+ "x-state": "Technical preview",
+ "type": "boolean"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "boolean"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "indices._types.NumericFielddata": {
+ "type": "object",
+ "properties": {
+ "format": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.NumericFielddataFormat"
+ }
+ ]
+ }
+ },
+ "required": [
+ "format"
+ ]
+ },
+ "indices._types.NumericFielddataFormat": {
+ "type": "string",
+ "enum": [
+ "array",
+ "disabled"
+ ]
+ },
+ "_types.mapping.OnScriptError": {
+ "type": "string",
+ "enum": [
+ "fail",
+ "continue"
+ ]
+ },
+ "_types.mapping.DynamicProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "{dynamic_type}"
+ ]
+ },
+ "enabled": {
+ "type": "boolean"
+ },
+ "null_value": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.FieldValue"
+ }
+ ]
+ },
+ "boost": {
+ "type": "number"
+ },
+ "coerce": {
+ "type": "boolean"
+ },
+ "script": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "on_script_error": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.OnScriptError"
+ }
+ ]
+ },
+ "ignore_malformed": {
+ "type": "boolean"
+ },
+ "time_series_metric": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType"
+ }
+ ]
+ },
+ "analyzer": {
+ "type": "string"
+ },
+ "eager_global_ordinals": {
+ "type": "boolean"
+ },
+ "index": {
+ "type": "boolean"
+ },
+ "index_options": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.IndexOptions"
+ }
+ ]
+ },
+ "index_phrases": {
+ "type": "boolean"
+ },
+ "index_prefixes": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.TextIndexPrefixes"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "norms": {
+ "type": "boolean"
+ },
+ "position_increment_gap": {
+ "type": "number"
+ },
+ "search_analyzer": {
+ "type": "string"
+ },
+ "search_quote_analyzer": {
+ "type": "string"
+ },
+ "term_vector": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.TermVectorOption"
+ }
+ ]
+ },
+ "format": {
+ "type": "string"
+ },
+ "precision_step": {
+ "type": "number"
+ },
+ "locale": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.TimeSeriesMetricType": {
+ "type": "string",
+ "enum": [
+ "gauge",
+ "counter",
+ "summary",
+ "histogram",
+ "position"
+ ]
+ },
+ "_types.mapping.IndexOptions": {
+ "type": "string",
+ "enum": [
+ "docs",
+ "freqs",
+ "positions",
+ "offsets"
+ ]
+ },
+ "_types.mapping.TextIndexPrefixes": {
+ "type": "object",
+ "properties": {
+ "max_chars": {
+ "type": "number"
+ },
+ "min_chars": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "max_chars",
+ "min_chars"
+ ]
+ },
+ "_types.mapping.TermVectorOption": {
+ "type": "string",
+ "enum": [
+ "no",
+ "yes",
+ "with_offsets",
+ "with_positions",
+ "with_positions_offsets",
+ "with_positions_offsets_payloads",
+ "with_positions_payloads"
+ ]
+ },
+ "_types.mapping.JoinProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.PropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "relations": {
+ "type": "object",
+ "additionalProperties": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.RelationName"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.RelationName"
+ }
+ }
+ ]
+ }
+ },
+ "eager_global_ordinals": {
+ "type": "boolean"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "join"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.KeywordProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "boost": {
+ "type": "number"
+ },
+ "eager_global_ordinals": {
+ "type": "boolean"
+ },
+ "index": {
+ "type": "boolean"
+ },
+ "index_options": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.IndexOptions"
+ }
+ ]
+ },
+ "script": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "on_script_error": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.OnScriptError"
+ }
+ ]
+ },
+ "normalizer": {
+ "type": "string"
+ },
+ "norms": {
+ "type": "boolean"
+ },
+ "null_value": {
+ "type": "string"
+ },
+ "similarity": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "split_queries_on_whitespace": {
+ "type": "boolean"
+ },
+ "time_series_dimension": {
+ "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.",
+ "x-state": "Technical preview",
+ "type": "boolean"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "keyword"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.MatchOnlyTextProperty": {
+ "description": "A variant of text that trades scoring and efficiency of positional queries for space efficiency. This field\neffectively stores data the same way as a text field that only indexes documents (index_options: docs) and\ndisables norms (norms: false). Term queries perform as fast if not faster as on text fields, however queries\nthat need positions such as the match_phrase query perform slower as they need to look at the _source document\nto verify whether a phrase matches. All queries return constant scores that are equal to 1.0.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "match_only_text"
+ ]
+ },
+ "fields": {
+ "description": "Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one\nfield for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.mapping.Property"
+ }
+ },
+ "meta": {
+ "description": "Metadata about the field.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "copy_to": {
+ "description": "Allows you to copy the values of multiple fields into a group\nfield, which can then be queried as a single field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.mapping.PercolatorProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.PropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "percolator"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.RankFeatureProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.PropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "positive_score_impact": {
+ "type": "boolean"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "rank_feature"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.RankFeaturesProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.PropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "positive_score_impact": {
+ "type": "boolean"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "rank_features"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.SearchAsYouTypeProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.CorePropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "analyzer": {
+ "type": "string"
+ },
+ "index": {
+ "type": "boolean"
+ },
+ "index_options": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.IndexOptions"
+ }
+ ]
+ },
+ "max_shingle_size": {
+ "type": "number"
+ },
+ "norms": {
+ "type": "boolean"
+ },
+ "search_analyzer": {
+ "type": "string"
+ },
+ "search_quote_analyzer": {
+ "type": "string"
+ },
+ "similarity": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "term_vector": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.TermVectorOption"
+ }
+ ]
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "search_as_you_type"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.TextProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.CorePropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "analyzer": {
+ "type": "string"
+ },
+ "boost": {
+ "type": "number"
+ },
+ "eager_global_ordinals": {
+ "type": "boolean"
+ },
+ "fielddata": {
+ "type": "boolean"
+ },
+ "fielddata_frequency_filter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.FielddataFrequencyFilter"
+ }
+ ]
+ },
+ "index": {
+ "type": "boolean"
+ },
+ "index_options": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.IndexOptions"
+ }
+ ]
+ },
+ "index_phrases": {
+ "type": "boolean"
+ },
+ "index_prefixes": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.TextIndexPrefixes"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "norms": {
+ "type": "boolean"
+ },
+ "position_increment_gap": {
+ "type": "number"
+ },
+ "search_analyzer": {
+ "type": "string"
+ },
+ "search_quote_analyzer": {
+ "type": "string"
+ },
+ "similarity": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "term_vector": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.TermVectorOption"
+ }
+ ]
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "text"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "indices._types.FielddataFrequencyFilter": {
+ "type": "object",
+ "properties": {
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ },
+ "min_segment_size": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "max",
+ "min",
+ "min_segment_size"
+ ]
+ },
+ "_types.mapping.VersionProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "version"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.WildcardProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "wildcard"
+ ]
+ },
+ "null_value": {
+ "x-state": "Generally available",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.DateNanosProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "boost": {
+ "type": "number"
+ },
+ "format": {
+ "type": "string"
+ },
+ "ignore_malformed": {
+ "type": "boolean"
+ },
+ "index": {
+ "type": "boolean"
+ },
+ "script": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "on_script_error": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.OnScriptError"
+ }
+ ]
+ },
+ "null_value": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "precision_step": {
+ "type": "number"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "date_nanos"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.DateProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "boost": {
+ "type": "number"
+ },
+ "fielddata": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.NumericFielddata"
+ }
+ ]
+ },
+ "format": {
+ "type": "string"
+ },
+ "ignore_malformed": {
+ "type": "boolean"
+ },
+ "index": {
+ "type": "boolean"
+ },
+ "script": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "on_script_error": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.OnScriptError"
+ }
+ ]
+ },
+ "null_value": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "precision_step": {
+ "type": "number"
+ },
+ "locale": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "date"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.AggregateMetricDoubleProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.PropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "aggregate_metric_double"
+ ]
+ },
+ "default_metric": {
+ "type": "string"
+ },
+ "ignore_malformed": {
+ "type": "boolean"
+ },
+ "metrics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "time_series_metric": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "default_metric",
+ "metrics"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.DenseVectorProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.PropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "dense_vector"
+ ]
+ },
+ "dims": {
+ "description": "Number of vector dimensions. Can't exceed `4096`. If `dims` is not specified, it will be set to the length of\nthe first vector added to the field.",
+ "type": "number"
+ },
+ "element_type": {
+ "description": "The data type used to encode vectors. The supported data types are `float` (default), `byte`, and `bit`.\n\nSupported values include:\n - `bit`: Indexes a single bit per dimension. Useful for very high-dimensional vectors or models that specifically support\nbit vectors.\n\nNOTE: when using `bit`, the number of dimensions must be a multiple of `8` and must represent the number of bits.\n - `byte`: Indexes a 1-byte integer value per dimension.\n - `float`: Indexes a 4-byte floating-point value per dimension.\n\n",
+ "default": "float",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DenseVectorElementType"
+ }
+ ]
+ },
+ "index": {
+ "description": "If `true`, you can search this field using the kNN search API.",
+ "default": true,
+ "type": "boolean"
+ },
+ "index_options": {
+ "description": "An optional section that configures the kNN indexing algorithm. The HNSW algorithm has two internal parameters\nthat influence how the data structure is built. These can be adjusted to improve the accuracy of results, at the\nexpense of slower indexing speed.\n\nThis parameter can only be specified when `index` is `true`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DenseVectorIndexOptions"
+ }
+ ]
+ },
+ "similarity": {
+ "description": "The vector similarity metric to use in kNN search.\n\nDocuments are ranked by their vector field's similarity to the query vector. The `_score` of each document will\nbe derived from the similarity, in a way that ensures scores are positive and that a larger score corresponds\nto a higher ranking.\n\nDefaults to `l2_norm` when `element_type` is `bit` otherwise defaults to `cosine`.\n\n`bit` vectors only support `l2_norm` as their similarity metric.\n\nThis parameter can only be specified when `index` is `true`.\n\nSupported values include:\n - `cosine`: Computes the cosine similarity. During indexing Elasticsearch automatically normalizes vectors with `cosine`\nsimilarity to unit length. This allows to internally use `dot_product` for computing similarity, which is more\nefficient. Original un-normalized vectors can be still accessed through scripts.\n\nThe document `_score` is computed as `(1 + cosine(query, vector)) / 2`.\n\nThe `cosine` similarity does not allow vectors with zero magnitude, since cosine is not defined in this case.\n - `dot_product`: Computes the dot product of two unit vectors. This option provides an optimized way to perform cosine similarity.\nThe constraints and computed score are defined by `element_type`.\n\nWhen `element_type` is `float`, all vectors must be unit length, including both document and query vectors.\n\nThe document `_score` is computed as `(1 + dot_product(query, vector)) / 2`.\n\nWhen `element_type` is `byte`, all vectors must have the same length including both document and query vectors or\nresults will be inaccurate.\n\nThe document `_score` is computed as `0.5 + (dot_product(query, vector) / (32768 * dims))` where `dims` is the\nnumber of dimensions per vector.\n - `l2_norm`: Computes similarity based on the `L2` distance (also known as Euclidean distance) between the vectors.\n\nThe document `_score` is computed as `1 / (1 + l2_norm(query, vector)^2)`.\n\nFor `bit` vectors, instead of using `l2_norm`, the `hamming` distance between the vectors is used.\n\nThe `_score` transformation is `(numBits - hamming(a, b)) / numBits`.\n - `max_inner_product`: Computes the maximum inner product of two vectors. This is similar to `dot_product`, but doesn't require vectors\nto be normalized. This means that each vector’s magnitude can significantly effect the score.\n\nThe document `_score` is adjusted to prevent negative values. For `max_inner_product` values `< 0`, the `_score`\nis `1 / (1 + -1 * max_inner_product(query, vector))`. For non-negative `max_inner_product` results the `_score`\nis calculated `max_inner_product(query, vector) + 1`.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DenseVectorSimilarity"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.DenseVectorElementType": {
+ "type": "string",
+ "enum": [
+ "bit",
+ "byte",
+ "float"
+ ]
+ },
+ "_types.mapping.DenseVectorIndexOptions": {
+ "type": "object",
+ "properties": {
+ "confidence_interval": {
+ "description": "The confidence interval to use when quantizing the vectors. Can be any value between and including `0.90` and\n`1.0` or exactly `0`. When the value is `0`, this indicates that dynamic quantiles should be calculated for\noptimized quantization. When between `0.90` and `1.0`, this value restricts the values used when calculating\nthe quantization thresholds.\n\nFor example, a value of `0.95` will only use the middle `95%` of the values when calculating the quantization\nthresholds (e.g. the highest and lowest `2.5%` of values will be ignored).\n\nDefaults to `1/(dims + 1)` for `int8` quantized vectors and `0` for `int4` for dynamic quantile calculation.\n\nOnly applicable to `int8_hnsw`, `int4_hnsw`, `int8_flat`, and `int4_flat` index types.",
+ "type": "number"
+ },
+ "ef_construction": {
+ "description": "The number of candidates to track while assembling the list of nearest neighbors for each new node.\n\nOnly applicable to `hnsw`, `int8_hnsw`, `bbq_hnsw`, and `int4_hnsw` index types.",
+ "default": 100.0,
+ "type": "number"
+ },
+ "m": {
+ "description": "The number of neighbors each node will be connected to in the HNSW graph.\n\nOnly applicable to `hnsw`, `int8_hnsw`, `bbq_hnsw`, and `int4_hnsw` index types.",
+ "default": 16.0,
+ "type": "number"
+ },
+ "type": {
+ "description": "The type of kNN algorithm to use.\n\nSupported values include:\n - `bbq_flat`: This utilizes a brute-force search algorithm in addition to automatically quantizing to binary vectors.\nOnly supports `element_type` of `float`.\n - `bbq_hnsw`: This utilizes the HNSW algorithm in addition to automatic binary quantization for scalable approximate kNN\nsearch with `element_type` of `float`.\n\nThis can reduce the memory footprint by nearly 32x at the cost of some accuracy.\n - `flat`: This utilizes a brute-force search algorithm for exact kNN search. This supports all `element_type` values.\n - `hnsw`: This utilizes the HNSW algorithm for scalable approximate kNN search. This supports all `element_type` values.\n - `int4_flat`: This utilizes a brute-force search algorithm in addition to automatically half-byte scalar quantization.\nOnly supports `element_type` of `float`.\n - `int4_hnsw`: This utilizes the HNSW algorithm in addition to automatically scalar quantization for scalable approximate kNN\nsearch with `element_type` of `float`.\n\nThis can reduce the memory footprint by 8x at the cost of some accuracy.\n - `int8_flat`: This utilizes a brute-force search algorithm in addition to automatically scalar quantization. Only supports\n`element_type` of `float`.\n - `int8_hnsw`: The default index type for `float` vectors. This utilizes the HNSW algorithm in addition to automatically scalar\nquantization for scalable approximate kNN search with `element_type` of `float`.\n\nThis can reduce the memory footprint by 4x at the cost of some accuracy.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DenseVectorIndexOptionsType"
+ }
+ ]
+ },
+ "rescore_vector": {
+ "description": "The rescore vector options. This is only applicable to `bbq_hnsw`, `int4_hnsw`, `int8_hnsw`, `bbq_flat`, `int4_flat`, and `int8_flat` index types.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DenseVectorIndexOptionsRescoreVector"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.mapping.DenseVectorIndexOptionsType": {
+ "type": "string",
+ "enum": [
+ "bbq_flat",
+ "bbq_hnsw",
+ "flat",
+ "hnsw",
+ "int4_flat",
+ "int4_hnsw",
+ "int8_flat",
+ "int8_hnsw"
+ ]
+ },
+ "_types.mapping.DenseVectorIndexOptionsRescoreVector": {
+ "type": "object",
+ "properties": {
+ "oversample": {
+ "description": "The oversampling factor to use when searching for the nearest neighbor. This is only applicable to the quantized formats: `bbq_*`, `int4_*`, and `int8_*`.\nWhen provided, `oversample * k` vectors will be gathered and then their scores will be re-computed with the original vectors.\n\nvalid values are between `1.0` and `10.0` (inclusive), or `0` exactly to disable oversampling.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "oversample"
+ ]
+ },
+ "_types.mapping.DenseVectorSimilarity": {
+ "type": "string",
+ "enum": [
+ "cosine",
+ "dot_product",
+ "l2_norm",
+ "max_inner_product"
+ ]
+ },
+ "_types.mapping.FlattenedProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.PropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "boost": {
+ "type": "number"
+ },
+ "depth_limit": {
+ "type": "number"
+ },
+ "doc_values": {
+ "type": "boolean"
+ },
+ "eager_global_ordinals": {
+ "type": "boolean"
+ },
+ "index": {
+ "type": "boolean"
+ },
+ "index_options": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.IndexOptions"
+ }
+ ]
+ },
+ "null_value": {
+ "type": "string"
+ },
+ "similarity": {
+ "type": "string"
+ },
+ "split_queries_on_whitespace": {
+ "type": "boolean"
+ },
+ "time_series_dimensions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "flattened"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.NestedProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.CorePropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "include_in_parent": {
+ "type": "boolean"
+ },
+ "include_in_root": {
+ "type": "boolean"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "nested"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.ObjectProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.CorePropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "subobjects": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.Subobjects"
+ }
+ ]
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "object"
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "_types.mapping.Subobjects": {
+ "type": "string",
+ "enum": [
+ "true",
+ "false"
+ ]
+ },
+ "_types.mapping.PassthroughObjectProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.CorePropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "passthrough"
+ ]
+ },
+ "enabled": {
+ "type": "boolean"
+ },
+ "priority": {
+ "type": "number"
+ },
+ "time_series_dimension": {
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "_types.mapping.RankVectorProperty": {
+ "description": "Technical preview",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.PropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "rank_vectors"
+ ]
+ },
+ "element_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RankVectorElementType"
+ }
+ ]
+ },
+ "dims": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.RankVectorElementType": {
+ "type": "string",
+ "enum": [
+ "byte",
+ "float",
+ "bit"
+ ]
+ },
+ "_types.mapping.SemanticTextProperty": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "semantic_text"
+ ]
+ },
+ "meta": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "inference_id": {
+ "description": "Inference endpoint that will be used to generate embeddings for the field.\nThis parameter cannot be updated. Use the Create inference API to create the endpoint.\nIf `search_inference_id` is specified, the inference endpoint will only be used at index time.",
+ "default": ".elser-2-elasticsearch",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "search_inference_id": {
+ "description": "Inference endpoint that will be used to generate embeddings at query time.\nYou can update this parameter by using the Update mapping API. Use the Create inference API to create the endpoint.\nIf not specified, the inference endpoint defined by inference_id will be used at both index and query time.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "index_options": {
+ "description": "Settings for index_options that override any defaults used by semantic_text, for example\nspecific quantization settings.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.SemanticTextIndexOptions"
+ }
+ ]
+ },
+ "chunking_settings": {
+ "description": "Settings for chunking text into smaller passages. If specified, these will override the\nchunking settings sent in the inference endpoint associated with inference_id. If chunking settings are updated,\nthey will not be applied to existing documents until they are reindexed.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.ChunkingSettings"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "_types.mapping.SemanticTextIndexOptions": {
+ "type": "object",
+ "properties": {
+ "dense_vector": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DenseVectorIndexOptions"
+ }
+ ]
+ }
+ }
+ },
+ "_types.mapping.ChunkingSettings": {
+ "type": "object",
+ "properties": {
+ "strategy": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#chunking-strategies"
+ },
+ "description": "The chunking strategy: `sentence`, `word`, `none` or `recursive`.\n\n * If `strategy` is set to `recursive`, you must also specify:\n\n- `max_chunk_size`\n- either `separators` or`separator_group`\n\nLearn more about different chunking strategies in the linked documentation.",
+ "default": "sentence",
+ "type": "string"
+ },
+ "separator_group": {
+ "description": "This parameter is only applicable when using the `recursive` chunking strategy.\n\nSets a predefined list of separators in the saved chunking settings based on the selected text type.\nValues can be `markdown` or `plaintext`.\n\nUsing this parameter is an alternative to manually specifying a custom `separators` list.",
+ "type": "string"
+ },
+ "separators": {
+ "description": "A list of strings used as possible split points when chunking text with the `recursive` strategy.\n\nEach string can be a plain string or a regular expression (regex) pattern.\nThe system tries each separator in order to split the text, starting from the first item in the list.\n\nAfter splitting, it attempts to recombine smaller pieces into larger chunks that stay within\nthe `max_chunk_size` limit, to reduce the total number of chunks generated.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "max_chunk_size": {
+ "description": "The maximum size of a chunk in words.\nThis value cannot be higher than `300` or lower than `20` (for `sentence` strategy) or `10` (for `word` strategy).",
+ "default": 250.0,
+ "type": "number"
+ },
+ "overlap": {
+ "description": "The number of overlapping words for chunks.\nIt is applicable only to a `word` chunking strategy.\nThis value cannot be higher than half the `max_chunk_size` value.",
+ "default": 100.0,
+ "type": "number"
+ },
+ "sentence_overlap": {
+ "description": "The number of overlapping sentences for chunks.\nIt is applicable only for a `sentence` chunking strategy.\nIt can be either `1` or `0`.",
+ "default": 1.0,
+ "type": "number"
+ }
+ },
+ "required": [
+ "strategy",
+ "separator_group",
+ "separators",
+ "max_chunk_size"
+ ]
+ },
+ "_types.mapping.SparseVectorProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.PropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "store": {
+ "type": "boolean"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "sparse_vector"
+ ]
+ },
+ "index_options": {
+ "description": "Additional index options for the sparse vector field that controls the\ntoken pruning behavior of the sparse vector field.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.SparseVectorIndexOptions"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.SparseVectorIndexOptions": {
+ "type": "object",
+ "properties": {
+ "prune": {
+ "description": "Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance.\nIf prune is true but the pruning_config is not specified, pruning will occur but default values will be used.\nDefault: false",
+ "x-state": "Generally available",
+ "type": "boolean"
+ },
+ "pruning_config": {
+ "description": "Optional pruning configuration.\nIf enabled, this will omit non-significant tokens from the query in order to improve query performance.\nThis is only used if prune is set to true.\nIf prune is set to true but pruning_config is not specified, default values will be used.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.TokenPruningConfig"
+ }
+ ]
+ }
+ }
+ },
+ "_types.mapping.CompletionProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "analyzer": {
+ "type": "string"
+ },
+ "contexts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.mapping.SuggestContext"
+ }
+ },
+ "max_input_length": {
+ "type": "number"
+ },
+ "preserve_position_increments": {
+ "type": "boolean"
+ },
+ "preserve_separators": {
+ "type": "boolean"
+ },
+ "search_analyzer": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "completion"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.SuggestContext": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "path": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "type": {
+ "type": "string"
+ },
+ "precision": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ },
+ "required": [
+ "name",
+ "type"
+ ]
+ },
+ "_types.mapping.ConstantKeywordProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.PropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "object"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "constant_keyword"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.CountedKeywordProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.PropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "counted_keyword"
+ ]
+ },
+ "index": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.FieldAliasProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.PropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "path": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "alias"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.HistogramProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.PropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "ignore_malformed": {
+ "type": "boolean"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "histogram"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.IpProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "boost": {
+ "type": "number"
+ },
+ "index": {
+ "type": "boolean"
+ },
+ "ignore_malformed": {
+ "type": "boolean"
+ },
+ "null_value": {
+ "type": "string"
+ },
+ "on_script_error": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.OnScriptError"
+ }
+ ]
+ },
+ "script": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "time_series_dimension": {
+ "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.",
+ "x-state": "Technical preview",
+ "type": "boolean"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "ip"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.Murmur3HashProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "murmur3"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.TokenCountProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "analyzer": {
+ "type": "string"
+ },
+ "boost": {
+ "type": "number"
+ },
+ "index": {
+ "type": "boolean"
+ },
+ "null_value": {
+ "type": "number"
+ },
+ "enable_position_increments": {
+ "type": "boolean"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "token_count"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.GeoPointProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "ignore_malformed": {
+ "type": "boolean"
+ },
+ "ignore_z_value": {
+ "type": "boolean"
+ },
+ "null_value": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoLocation"
+ }
+ ]
+ },
+ "index": {
+ "type": "boolean"
+ },
+ "on_script_error": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.OnScriptError"
+ }
+ ]
+ },
+ "script": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "geo_point"
+ ]
+ },
+ "time_series_metric": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.GeoPointMetricType"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.GeoPointMetricType": {
+ "type": "string",
+ "enum": [
+ "gauge",
+ "counter",
+ "position"
+ ]
+ },
+ "_types.mapping.GeoShapeProperty": {
+ "description": "The `geo_shape` data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles\nand polygons.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "coerce": {
+ "type": "boolean"
+ },
+ "ignore_malformed": {
+ "type": "boolean"
+ },
+ "ignore_z_value": {
+ "type": "boolean"
+ },
+ "index": {
+ "type": "boolean"
+ },
+ "orientation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.GeoOrientation"
+ }
+ ]
+ },
+ "strategy": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.GeoStrategy"
+ }
+ ]
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "geo_shape"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.GeoOrientation": {
+ "type": "string",
+ "enum": [
+ "right",
+ "RIGHT",
+ "counterclockwise",
+ "ccw",
+ "left",
+ "LEFT",
+ "clockwise",
+ "cw"
+ ]
+ },
+ "_types.mapping.GeoStrategy": {
+ "type": "string",
+ "enum": [
+ "recursive",
+ "term"
+ ]
+ },
+ "_types.mapping.PointProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "ignore_malformed": {
+ "type": "boolean"
+ },
+ "ignore_z_value": {
+ "type": "boolean"
+ },
+ "null_value": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "point"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.ShapeProperty": {
+ "description": "The `shape` data type facilitates the indexing of and searching with arbitrary `x, y` cartesian shapes such as\nrectangles and polygons.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "coerce": {
+ "type": "boolean"
+ },
+ "ignore_malformed": {
+ "type": "boolean"
+ },
+ "ignore_z_value": {
+ "type": "boolean"
+ },
+ "orientation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.GeoOrientation"
+ }
+ ]
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "shape"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.ByteNumberProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.NumberPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "byte"
+ ]
+ },
+ "null_value": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.byte"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.byte": {
+ "type": "number"
+ },
+ "_types.mapping.NumberPropertyBase": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "boost": {
+ "type": "number"
+ },
+ "coerce": {
+ "type": "boolean"
+ },
+ "ignore_malformed": {
+ "type": "boolean"
+ },
+ "index": {
+ "type": "boolean"
+ },
+ "on_script_error": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.OnScriptError"
+ }
+ ]
+ },
+ "script": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "time_series_metric": {
+ "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.",
+ "x-state": "Technical preview",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType"
+ }
+ ]
+ },
+ "time_series_dimension": {
+ "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.",
+ "default": false,
+ "x-state": "Technical preview",
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "_types.mapping.DoubleNumberProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.NumberPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "double"
+ ]
+ },
+ "null_value": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.FloatNumberProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.NumberPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "float"
+ ]
+ },
+ "null_value": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.HalfFloatNumberProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.NumberPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "half_float"
+ ]
+ },
+ "null_value": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.IntegerNumberProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.NumberPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "integer"
+ ]
+ },
+ "null_value": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.LongNumberProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.NumberPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "long"
+ ]
+ },
+ "null_value": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.ScaledFloatNumberProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.NumberPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "scaled_float"
+ ]
+ },
+ "null_value": {
+ "type": "number"
+ },
+ "scaling_factor": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.ShortNumberProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.NumberPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "short"
+ ]
+ },
+ "null_value": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.short"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.short": {
+ "type": "number"
+ },
+ "_types.mapping.UnsignedLongNumberProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.NumberPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "unsigned_long"
+ ]
+ },
+ "null_value": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ulong"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.ulong": {
+ "type": "number"
+ },
+ "_types.mapping.DateRangeProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RangePropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "format": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "date_range"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.RangePropertyBase": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "boost": {
+ "type": "number"
+ },
+ "coerce": {
+ "type": "boolean"
+ },
+ "index": {
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "_types.mapping.DoubleRangeProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RangePropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "double_range"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.FloatRangeProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RangePropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "float_range"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.IntegerRangeProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RangePropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "integer_range"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.IpRangeProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RangePropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "ip_range"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.LongRangeProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RangePropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "long_range"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.IcuCollationProperty": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "icu_collation_keyword"
+ ]
+ },
+ "norms": {
+ "type": "boolean"
+ },
+ "index_options": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.IndexOptions"
+ }
+ ]
+ },
+ "index": {
+ "description": "Should the field be searchable?",
+ "type": "boolean"
+ },
+ "null_value": {
+ "description": "Accepts a string value which is substituted for any explicit null values. Defaults to null, which means the field is treated as missing.",
+ "type": "string"
+ },
+ "rules": {
+ "type": "string"
+ },
+ "language": {
+ "type": "string"
+ },
+ "country": {
+ "type": "string"
+ },
+ "variant": {
+ "type": "string"
+ },
+ "strength": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.IcuCollationStrength"
+ }
+ ]
+ },
+ "decomposition": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.IcuCollationDecomposition"
+ }
+ ]
+ },
+ "alternate": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.IcuCollationAlternate"
+ }
+ ]
+ },
+ "case_level": {
+ "type": "boolean"
+ },
+ "case_first": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.IcuCollationCaseFirst"
+ }
+ ]
+ },
+ "numeric": {
+ "type": "boolean"
+ },
+ "variable_top": {
+ "type": "string"
+ },
+ "hiragana_quaternary_mode": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ }
+ ]
+ },
+ "_types.mapping.MatchType": {
+ "type": "string",
+ "enum": [
+ "simple",
+ "regex"
+ ]
+ },
+ "_types.mapping.FieldNamesField": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "enabled"
+ ]
+ },
+ "_types.mapping.IndexField": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "enabled"
+ ]
+ },
+ "_types.mapping.RoutingField": {
+ "type": "object",
+ "properties": {
+ "required": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "required"
+ ]
+ },
+ "_types.mapping.SizeField": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "enabled"
+ ]
+ },
+ "_types.mapping.SourceField": {
+ "type": "object",
+ "properties": {
+ "compress": {
+ "type": "boolean"
+ },
+ "compress_threshold": {
+ "type": "string"
+ },
+ "enabled": {
+ "type": "boolean"
+ },
+ "excludes": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "includes": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mode": {
+ "description": "\n\nSupported values include:\n - `disabled`\n - `stored`\n - `synthetic`: Instead of storing source documents on disk exactly as you send them,\n Elasticsearch can reconstruct source content on the fly upon retrieval.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.SourceFieldMode"
+ }
+ ]
+ }
+ }
+ },
+ "_types.mapping.SourceFieldMode": {
+ "type": "string",
+ "enum": [
+ "disabled",
+ "stored",
+ "synthetic"
+ ]
+ },
+ "_types.mapping.DataStreamTimestamp": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "enabled"
+ ]
+ },
+ "indices._types.AliasDefinition": {
+ "type": "object",
+ "properties": {
+ "filter": {
+ "description": "Query used to limit documents the alias can access.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "index_routing": {
+ "description": "Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.",
+ "type": "string"
+ },
+ "is_write_index": {
+ "description": "If `true`, the index is the write index for the alias.",
+ "default": false,
+ "type": "boolean"
+ },
+ "routing": {
+ "description": "Value used to route indexing and search operations to a specific shard.",
+ "type": "string"
+ },
+ "search_routing": {
+ "description": "Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.",
+ "type": "string"
+ },
+ "is_hidden": {
+ "description": "If `true`, the alias is hidden.\nAll indices for the alias must have the same `is_hidden` value.",
+ "default": false,
+ "x-state": "Generally available",
+ "type": "boolean"
+ }
+ }
+ },
+ "indices._types.DataStreamLifecycleWithRollover": {
+ "description": "Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions,\nif asked.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.DataStreamLifecycle"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "rollover": {
+ "description": "The conditions which will trigger the rollover of a backing index as configured by the cluster setting `cluster.lifecycle.default.rollover`.\nThis property is an implementation detail and it will only be retrieved when the query param `include_defaults` is set to true.\nThe contents of this field are subject to change.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.DataStreamLifecycleRolloverConditions"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "indices._types.DataStreamLifecycleRolloverConditions": {
+ "type": "object",
+ "properties": {
+ "min_age": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "max_age": {
+ "type": "string"
+ },
+ "min_docs": {
+ "type": "number"
+ },
+ "max_docs": {
+ "type": "number"
+ },
+ "min_size": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "max_size": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "min_primary_shard_size": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "max_primary_shard_size": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "min_primary_shard_docs": {
+ "type": "number"
+ },
+ "max_primary_shard_docs": {
+ "type": "number"
+ }
+ }
+ },
+ "indices._types.DataStreamLifecycle": {
+ "description": "Data stream lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration.",
+ "type": "object",
+ "properties": {
+ "data_retention": {
+ "description": "If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "downsampling": {
+ "description": "The downsampling configuration to execute for the managed backing index after rollover.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.DataStreamLifecycleDownsampling"
+ }
+ ]
+ },
+ "enabled": {
+ "description": "If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream.",
+ "default": true,
+ "type": "boolean"
+ }
+ }
+ },
+ "indices._types.DataStreamLifecycleDownsampling": {
+ "type": "object",
+ "properties": {
+ "rounds": {
+ "description": "The list of downsampling rounds to execute as part of this downsampling configuration",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/indices._types.DownsamplingRound"
+ }
+ }
+ },
+ "required": [
+ "rounds"
+ ]
+ },
+ "indices._types.DownsamplingRound": {
+ "type": "object",
+ "properties": {
+ "after": {
+ "description": "The duration since rollover when this downsampling round should execute",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "config": {
+ "description": "The downsample configuration to execute.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.DownsampleConfig"
+ }
+ ]
+ }
+ },
+ "required": [
+ "after",
+ "config"
+ ]
+ },
+ "indices._types.DownsampleConfig": {
+ "type": "object",
+ "properties": {
+ "fixed_interval": {
+ "description": "The interval at which to aggregate the original time series index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationLarge"
+ }
+ ]
+ }
+ },
+ "required": [
+ "fixed_interval"
+ ]
+ },
+ "indices._types.DataStreamOptionsTemplate": {
+ "description": "Data stream options template contains the same information as DataStreamOptions but allows them to be set explicitly to null.",
+ "type": "object",
+ "properties": {
+ "failure_store": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.DataStreamFailureStoreTemplate"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.DataStreamFailureStoreTemplate": {
+ "description": "Template equivalent of DataStreamFailureStore that allows nullable values.",
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "description": "If defined, it turns the failure store on/off (`true`/`false`) for this data stream. A data stream failure store\nthat's disabled (enabled: `false`) will redirect no new failed indices to the failure store; however, it will\nnot remove any existing data from the failure store.",
+ "default": "true",
+ "oneOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "lifecycle": {
+ "description": "If defined, it specifies the lifecycle configuration for the failure store of this data stream.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.FailureStoreLifecycleTemplate"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.FailureStoreLifecycleTemplate": {
+ "description": "Template equivalent of FailureStoreLifecycle that allows nullable values.",
+ "type": "object",
+ "properties": {
+ "data_retention": {
+ "description": "If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "enabled": {
+ "description": "If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream.",
+ "default": true,
+ "type": "boolean"
+ }
+ }
+ },
+ "_types.ClusterInfoTargets": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.ClusterInfoTarget"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.ClusterInfoTarget"
+ }
+ }
+ ]
+ },
+ "_types.ClusterInfoTarget": {
+ "type": "string",
+ "enum": [
+ "_all",
+ "http",
+ "ingest",
+ "thread_pool",
+ "script"
+ ]
+ },
+ "nodes._types.Http": {
+ "type": "object",
+ "properties": {
+ "current_open": {
+ "description": "Current number of open HTTP connections for the node.",
+ "type": "number"
+ },
+ "total_opened": {
+ "description": "Total number of HTTP connections opened for the node.",
+ "type": "number"
+ },
+ "clients": {
+ "description": "Information on current and recently-closed HTTP client connections.\nClients that have been closed longer than the `http.client_stats.closed_channels.max_age` setting will not be represented here.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/nodes._types.Client"
+ }
+ }
+ }
+ },
+ "nodes._types.Client": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique ID for the HTTP client.",
+ "type": "number"
+ },
+ "agent": {
+ "description": "Reported agent for the HTTP client.\nIf unavailable, this property is not included in the response.",
+ "type": "string"
+ },
+ "local_address": {
+ "description": "Local address for the HTTP connection.",
+ "type": "string"
+ },
+ "remote_address": {
+ "description": "Remote address for the HTTP connection.",
+ "type": "string"
+ },
+ "last_uri": {
+ "description": "The URI of the client’s most recent request.",
+ "type": "string"
+ },
+ "opened_time_millis": {
+ "description": "Time at which the client opened the connection.",
+ "type": "number"
+ },
+ "closed_time_millis": {
+ "description": "Time at which the client closed the connection if the connection is closed.",
+ "type": "number"
+ },
+ "last_request_time_millis": {
+ "description": "Time of the most recent request from this client.",
+ "type": "number"
+ },
+ "request_count": {
+ "description": "Number of requests from this client.",
+ "type": "number"
+ },
+ "request_size_bytes": {
+ "description": "Cumulative size in bytes of all requests from this client.",
+ "type": "number"
+ },
+ "x_opaque_id": {
+ "description": "Value from the client’s `x-opaque-id` HTTP header.\nIf unavailable, this property is not included in the response.",
+ "type": "string"
+ }
+ }
+ },
+ "nodes._types.Ingest": {
+ "type": "object",
+ "properties": {
+ "pipelines": {
+ "description": "Contains statistics about ingest pipelines for the node.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/nodes._types.IngestStats"
+ }
+ },
+ "total": {
+ "description": "Contains statistics about ingest operations for the node.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/nodes._types.IngestTotal"
+ }
+ ]
+ }
+ }
+ },
+ "nodes._types.IngestStats": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "description": "Total number of documents ingested during the lifetime of this node.",
+ "type": "number"
+ },
+ "current": {
+ "description": "Total number of documents currently being ingested.",
+ "type": "number"
+ },
+ "failed": {
+ "description": "Total number of failed ingest operations during the lifetime of this node.",
+ "type": "number"
+ },
+ "processors": {
+ "description": "Total number of ingest processors.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/nodes._types.KeyedProcessor"
+ }
+ }
+ },
+ "time_in_millis": {
+ "description": "Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitMillis"
+ }
+ ]
+ },
+ "ingested_as_first_pipeline_in_bytes": {
+ "description": "Total number of bytes of all documents ingested by the pipeline.\nThis field is only present on pipelines which are the first to process a document.\nThus, it is not present on pipelines which only serve as a final pipeline after a default pipeline, a pipeline run after a reroute processor, or pipelines in pipeline processors.",
+ "x-state": "Generally available",
+ "type": "number"
+ },
+ "produced_as_first_pipeline_in_bytes": {
+ "description": "Total number of bytes of all documents produced by the pipeline.\nThis field is only present on pipelines which are the first to process a document.\nThus, it is not present on pipelines which only serve as a final pipeline after a default pipeline, a pipeline run after a reroute processor, or pipelines in pipeline processors.\nIn situations where there are subsequent pipelines, the value represents the size of the document after all pipelines have run.",
+ "x-state": "Generally available",
+ "type": "number"
+ }
+ },
+ "required": [
+ "count",
+ "current",
+ "failed",
+ "processors",
+ "time_in_millis",
+ "ingested_as_first_pipeline_in_bytes",
+ "produced_as_first_pipeline_in_bytes"
+ ]
+ },
+ "nodes._types.KeyedProcessor": {
+ "type": "object",
+ "properties": {
+ "stats": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/nodes._types.Processor"
+ }
+ ]
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ },
+ "nodes._types.Processor": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "description": "Number of documents transformed by the processor.",
+ "type": "number"
+ },
+ "current": {
+ "description": "Number of documents currently being transformed by the processor.",
+ "type": "number"
+ },
+ "failed": {
+ "description": "Number of failed operations for the processor.",
+ "type": "number"
+ },
+ "time_in_millis": {
+ "description": "Time, in milliseconds, spent by the processor transforming documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitMillis"
+ }
+ ]
+ }
+ }
+ },
+ "nodes._types.IngestTotal": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "description": "Total number of documents ingested during the lifetime of this node.",
+ "type": "number"
+ },
+ "current": {
+ "description": "Total number of documents currently being ingested.",
+ "type": "number"
+ },
+ "failed": {
+ "description": "Total number of failed ingest operations during the lifetime of this node.",
+ "type": "number"
+ },
+ "time_in_millis": {
+ "description": "Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitMillis"
+ }
+ ]
+ }
+ },
+ "required": [
+ "count",
+ "current",
+ "failed",
+ "time_in_millis"
+ ]
+ },
+ "nodes._types.ThreadCount": {
+ "type": "object",
+ "properties": {
+ "active": {
+ "description": "Number of active threads in the thread pool.",
+ "type": "number"
+ },
+ "completed": {
+ "description": "Number of tasks completed by the thread pool executor.",
+ "type": "number"
+ },
+ "largest": {
+ "description": "Highest number of active threads in the thread pool.",
+ "type": "number"
+ },
+ "queue": {
+ "description": "Number of tasks in queue for the thread pool.",
+ "type": "number"
+ },
+ "rejected": {
+ "description": "Number of tasks rejected by the thread pool executor.",
+ "type": "number"
+ },
+ "threads": {
+ "description": "Number of threads in the thread pool.",
+ "type": "number"
+ }
+ }
+ },
+ "nodes._types.Scripting": {
+ "type": "object",
+ "properties": {
+ "cache_evictions": {
+ "description": "Total number of times the script cache has evicted old data.",
+ "type": "number"
+ },
+ "compilations": {
+ "description": "Total number of inline script compilations performed by the node.",
+ "type": "number"
+ },
+ "compilations_history": {
+ "description": "Contains this recent history of script compilations.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "number"
+ }
+ },
+ "compilation_limit_triggered": {
+ "description": "Total number of times the script compilation circuit breaker has limited inline script compilations.",
+ "type": "number"
+ },
+ "contexts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/nodes._types.Context"
+ }
+ }
+ }
+ },
+ "nodes._types.Context": {
+ "type": "object",
+ "properties": {
+ "context": {
+ "type": "string"
+ },
+ "compilations": {
+ "type": "number"
+ },
+ "cache_evictions": {
+ "type": "number"
+ },
+ "compilation_limit_triggered": {
+ "type": "number"
+ }
+ }
+ },
+ "indices._types.IndexState": {
+ "type": "object",
+ "properties": {
+ "aliases": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/indices._types.Alias"
+ }
+ },
+ "mappings": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.TypeMapping"
+ }
+ ]
+ },
+ "settings": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexSettings"
+ }
+ ]
+ },
+ "defaults": {
+ "description": "Default settings, included when the request's `include_default` is `true`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexSettings"
+ }
+ ]
+ },
+ "data_stream": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DataStreamName"
+ }
+ ]
+ },
+ "lifecycle": {
+ "description": "Data stream lifecycle applicable if this is a data stream.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.DataStreamLifecycle"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.Alias": {
+ "type": "object",
+ "properties": {
+ "filter": {
+ "description": "Query used to limit documents the alias can access.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "index_routing": {
+ "description": "Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Routing"
+ }
+ ]
+ },
+ "is_hidden": {
+ "description": "If `true`, the alias is hidden.\nAll indices for the alias must have the same `is_hidden` value.",
+ "default": false,
+ "type": "boolean"
+ },
+ "is_write_index": {
+ "description": "If `true`, the index is the write index for the alias.",
+ "default": false,
+ "type": "boolean"
+ },
+ "routing": {
+ "description": "Value used to route indexing and search operations to a specific shard.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Routing"
+ }
+ ]
+ },
+ "search_routing": {
+ "description": "Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Routing"
+ }
+ ]
+ }
+ }
+ },
+ "_types.DataStreamName": {
+ "type": "string"
+ },
+ "_types.Result": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "deleted",
+ "not_found",
+ "noop"
+ ]
+ },
+ "connector._types.Connector": {
+ "type": "object",
+ "properties": {
+ "api_key_id": {
+ "type": "string"
+ },
+ "api_key_secret_id": {
+ "type": "string"
+ },
+ "configuration": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.ConnectorConfiguration"
+ }
+ ]
+ },
+ "custom_scheduling": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.ConnectorCustomScheduling"
+ }
+ ]
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string"
+ },
+ "error": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "features": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.ConnectorFeatures"
+ }
+ ]
+ },
+ "filtering": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/connector._types.FilteringConfig"
+ }
+ },
+ "id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "index_name": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "is_native": {
+ "type": "boolean"
+ },
+ "language": {
+ "type": "string"
+ },
+ "last_access_control_sync_error": {
+ "type": "string"
+ },
+ "last_access_control_sync_scheduled_at": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "last_access_control_sync_status": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.SyncStatus"
+ }
+ ]
+ },
+ "last_deleted_document_count": {
+ "type": "number"
+ },
+ "last_incremental_sync_scheduled_at": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "last_indexed_document_count": {
+ "type": "number"
+ },
+ "last_seen": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "last_sync_error": {
+ "type": "string"
+ },
+ "last_sync_scheduled_at": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "last_sync_status": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.SyncStatus"
+ }
+ ]
+ },
+ "last_synced": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "name": {
+ "type": "string"
+ },
+ "pipeline": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.IngestPipelineParams"
+ }
+ ]
+ },
+ "scheduling": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.SchedulingConfiguration"
+ }
+ ]
+ },
+ "service_type": {
+ "type": "string"
+ },
+ "status": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.ConnectorStatus"
+ }
+ ]
+ },
+ "sync_cursor": {
+ "type": "object"
+ },
+ "sync_now": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "configuration",
+ "custom_scheduling",
+ "deleted",
+ "filtering",
+ "is_native",
+ "scheduling",
+ "status",
+ "sync_now"
+ ]
+ },
+ "connector._types.ConnectorConfiguration": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/connector._types.ConnectorConfigProperties"
+ }
+ },
+ "connector._types.ConnectorConfigProperties": {
+ "type": "object",
+ "properties": {
+ "category": {
+ "type": "string"
+ },
+ "default_value": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScalarValue"
+ }
+ ]
+ },
+ "depends_on": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/connector._types.Dependency"
+ }
+ },
+ "display": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.DisplayType"
+ }
+ ]
+ },
+ "label": {
+ "type": "string"
+ },
+ "options": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/connector._types.SelectOption"
+ }
+ },
+ "order": {
+ "type": "number"
+ },
+ "placeholder": {
+ "type": "string"
+ },
+ "required": {
+ "type": "boolean"
+ },
+ "sensitive": {
+ "type": "boolean"
+ },
+ "tooltip": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.ConnectorFieldType"
+ }
+ ]
+ },
+ "ui_restrictions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "validations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/connector._types.Validation"
+ }
+ },
+ "value": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "default_value",
+ "depends_on",
+ "display",
+ "label",
+ "options",
+ "required",
+ "sensitive",
+ "value"
+ ]
+ },
+ "_types.ScalarValue": {
+ "description": "A scalar value.",
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "string"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "connector._types.Dependency": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "type": "string"
+ },
+ "value": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScalarValue"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field",
+ "value"
+ ]
+ },
+ "connector._types.DisplayType": {
+ "type": "string",
+ "enum": [
+ "textbox",
+ "textarea",
+ "numeric",
+ "toggle",
+ "dropdown"
+ ]
+ },
+ "connector._types.SelectOption": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "value": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScalarValue"
+ }
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "value"
+ ]
+ },
+ "connector._types.ConnectorFieldType": {
+ "type": "string",
+ "enum": [
+ "str",
+ "int",
+ "list",
+ "bool"
+ ]
+ },
+ "connector._types.Validation": {
+ "discriminator": {
+ "propertyName": "type"
+ },
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.LessThanValidation"
+ },
+ {
+ "$ref": "#/components/schemas/connector._types.GreaterThanValidation"
+ },
+ {
+ "$ref": "#/components/schemas/connector._types.ListTypeValidation"
+ },
+ {
+ "$ref": "#/components/schemas/connector._types.IncludedInValidation"
+ },
+ {
+ "$ref": "#/components/schemas/connector._types.RegexValidation"
+ }
+ ]
+ },
+ "connector._types.LessThanValidation": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "less_than"
+ ]
+ },
+ "constraint": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "type",
+ "constraint"
+ ]
+ },
+ "connector._types.GreaterThanValidation": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "greater_than"
+ ]
+ },
+ "constraint": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "type",
+ "constraint"
+ ]
+ },
+ "connector._types.ListTypeValidation": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "list_type"
+ ]
+ },
+ "constraint": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "constraint"
+ ]
+ },
+ "connector._types.IncludedInValidation": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "included_in"
+ ]
+ },
+ "constraint": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.ScalarValue"
+ }
+ }
+ },
+ "required": [
+ "type",
+ "constraint"
+ ]
+ },
+ "connector._types.RegexValidation": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "regex"
+ ]
+ },
+ "constraint": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "constraint"
+ ]
+ },
+ "connector._types.ConnectorCustomScheduling": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/connector._types.CustomScheduling"
+ }
+ },
+ "connector._types.CustomScheduling": {
+ "type": "object",
+ "properties": {
+ "configuration_overrides": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.CustomSchedulingConfigurationOverrides"
+ }
+ ]
+ },
+ "enabled": {
+ "type": "boolean"
+ },
+ "interval": {
+ "type": "string"
+ },
+ "last_synced": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "configuration_overrides",
+ "enabled",
+ "interval",
+ "name"
+ ]
+ },
+ "connector._types.CustomSchedulingConfigurationOverrides": {
+ "type": "object",
+ "properties": {
+ "max_crawl_depth": {
+ "type": "number"
+ },
+ "sitemap_discovery_disabled": {
+ "type": "boolean"
+ },
+ "domain_allowlist": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "sitemap_urls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "seed_urls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "connector._types.ConnectorFeatures": {
+ "type": "object",
+ "properties": {
+ "document_level_security": {
+ "description": "Indicates whether document-level security is enabled.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.FeatureEnabled"
+ }
+ ]
+ },
+ "incremental_sync": {
+ "description": "Indicates whether incremental syncs are enabled.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.FeatureEnabled"
+ }
+ ]
+ },
+ "native_connector_api_keys": {
+ "description": "Indicates whether managed connector API keys are enabled.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.FeatureEnabled"
+ }
+ ]
+ },
+ "sync_rules": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.SyncRulesFeature"
+ }
+ ]
+ }
+ }
+ },
+ "connector._types.FeatureEnabled": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "enabled"
+ ]
+ },
+ "connector._types.SyncRulesFeature": {
+ "type": "object",
+ "properties": {
+ "advanced": {
+ "description": "Indicates whether advanced sync rules are enabled.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.FeatureEnabled"
+ }
+ ]
+ },
+ "basic": {
+ "description": "Indicates whether basic sync rules are enabled.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.FeatureEnabled"
+ }
+ ]
+ }
+ }
+ },
+ "connector._types.FilteringConfig": {
+ "type": "object",
+ "properties": {
+ "active": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.FilteringRules"
+ }
+ ]
+ },
+ "domain": {
+ "type": "string"
+ },
+ "draft": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.FilteringRules"
+ }
+ ]
+ }
+ },
+ "required": [
+ "active",
+ "draft"
+ ]
+ },
+ "connector._types.FilteringRules": {
+ "type": "object",
+ "properties": {
+ "advanced_snippet": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.FilteringAdvancedSnippet"
+ }
+ ]
+ },
+ "rules": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/connector._types.FilteringRule"
+ }
+ },
+ "validation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.FilteringRulesValidation"
+ }
+ ]
+ }
+ },
+ "required": [
+ "advanced_snippet",
+ "rules",
+ "validation"
+ ]
+ },
+ "connector._types.FilteringAdvancedSnippet": {
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "updated_at": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "value": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "value"
+ ]
+ },
+ "connector._types.FilteringRule": {
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "field": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "order": {
+ "type": "number"
+ },
+ "policy": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.FilteringPolicy"
+ }
+ ]
+ },
+ "rule": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.FilteringRuleRule"
+ }
+ ]
+ },
+ "updated_at": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "value": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "field",
+ "id",
+ "order",
+ "policy",
+ "rule",
+ "value"
+ ]
+ },
+ "connector._types.FilteringPolicy": {
+ "type": "string",
+ "enum": [
+ "exclude",
+ "include"
+ ]
+ },
+ "connector._types.FilteringRuleRule": {
+ "type": "string",
+ "enum": [
+ "contains",
+ "ends_with",
+ "equals",
+ "regex",
+ "starts_with",
+ ">",
+ "<"
+ ]
+ },
+ "connector._types.FilteringRulesValidation": {
+ "type": "object",
+ "properties": {
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/connector._types.FilteringValidation"
+ }
+ },
+ "state": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.FilteringValidationState"
+ }
+ ]
+ }
+ },
+ "required": [
+ "errors",
+ "state"
+ ]
+ },
+ "connector._types.FilteringValidation": {
+ "type": "object",
+ "properties": {
+ "ids": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ },
+ "messages": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "ids",
+ "messages"
+ ]
+ },
+ "connector._types.FilteringValidationState": {
+ "type": "string",
+ "enum": [
+ "edited",
+ "invalid",
+ "valid"
+ ]
+ },
+ "connector._types.SyncStatus": {
+ "type": "string",
+ "enum": [
+ "canceling",
+ "canceled",
+ "completed",
+ "error",
+ "in_progress",
+ "pending",
+ "suspended"
+ ]
+ },
+ "connector._types.IngestPipelineParams": {
+ "type": "object",
+ "properties": {
+ "extract_binary_content": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string"
+ },
+ "reduce_whitespace": {
+ "type": "boolean"
+ },
+ "run_ml_inference": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "extract_binary_content",
+ "name",
+ "reduce_whitespace",
+ "run_ml_inference"
+ ]
+ },
+ "connector._types.SchedulingConfiguration": {
+ "type": "object",
+ "properties": {
+ "access_control": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.ConnectorScheduling"
+ }
+ ]
+ },
+ "full": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.ConnectorScheduling"
+ }
+ ]
+ },
+ "incremental": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.ConnectorScheduling"
+ }
+ ]
+ }
+ }
+ },
+ "connector._types.ConnectorScheduling": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "interval": {
+ "description": "The interval is expressed using the crontab syntax",
+ "type": "string"
+ }
+ },
+ "required": [
+ "enabled",
+ "interval"
+ ]
+ },
+ "connector._types.ConnectorStatus": {
+ "type": "string",
+ "enum": [
+ "created",
+ "needs_configuration",
+ "configured",
+ "connected",
+ "error"
+ ]
+ },
+ "connector._types.ConnectorSyncJob": {
+ "type": "object",
+ "properties": {
+ "cancelation_requested_at": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "canceled_at": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "completed_at": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "connector": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.SyncJobConnectorReference"
+ }
+ ]
+ },
+ "created_at": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "deleted_document_count": {
+ "type": "number"
+ },
+ "error": {
+ "type": "string"
+ },
+ "id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "indexed_document_count": {
+ "type": "number"
+ },
+ "indexed_document_volume": {
+ "type": "number"
+ },
+ "job_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.SyncJobType"
+ }
+ ]
+ },
+ "last_seen": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "metadata": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "started_at": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "status": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.SyncStatus"
+ }
+ ]
+ },
+ "total_document_count": {
+ "type": "number"
+ },
+ "trigger_method": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.SyncJobTriggerMethod"
+ }
+ ]
+ },
+ "worker_hostname": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "connector",
+ "created_at",
+ "deleted_document_count",
+ "id",
+ "indexed_document_count",
+ "indexed_document_volume",
+ "job_type",
+ "metadata",
+ "status",
+ "total_document_count",
+ "trigger_method"
+ ]
+ },
+ "connector._types.SyncJobConnectorReference": {
+ "type": "object",
+ "properties": {
+ "configuration": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.ConnectorConfiguration"
+ }
+ ]
+ },
+ "filtering": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.FilteringRules"
+ }
+ ]
+ },
+ "id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "index_name": {
+ "type": "string"
+ },
+ "language": {
+ "type": "string"
+ },
+ "pipeline": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/connector._types.IngestPipelineParams"
+ }
+ ]
+ },
+ "service_type": {
+ "type": "string"
+ },
+ "sync_cursor": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "configuration",
+ "filtering",
+ "id",
+ "index_name",
+ "service_type"
+ ]
+ },
+ "connector._types.SyncJobType": {
+ "type": "string",
+ "enum": [
+ "full",
+ "incremental",
+ "access_control"
+ ]
+ },
+ "connector._types.SyncJobTriggerMethod": {
+ "type": "string",
+ "enum": [
+ "on_demand",
+ "scheduled"
+ ]
+ },
+ "_types.WriteResponseBase": {
+ "type": "object",
+ "properties": {
+ "_id": {
+ "description": "The unique identifier for the added document.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "_index": {
+ "description": "The name of the index the document was added to.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "_primary_term": {
+ "description": "The primary term assigned to the document for the indexing operation.",
+ "type": "number"
+ },
+ "result": {
+ "description": "The result of the indexing operation: `created` or `updated`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Result"
+ }
+ ]
+ },
+ "_seq_no": {
+ "description": "The sequence number assigned to the document for the indexing operation.\nSequence numbers are used to ensure an older version of a document doesn't overwrite a newer version.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SequenceNumber"
+ }
+ ]
+ },
+ "_shards": {
+ "description": "Information about the replication process of the operation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ShardStatistics"
+ }
+ ]
+ },
+ "_version": {
+ "description": "The document version, which is incremented each time the document is updated.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ }
+ ]
+ },
+ "forced_refresh": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "_id",
+ "_index",
+ "result",
+ "_shards",
+ "_version"
+ ]
+ },
+ "_types.Conflicts": {
+ "type": "string",
+ "enum": [
+ "abort",
+ "proceed"
+ ]
+ },
+ "_types.Slices": {
+ "description": "Slices configuration used to parallelize a process.",
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "$ref": "#/components/schemas/_types.SlicesCalculation"
+ }
+ ]
+ },
+ "_types.SlicesCalculation": {
+ "type": "string",
+ "enum": [
+ "auto"
+ ]
+ },
+ "_types.BulkIndexByScrollFailure": {
+ "type": "object",
+ "properties": {
+ "cause": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ErrorCause"
+ }
+ ]
+ },
+ "id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "index": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "status": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "cause",
+ "id",
+ "index",
+ "status"
+ ]
+ },
+ "_types.Retries": {
+ "type": "object",
+ "properties": {
+ "bulk": {
+ "description": "The number of bulk actions retried.",
+ "type": "number"
+ },
+ "search": {
+ "description": "The number of search actions retried.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "bulk",
+ "search"
+ ]
+ },
+ "_types.TaskId": {
+ "type": "string"
+ },
+ "enrich.execute_policy.ExecuteEnrichPolicyStatus": {
+ "type": "object",
+ "properties": {
+ "phase": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/enrich.execute_policy.EnrichPolicyPhase"
+ }
+ ]
+ },
+ "step": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "phase"
+ ]
+ },
+ "enrich.execute_policy.EnrichPolicyPhase": {
+ "type": "string",
+ "enum": [
+ "SCHEDULED",
+ "RUNNING",
+ "COMPLETE",
+ "FAILED",
+ "CANCELLED"
+ ]
+ },
+ "enrich._types.Summary": {
+ "type": "object",
+ "properties": {
+ "config": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/enrich._types.Policy"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ }
+ },
+ "required": [
+ "config"
+ ]
+ },
+ "enrich._types.Policy": {
+ "type": "object",
+ "properties": {
+ "enrich_fields": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ },
+ "indices": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Indices"
+ }
+ ]
+ },
+ "match_field": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "query": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "elasticsearch_version": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "enrich_fields",
+ "indices",
+ "match_field"
+ ]
+ },
+ "eql._types.EqlSearchResponseBase": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Identifier for the search.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "is_partial": {
+ "description": "If true, the response does not contain complete search results.",
+ "type": "boolean"
+ },
+ "is_running": {
+ "description": "If true, the search request is still executing.",
+ "type": "boolean"
+ },
+ "took": {
+ "description": "Milliseconds it took Elasticsearch to execute the request.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitMillis"
+ }
+ ]
+ },
+ "timed_out": {
+ "description": "If true, the request timed out before completion.",
+ "type": "boolean"
+ },
+ "hits": {
+ "description": "Contains matching events and sequences. Also contains related metadata.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/eql._types.EqlHits"
+ }
+ ]
+ },
+ "shard_failures": {
+ "description": "Contains information about shard failures (if any), in case allow_partial_search_results=true",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.ShardFailure"
+ }
+ }
+ },
+ "required": [
+ "hits"
+ ]
+ },
+ "eql._types.EqlHits": {
+ "type": "object",
+ "properties": {
+ "total": {
+ "description": "Metadata about the number of matching events or sequences.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.TotalHits"
+ }
+ ]
+ },
+ "events": {
+ "description": "Contains events matching the query. Each object represents a matching event.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/eql._types.HitsEvent"
+ }
+ },
+ "sequences": {
+ "description": "Contains event sequences matching the query. Each object represents a matching sequence. This parameter is only returned for EQL queries containing a sequence.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/eql._types.HitsSequence"
+ }
+ }
+ }
+ },
+ "eql._types.HitsEvent": {
+ "type": "object",
+ "properties": {
+ "_index": {
+ "description": "Name of the index containing the event.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "_id": {
+ "description": "Unique identifier for the event. This ID is only unique within the index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "_source": {
+ "description": "Original JSON body passed for the event at index time.",
+ "type": "object"
+ },
+ "missing": {
+ "description": "Set to `true` for events in a timespan-constrained sequence that do not meet a given condition.",
+ "type": "boolean"
+ },
+ "fields": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "required": [
+ "_index",
+ "_id",
+ "_source"
+ ]
+ },
+ "eql._types.HitsSequence": {
+ "type": "object",
+ "properties": {
+ "events": {
+ "description": "Contains events matching the query. Each object represents a matching event.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/eql._types.HitsEvent"
+ }
+ },
+ "join_keys": {
+ "description": "Shared field values used to constrain matches in the sequence. These are defined using the by keyword in the EQL query syntax.",
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ }
+ },
+ "required": [
+ "events"
+ ]
+ },
+ "eql.search.ResultPosition": {
+ "type": "string",
+ "enum": [
+ "tail",
+ "head"
+ ]
+ },
+ "esql.list_queries.Body": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "number"
+ },
+ "node": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.NodeId"
+ }
+ ]
+ },
+ "start_time_millis": {
+ "type": "number"
+ },
+ "running_time_nanos": {
+ "type": "number"
+ },
+ "query": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "node",
+ "start_time_millis",
+ "running_time_nanos",
+ "query"
+ ]
+ },
+ "esql._types.EsqlFormat": {
+ "type": "string",
+ "enum": [
+ "csv",
+ "json",
+ "tsv",
+ "txt",
+ "yaml",
+ "cbor",
+ "smile",
+ "arrow"
+ ]
+ },
+ "esql._types.TableValuesContainer": {
+ "type": "object",
+ "properties": {
+ "integer": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/esql._types.TableValuesIntegerValue"
+ }
+ },
+ "keyword": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/esql._types.TableValuesKeywordValue"
+ }
+ },
+ "long": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/esql._types.TableValuesLongValue"
+ }
+ },
+ "double": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/esql._types.TableValuesLongDouble"
+ }
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "esql._types.TableValuesIntegerValue": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ ]
+ },
+ "esql._types.TableValuesKeywordValue": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "esql._types.TableValuesLongValue": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ ]
+ },
+ "esql._types.TableValuesLongDouble": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ ]
+ },
+ "esql._types.EsqlResult": {
+ "type": "object",
+ "properties": {
+ "took": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitMillis"
+ }
+ ]
+ },
+ "is_partial": {
+ "type": "boolean"
+ },
+ "all_columns": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/esql._types.EsqlColumnInfo"
+ }
+ },
+ "columns": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/esql._types.EsqlColumnInfo"
+ }
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.FieldValue"
+ }
+ }
+ },
+ "_clusters": {
+ "description": "Cross-cluster search information. Present if `include_ccs_metadata` was `true` in the request\nand a cross-cluster search was performed.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/esql._types.EsqlClusterInfo"
+ }
+ ]
+ },
+ "profile": {
+ "description": "Profiling information. Present if `profile` was `true` in the request.\nThe contents of this field are currently unstable.",
+ "type": "object"
+ }
+ },
+ "required": [
+ "columns",
+ "values"
+ ]
+ },
+ "esql._types.EsqlColumnInfo": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "type"
+ ]
+ },
+ "esql._types.EsqlClusterInfo": {
+ "type": "object",
+ "properties": {
+ "total": {
+ "type": "number"
+ },
+ "successful": {
+ "type": "number"
+ },
+ "running": {
+ "type": "number"
+ },
+ "skipped": {
+ "type": "number"
+ },
+ "partial": {
+ "type": "number"
+ },
+ "failed": {
+ "type": "number"
+ },
+ "details": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/esql._types.EsqlClusterDetails"
+ }
+ }
+ },
+ "required": [
+ "total",
+ "successful",
+ "running",
+ "skipped",
+ "partial",
+ "failed",
+ "details"
+ ]
+ },
+ "esql._types.EsqlClusterDetails": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/esql._types.EsqlClusterStatus"
+ }
+ ]
+ },
+ "indices": {
+ "type": "string"
+ },
+ "took": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitMillis"
+ }
+ ]
+ },
+ "_shards": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/esql._types.EsqlShardInfo"
+ }
+ ]
+ },
+ "failures": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/esql._types.EsqlShardFailure"
+ }
+ }
+ },
+ "required": [
+ "status",
+ "indices"
+ ]
+ },
+ "esql._types.EsqlClusterStatus": {
+ "type": "string",
+ "enum": [
+ "running",
+ "successful",
+ "partial",
+ "skipped",
+ "failed"
+ ]
+ },
+ "esql._types.EsqlShardInfo": {
+ "type": "object",
+ "properties": {
+ "total": {
+ "type": "number"
+ },
+ "successful": {
+ "type": "number"
+ },
+ "skipped": {
+ "type": "number"
+ },
+ "failed": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "total"
+ ]
+ },
+ "esql._types.EsqlShardFailure": {
+ "type": "object",
+ "properties": {
+ "shard": {
+ "type": "number"
+ },
+ "index": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "node": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.NodeId"
+ }
+ ]
+ },
+ "reason": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ErrorCause"
+ }
+ ]
+ }
+ },
+ "required": [
+ "shard",
+ "index",
+ "reason"
+ ]
+ },
+ "_types.InlineGet": {
+ "type": "object",
+ "properties": {
+ "fields": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "found": {
+ "type": "boolean"
+ },
+ "_seq_no": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SequenceNumber"
+ }
+ ]
+ },
+ "_primary_term": {
+ "type": "number"
+ },
+ "_routing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Routing"
+ }
+ ]
+ },
+ "_source": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "found"
+ ]
+ },
+ "_global.field_caps.FieldCapability": {
+ "type": "object",
+ "properties": {
+ "aggregatable": {
+ "description": "Whether this field can be aggregated on all indices.",
+ "type": "boolean"
+ },
+ "indices": {
+ "description": "The list of indices where this field has the same type family, or null if all indices have the same type family for the field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Indices"
+ }
+ ]
+ },
+ "meta": {
+ "description": "Merged metadata across all indices as a map of string keys to arrays of values. A value length of 1 indicates that all indices had the same value for this key, while a length of 2 or more indicates that not all indices had the same value for this key.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ },
+ "non_aggregatable_indices": {
+ "description": "The list of indices where this field is not aggregatable, or null if all indices have the same definition for the field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Indices"
+ }
+ ]
+ },
+ "non_searchable_indices": {
+ "description": "The list of indices where this field is not searchable, or null if all indices have the same definition for the field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Indices"
+ }
+ ]
+ },
+ "searchable": {
+ "description": "Whether this field is indexed for search on all indices.",
+ "type": "boolean"
+ },
+ "type": {
+ "type": "string"
+ },
+ "metadata_field": {
+ "description": "Whether this field is registered as a metadata field.",
+ "type": "boolean"
+ },
+ "time_series_dimension": {
+ "description": "Whether this field is used as a time series dimension.",
+ "x-state": "Technical preview",
+ "type": "boolean"
+ },
+ "time_series_metric": {
+ "description": "Contains metric type if this fields is used as a time series\nmetrics, absent if the field is not used as metric.",
+ "x-state": "Technical preview",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.TimeSeriesMetricType"
+ }
+ ]
+ },
+ "non_dimension_indices": {
+ "description": "If this list is present in response then some indices have the\nfield marked as a dimension and other indices, the ones in this list, do not.",
+ "x-state": "Technical preview",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ },
+ "metric_conflicts_indices": {
+ "description": "The list of indices where this field is present if these indices\ndon’t have the same `time_series_metric` value for this field.",
+ "x-state": "Technical preview",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ }
+ },
+ "required": [
+ "aggregatable",
+ "searchable",
+ "type"
+ ]
+ },
+ "_global.get.GetResult": {
+ "type": "object",
+ "properties": {
+ "_index": {
+ "description": "The name of the index the document belongs to.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "fields": {
+ "description": "If the `stored_fields` parameter is set to `true` and `found` is `true`, it contains the document fields stored in the index.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "_ignored": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "found": {
+ "description": "Indicates whether the document exists.",
+ "type": "boolean"
+ },
+ "_id": {
+ "description": "The unique identifier for the document.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "_primary_term": {
+ "description": "The primary term assigned to the document for the indexing operation.",
+ "type": "number"
+ },
+ "_routing": {
+ "description": "The explicit routing, if set.",
+ "type": "string"
+ },
+ "_seq_no": {
+ "description": "The sequence number assigned to the document for the indexing operation.\nSequence numbers are used to ensure an older version of a document doesn't overwrite a newer version.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SequenceNumber"
+ }
+ ]
+ },
+ "_source": {
+ "description": "If `found` is `true`, it contains the document data formatted in JSON.\nIf the `_source` parameter is set to `false` or the `stored_fields` parameter is set to `true`, it is excluded.",
+ "type": "object"
+ },
+ "_version": {
+ "description": "The document version, which is ncremented each time the document is updated.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ }
+ ]
+ }
+ },
+ "required": [
+ "_index",
+ "found",
+ "_id"
+ ]
+ },
+ "_types.StoredScript": {
+ "type": "object",
+ "properties": {
+ "lang": {
+ "description": "The language the script is written in.\nFor search templates, use `mustache`.\n\nSupported values include:\n - `painless`: Painless scripting language, purpose-built for Elasticsearch.\n - `expression`: Lucene’s expressions language, compiles a JavaScript expression to bytecode.\n - `mustache`: Mustache templated, used for templates.\n - `java`: Expert Java API\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScriptLanguage"
+ }
+ ]
+ },
+ "options": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "source": {
+ "description": "The script source.\nFor search templates, an object containing the search template.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScriptSource"
+ }
+ ]
+ }
+ },
+ "required": [
+ "lang",
+ "source"
+ ]
+ },
+ "graph._types.Hop": {
+ "type": "object",
+ "properties": {
+ "connections": {
+ "description": "Specifies one or more fields from which you want to extract terms that are associated with the specified vertices.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/graph._types.Hop"
+ }
+ ]
+ },
+ "query": {
+ "description": "An optional guiding query that constrains the Graph API as it explores connected terms.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "vertices": {
+ "description": "Contains the fields you are interested in.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/graph._types.VertexDefinition"
+ }
+ }
+ },
+ "required": [
+ "vertices"
+ ]
+ },
+ "graph._types.VertexDefinition": {
+ "type": "object",
+ "properties": {
+ "exclude": {
+ "description": "Prevents the specified terms from being included in the results.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "field": {
+ "description": "Identifies a field in the documents of interest.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "include": {
+ "description": "Identifies the terms of interest that form the starting points from which you want to spider out.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/graph._types.VertexInclude"
+ }
+ },
+ "min_doc_count": {
+ "description": "Specifies how many documents must contain a pair of terms before it is considered to be a useful connection.\nThis setting acts as a certainty threshold.",
+ "default": 3.0,
+ "type": "number"
+ },
+ "shard_min_doc_count": {
+ "description": "Controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration.",
+ "default": 2.0,
+ "type": "number"
+ },
+ "size": {
+ "description": "Specifies the maximum number of vertex terms returned for each field.",
+ "default": 5.0,
+ "type": "number"
+ }
+ },
+ "required": [
+ "field"
+ ]
+ },
+ "graph._types.VertexInclude": {
+ "type": "object",
+ "properties": {
+ "boost": {
+ "type": "number"
+ },
+ "term": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "term"
+ ]
+ },
+ "graph._types.ExploreControls": {
+ "type": "object",
+ "properties": {
+ "sample_diversity": {
+ "description": "To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample.\nYou can do this by selecting a single-value field and setting a maximum number of documents per value for that field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/graph._types.SampleDiversity"
+ }
+ ]
+ },
+ "sample_size": {
+ "description": "Each hop considers a sample of the best-matching documents on each shard.\nUsing samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms.\nVery small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms.\nVery large sample sizes can dilute the quality of the results and increase execution times.",
+ "default": 100.0,
+ "type": "number"
+ },
+ "timeout": {
+ "description": "The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned.\nThis timeout is honored on a best-effort basis.\nExecution might overrun this timeout if, for example, a long pause is encountered while FieldData is loaded for a field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "use_significance": {
+ "description": "Filters associated terms so only those that are significantly associated with your query are included.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "use_significance"
+ ]
+ },
+ "graph._types.SampleDiversity": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "max_docs_per_value": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "field",
+ "max_docs_per_value"
+ ]
+ },
+ "graph._types.Connection": {
+ "type": "object",
+ "properties": {
+ "doc_count": {
+ "type": "number"
+ },
+ "source": {
+ "type": "number"
+ },
+ "target": {
+ "type": "number"
+ },
+ "weight": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "doc_count",
+ "source",
+ "target",
+ "weight"
+ ]
+ },
+ "graph._types.Vertex": {
+ "type": "object",
+ "properties": {
+ "depth": {
+ "type": "number"
+ },
+ "field": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "term": {
+ "type": "string"
+ },
+ "weight": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "depth",
+ "field",
+ "term",
+ "weight"
+ ]
+ },
+ "_types.OpType": {
+ "type": "string",
+ "enum": [
+ "index",
+ "create"
+ ]
+ },
+ "indices._types.IndicesBlockOptions": {
+ "type": "string",
+ "enum": [
+ "metadata",
+ "read",
+ "read_only",
+ "write"
+ ]
+ },
+ "indices.add_block.AddIndicesBlockStatus": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "blocked": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "name",
+ "blocked"
+ ]
+ },
+ "indices.analyze.TextToAnalyze": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "indices.analyze.AnalyzeDetail": {
+ "type": "object",
+ "properties": {
+ "analyzer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices.analyze.AnalyzerDetail"
+ }
+ ]
+ },
+ "charfilters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/indices.analyze.CharFilterDetail"
+ }
+ },
+ "custom_analyzer": {
+ "type": "boolean"
+ },
+ "tokenfilters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/indices.analyze.TokenDetail"
+ }
+ },
+ "tokenizer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices.analyze.TokenDetail"
+ }
+ ]
+ }
+ },
+ "required": [
+ "custom_analyzer"
+ ]
+ },
+ "indices.analyze.AnalyzerDetail": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "tokens": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/indices.analyze.ExplainAnalyzeToken"
+ }
+ }
+ },
+ "required": [
+ "name",
+ "tokens"
+ ]
+ },
+ "indices.analyze.ExplainAnalyzeToken": {
+ "type": "object",
+ "properties": {
+ "bytes": {
+ "type": "string"
+ },
+ "end_offset": {
+ "type": "number"
+ },
+ "keyword": {
+ "type": "boolean"
+ },
+ "position": {
+ "type": "number"
+ },
+ "positionLength": {
+ "type": "number"
+ },
+ "start_offset": {
+ "type": "number"
+ },
+ "termFrequency": {
+ "type": "number"
+ },
+ "token": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "bytes",
+ "end_offset",
+ "position",
+ "positionLength",
+ "start_offset",
+ "termFrequency",
+ "token",
+ "type"
+ ]
+ },
+ "indices.analyze.CharFilterDetail": {
+ "type": "object",
+ "properties": {
+ "filtered_text": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "filtered_text",
+ "name"
+ ]
+ },
+ "indices.analyze.TokenDetail": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "tokens": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/indices.analyze.ExplainAnalyzeToken"
+ }
+ }
+ },
+ "required": [
+ "name",
+ "tokens"
+ ]
+ },
+ "indices.analyze.AnalyzeToken": {
+ "type": "object",
+ "properties": {
+ "end_offset": {
+ "type": "number"
+ },
+ "position": {
+ "type": "number"
+ },
+ "positionLength": {
+ "type": "number"
+ },
+ "start_offset": {
+ "type": "number"
+ },
+ "token": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "end_offset",
+ "position",
+ "start_offset",
+ "token",
+ "type"
+ ]
+ },
+ "_types.IndicesResponseBase": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "_shards": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ShardStatistics"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "indices.delete_alias.IndicesAliasesResponseBody": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "errors": {
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "_types.DataStreamNames": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.DataStreamName"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.DataStreamName"
+ }
+ }
+ ]
+ },
+ "indices.explain_data_lifecycle.DataStreamLifecycleExplain": {
+ "type": "object",
+ "properties": {
+ "index": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "managed_by_lifecycle": {
+ "type": "boolean"
+ },
+ "index_creation_date_millis": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "time_since_index_creation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "rollover_date_millis": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "time_since_rollover": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "lifecycle": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover"
+ }
+ ]
+ },
+ "generation_time": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "error": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "index",
+ "managed_by_lifecycle"
+ ]
+ },
+ "indices.get.Features": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/indices.get.Feature"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/indices.get.Feature"
+ }
+ }
+ ]
+ },
+ "indices.get.Feature": {
+ "type": "string",
+ "enum": [
+ "aliases",
+ "mappings",
+ "settings"
+ ]
+ },
+ "indices.get_alias._types.IndexAliases": {
+ "type": "object",
+ "properties": {
+ "aliases": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/indices._types.AliasDefinition"
+ }
+ }
+ },
+ "required": [
+ "aliases"
+ ]
+ },
+ "indices.get_data_lifecycle.DataStreamWithLifecycle": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DataStreamName"
+ }
+ ]
+ },
+ "lifecycle": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover"
+ }
+ ]
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "indices._types.DataStream": {
+ "type": "object",
+ "properties": {
+ "_meta": {
+ "description": "Custom metadata for the stream, copied from the `_meta` object of the stream’s matching index template.\nIf empty, the response omits this property.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ },
+ "allow_custom_routing": {
+ "description": "If `true`, the data stream allows custom routing on write request.",
+ "type": "boolean"
+ },
+ "failure_store": {
+ "description": "Information about failure store backing indices",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.FailureStore"
+ }
+ ]
+ },
+ "generation": {
+ "description": "Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1.",
+ "type": "number"
+ },
+ "hidden": {
+ "description": "If `true`, the data stream is hidden.",
+ "type": "boolean"
+ },
+ "ilm_policy": {
+ "description": "Name of the current ILM lifecycle policy in the stream’s matching index template.\nThis lifecycle policy is set in the `index.lifecycle.name` setting.\nIf the template does not include a lifecycle policy, this property is not included in the response.\nNOTE: A data stream’s backing indices may be assigned different lifecycle policies. To retrieve the lifecycle policy for individual backing indices, use the get index settings API.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "next_generation_managed_by": {
+ "description": "Name of the lifecycle system that'll manage the next generation of the data stream.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.ManagedBy"
+ }
+ ]
+ },
+ "prefer_ilm": {
+ "description": "Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream.",
+ "type": "boolean"
+ },
+ "indices": {
+ "description": "Array of objects containing information about the data stream’s backing indices.\nThe last item in this array contains information about the stream’s current write index.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/indices._types.DataStreamIndex"
+ }
+ },
+ "lifecycle": {
+ "description": "Contains the configuration for the data stream lifecycle of this data stream.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover"
+ }
+ ]
+ },
+ "name": {
+ "description": "Name of the data stream.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DataStreamName"
+ }
+ ]
+ },
+ "replicated": {
+ "description": "If `true`, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings.",
+ "type": "boolean"
+ },
+ "rollover_on_write": {
+ "description": "If `true`, the next write to this data stream will trigger a rollover first and the document will be indexed in the new backing index. If the rollover fails the indexing request will fail too.",
+ "type": "boolean"
+ },
+ "settings": {
+ "description": "The settings specific to this data stream that will take precedence over the settings in the matching index\ntemplate.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexSettings"
+ }
+ ]
+ },
+ "mappings": {
+ "description": "The mappings specific to this data stream that will take precedence over the mappings in the matching index\ntemplate.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.TypeMapping"
+ }
+ ]
+ },
+ "status": {
+ "description": "Health status of the data stream.\nThis health status is based on the state of the primary and replica shards of the stream’s backing indices.\n\nSupported values include:\n - `green` (or `GREEN`): All shards are assigned.\n - `yellow` (or `YELLOW`): All primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data could be unavailable until that node is repaired.\n - `red` (or `RED`): One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned.\n - `unknown`\n - `unavailable`\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.HealthStatus"
+ }
+ ]
+ },
+ "system": {
+ "description": "If `true`, the data stream is created and managed by an Elastic stack component and cannot be modified through normal user interaction.",
+ "x-state": "Generally available",
+ "type": "boolean"
+ },
+ "template": {
+ "description": "Name of the index template used to create the data stream’s backing indices.\nThe template’s index pattern must match the name of this data stream.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "timestamp_field": {
+ "description": "Information about the `@timestamp` field in the data stream.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.DataStreamTimestampField"
+ }
+ ]
+ },
+ "index_mode": {
+ "description": "The index mode for the data stream that will be used for newly created backing indices.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexMode"
+ }
+ ]
+ }
+ },
+ "required": [
+ "generation",
+ "hidden",
+ "next_generation_managed_by",
+ "prefer_ilm",
+ "indices",
+ "name",
+ "rollover_on_write",
+ "settings",
+ "status",
+ "template",
+ "timestamp_field"
+ ]
+ },
+ "indices._types.FailureStore": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "indices": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/indices._types.DataStreamIndex"
+ }
+ },
+ "rollover_on_write": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "enabled",
+ "indices",
+ "rollover_on_write"
+ ]
+ },
+ "indices._types.DataStreamIndex": {
+ "type": "object",
+ "properties": {
+ "index_name": {
+ "description": "Name of the backing index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "index_uuid": {
+ "description": "Universally unique identifier (UUID) for the index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Uuid"
+ }
+ ]
+ },
+ "ilm_policy": {
+ "description": "Name of the current ILM lifecycle policy configured for this backing index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "managed_by": {
+ "description": "Name of the lifecycle system that's currently managing this backing index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.ManagedBy"
+ }
+ ]
+ },
+ "prefer_ilm": {
+ "description": "Indicates if ILM should take precedence over DSL in case both are configured to manage this index.",
+ "type": "boolean"
+ },
+ "index_mode": {
+ "description": "The index mode of this backing index of the data stream.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexMode"
+ }
+ ]
+ }
+ },
+ "required": [
+ "index_name",
+ "index_uuid"
+ ]
+ },
+ "indices._types.ManagedBy": {
+ "type": "string",
+ "enum": [
+ "Index Lifecycle Management",
+ "Data stream lifecycle",
+ "Unmanaged"
+ ]
+ },
+ "indices._types.IndexMode": {
+ "type": "string",
+ "enum": [
+ "standard",
+ "time_series",
+ "logsdb",
+ "lookup"
+ ]
+ },
+ "indices._types.DataStreamTimestampField": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the timestamp field for the data stream, which must be `@timestamp`. The `@timestamp` field must be included in every document indexed to the data stream.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "indices.get_data_stream_mappings.DataStreamMappings": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the data stream.",
+ "type": "string"
+ },
+ "mappings": {
+ "description": "The settings specific to this data stream",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.TypeMapping"
+ }
+ ]
+ },
+ "effective_mappings": {
+ "description": "The settings specific to this data stream merged with the settings from its template. These `effective_settings`\nare the settings that will be used when a new index is created for this data stream.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.TypeMapping"
+ }
+ ]
+ }
+ },
+ "required": [
+ "name",
+ "mappings",
+ "effective_mappings"
+ ]
+ },
+ "indices.get_data_stream_options.DataStreamWithOptions": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DataStreamName"
+ }
+ ]
+ },
+ "options": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.DataStreamOptions"
+ }
+ ]
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "indices._types.DataStreamOptions": {
+ "description": "Data stream options contain the configuration of data stream level features for a given data stream, for example,\nthe failure store configuration.",
+ "type": "object",
+ "properties": {
+ "failure_store": {
+ "description": "If defined, it specifies configuration for the failure store of this data stream.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.DataStreamFailureStore"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.DataStreamFailureStore": {
+ "description": "Data stream failure store contains the configuration of the failure store for a given data stream.",
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "description": "If defined, it turns the failure store on/off (`true`/`false`) for this data stream. A data stream failure store\nthat's disabled (enabled: `false`) will redirect no new failed indices to the failure store; however, it will\nnot remove any existing data from the failure store.",
+ "default": true,
+ "type": "boolean"
+ },
+ "lifecycle": {
+ "description": "If defined, it specifies the lifecycle configuration for the failure store of this data stream.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.FailureStoreLifecycle"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.FailureStoreLifecycle": {
+ "description": "The failure store lifecycle configures the data stream lifecycle configuration for failure indices.",
+ "type": "object",
+ "properties": {
+ "data_retention": {
+ "description": "If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "enabled": {
+ "description": "If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream.",
+ "default": true,
+ "type": "boolean"
+ }
+ }
+ },
+ "indices.get_data_stream_settings.DataStreamSettings": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the data stream.",
+ "type": "string"
+ },
+ "settings": {
+ "description": "The settings specific to this data stream",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexSettings"
+ }
+ ]
+ },
+ "effective_settings": {
+ "description": "The settings specific to this data stream merged with the settings from its template. These `effective_settings`\nare the settings that will be used when a new index is created for this data stream.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexSettings"
+ }
+ ]
+ }
+ },
+ "required": [
+ "name",
+ "settings",
+ "effective_settings"
+ ]
+ },
+ "indices.get_index_template.IndexTemplateItem": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "index_template": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexTemplate"
+ }
+ ]
+ }
+ },
+ "required": [
+ "name",
+ "index_template"
+ ]
+ },
+ "indices._types.IndexTemplate": {
+ "type": "object",
+ "properties": {
+ "index_patterns": {
+ "description": "Name of the index template.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Names"
+ }
+ ]
+ },
+ "composed_of": {
+ "description": "An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ },
+ "template": {
+ "description": "Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexTemplateSummary"
+ }
+ ]
+ },
+ "version": {
+ "description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ }
+ ]
+ },
+ "priority": {
+ "description": "Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.",
+ "type": "number"
+ },
+ "_meta": {
+ "description": "Optional user metadata about the index template. May have any contents.\nThis map is not automatically generated by Elasticsearch.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ },
+ "allow_auto_create": {
+ "type": "boolean"
+ },
+ "data_stream": {
+ "description": "If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexTemplateDataStreamConfiguration"
+ }
+ ]
+ },
+ "deprecated": {
+ "description": "Marks this index template as deprecated.\nWhen creating or updating a non-deprecated index template that uses deprecated components,\nElasticsearch will emit a deprecation warning.",
+ "x-state": "Generally available",
+ "type": "boolean"
+ },
+ "ignore_missing_component_templates": {
+ "description": "A list of component template names that are allowed to be absent.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Names"
+ }
+ ]
+ },
+ "created_date": {
+ "description": "Date and time when the index template was created. Only returned if the `human` query parameter is `true`.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "created_date_millis": {
+ "description": "Date and time when the index template was created, in milliseconds since the epoch.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "modified_date": {
+ "description": "Date and time when the index template was last modified. Only returned if the `human` query parameter is `true`.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "modified_date_millis": {
+ "description": "Date and time when the index template was last modified, in milliseconds since the epoch.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ }
+ },
+ "required": [
+ "index_patterns",
+ "composed_of"
+ ]
+ },
+ "indices._types.IndexTemplateSummary": {
+ "type": "object",
+ "properties": {
+ "aliases": {
+ "description": "Aliases to add.\nIf the index template includes a `data_stream` object, these are data stream aliases.\nOtherwise, these are index aliases.\nData stream aliases ignore the `index_routing`, `routing`, and `search_routing` options.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/indices._types.Alias"
+ }
+ },
+ "mappings": {
+ "description": "Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping parameters.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.TypeMapping"
+ }
+ ]
+ },
+ "settings": {
+ "description": "Configuration options for the index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexSettings"
+ }
+ ]
+ },
+ "lifecycle": {
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover"
+ }
+ ]
+ },
+ "data_stream_options": {
+ "x-state": "Generally available",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.DataStreamOptionsTemplate"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.IndexTemplateDataStreamConfiguration": {
+ "type": "object",
+ "properties": {
+ "hidden": {
+ "description": "If true, the data stream is hidden.",
+ "default": false,
+ "type": "boolean"
+ },
+ "allow_custom_routing": {
+ "description": "If true, the data stream supports custom routing.",
+ "default": false,
+ "type": "boolean"
+ }
+ }
+ },
+ "indices.get_mapping.IndexMappingRecord": {
+ "type": "object",
+ "properties": {
+ "item": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.TypeMapping"
+ }
+ ]
+ },
+ "mappings": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.TypeMapping"
+ }
+ ]
+ }
+ },
+ "required": [
+ "mappings"
+ ]
+ },
+ "indices.modify_data_stream.Action": {
+ "type": "object",
+ "properties": {
+ "add_backing_index": {
+ "description": "Adds an existing index as a backing index for a data stream.\nThe index is hidden as part of this operation.\nWARNING: Adding indices with the `add_backing_index` action can potentially result in improper data stream behavior.\nThis should be considered an expert level API.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices.modify_data_stream.IndexAndDataStreamAction"
+ }
+ ]
+ },
+ "remove_backing_index": {
+ "description": "Removes a backing index from a data stream.\nThe index is unhidden as part of this operation.\nA data stream’s write index cannot be removed.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices.modify_data_stream.IndexAndDataStreamAction"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "indices.modify_data_stream.IndexAndDataStreamAction": {
+ "type": "object",
+ "properties": {
+ "data_stream": {
+ "description": "Data stream targeted by the action.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DataStreamName"
+ }
+ ]
+ },
+ "index": {
+ "description": "Index for the action.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ }
+ },
+ "required": [
+ "data_stream",
+ "index"
+ ]
+ },
+ "indices.put_data_stream_mappings.UpdatedDataStreamMappings": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The data stream name.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "applied_to_data_stream": {
+ "description": "If the mappings were successfully applied to the data stream (or would have been, if running in `dry_run`\nmode), it is `true`. If an error occurred, it is `false`.",
+ "type": "boolean"
+ },
+ "error": {
+ "description": "A message explaining why the mappings could not be applied to the data stream.",
+ "type": "string"
+ },
+ "mappings": {
+ "description": "The mappings that are specfic to this data stream that will override any mappings from the matching index template.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.TypeMapping"
+ }
+ ]
+ },
+ "effective_mappings": {
+ "description": "The mappings that are effective on this data stream, taking into account the mappings from the matching index\ntemplate and the mappings specific to this data stream.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.TypeMapping"
+ }
+ ]
+ }
+ },
+ "required": [
+ "name",
+ "applied_to_data_stream"
+ ]
+ },
+ "indices.put_data_stream_settings.UpdatedDataStreamSettings": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The data stream name.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "applied_to_data_stream": {
+ "description": "If the settings were successfully applied to the data stream (or would have been, if running in `dry_run`\nmode), it is `true`. If an error occurred, it is `false`.",
+ "type": "boolean"
+ },
+ "error": {
+ "description": "A message explaining why the settings could not be applied to the data stream.",
+ "type": "string"
+ },
+ "settings": {
+ "description": "The settings that are specfic to this data stream that will override any settings from the matching index template.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexSettings"
+ }
+ ]
+ },
+ "effective_settings": {
+ "description": "The settings that are effective on this data stream, taking into account the settings from the matching index\ntemplate and the settings specific to this data stream.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexSettings"
+ }
+ ]
+ },
+ "index_settings_results": {
+ "description": "Information about whether and where each setting was applied.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices.put_data_stream_settings.IndexSettingResults"
+ }
+ ]
+ }
+ },
+ "required": [
+ "name",
+ "applied_to_data_stream",
+ "settings",
+ "effective_settings",
+ "index_settings_results"
+ ]
+ },
+ "indices.put_data_stream_settings.IndexSettingResults": {
+ "type": "object",
+ "properties": {
+ "applied_to_data_stream_only": {
+ "description": "The list of settings that were applied to the data stream but not to backing indices. These will be applied to\nthe write index the next time the data stream is rolled over.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "applied_to_data_stream_and_backing_indices": {
+ "description": "The list of settings that were applied to the data stream and to all of its backing indices. These settings will\nalso be applied to the write index the next time the data stream is rolled over.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/indices.put_data_stream_settings.DataStreamSettingsError"
+ }
+ }
+ },
+ "required": [
+ "applied_to_data_stream_only",
+ "applied_to_data_stream_and_backing_indices"
+ ]
+ },
+ "indices.put_data_stream_settings.DataStreamSettingsError": {
+ "type": "object",
+ "properties": {
+ "index": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "error": {
+ "description": "A message explaining why the settings could not be applied to specific indices.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "index",
+ "error"
+ ]
+ },
+ "indices.put_index_template.IndexTemplateMapping": {
+ "type": "object",
+ "properties": {
+ "aliases": {
+ "description": "Aliases to add.\nIf the index template includes a `data_stream` object, these are data stream aliases.\nOtherwise, these are index aliases.\nData stream aliases ignore the `index_routing`, `routing`, and `search_routing` options.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/indices._types.Alias"
+ }
+ },
+ "mappings": {
+ "description": "Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping parameters.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.TypeMapping"
+ }
+ ]
+ },
+ "settings": {
+ "description": "Configuration options for the index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexSettings"
+ }
+ ]
+ },
+ "lifecycle": {
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.DataStreamLifecycle"
+ }
+ ]
+ }
+ }
+ },
+ "indices._types.DataStreamVisibility": {
+ "type": "object",
+ "properties": {
+ "hidden": {
+ "type": "boolean"
+ },
+ "allow_custom_routing": {
+ "type": "boolean"
+ }
+ }
+ },
+ "_types.ShardsOperationResponseBase": {
+ "type": "object",
+ "properties": {
+ "_shards": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ShardStatistics"
+ }
+ ]
+ }
+ }
+ },
+ "indices.remove_block.RemoveIndicesBlockStatus": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "unblocked": {
+ "type": "boolean"
+ },
+ "exception": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ErrorCause"
+ }
+ ]
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "indices.resolve_index.ResolveIndexItem": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "aliases": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "attributes": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "data_stream": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DataStreamName"
+ }
+ ]
+ },
+ "mode": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexMode"
+ }
+ ]
+ }
+ },
+ "required": [
+ "name",
+ "attributes"
+ ]
+ },
+ "indices.resolve_index.ResolveIndexAliasItem": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "indices": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Indices"
+ }
+ ]
+ }
+ },
+ "required": [
+ "name",
+ "indices"
+ ]
+ },
+ "indices.resolve_index.ResolveIndexDataStreamsItem": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DataStreamName"
+ }
+ ]
+ },
+ "timestamp_field": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "backing_indices": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Indices"
+ }
+ ]
+ }
+ },
+ "required": [
+ "name",
+ "timestamp_field",
+ "backing_indices"
+ ]
+ },
+ "_types.IndexAlias": {
+ "type": "string"
+ },
+ "indices.rollover.RolloverConditions": {
+ "type": "object",
+ "properties": {
+ "min_age": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "max_age": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "max_age_millis": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitMillis"
+ }
+ ]
+ },
+ "min_docs": {
+ "type": "number"
+ },
+ "max_docs": {
+ "type": "number"
+ },
+ "max_size": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "max_size_bytes": {
+ "type": "number"
+ },
+ "min_size": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "min_size_bytes": {
+ "type": "number"
+ },
+ "max_primary_shard_size": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "max_primary_shard_size_bytes": {
+ "type": "number"
+ },
+ "min_primary_shard_size": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "min_primary_shard_size_bytes": {
+ "type": "number"
+ },
+ "max_primary_shard_docs": {
+ "type": "number"
+ },
+ "min_primary_shard_docs": {
+ "type": "number"
+ }
+ }
+ },
+ "indices.simulate_template.Overlapping": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "index_patterns": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "name",
+ "index_patterns"
+ ]
+ },
+ "indices.simulate_template.Template": {
+ "type": "object",
+ "properties": {
+ "aliases": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/indices._types.Alias"
+ }
+ },
+ "mappings": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.TypeMapping"
+ }
+ ]
+ },
+ "settings": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexSettings"
+ }
+ ]
+ }
+ },
+ "required": [
+ "aliases",
+ "mappings",
+ "settings"
+ ]
+ },
+ "indices.update_aliases.Action": {
+ "type": "object",
+ "properties": {
+ "add": {
+ "description": "Adds a data stream or index to an alias.\nIf the alias doesn’t exist, the `add` action creates it.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices.update_aliases.AddAction"
+ }
+ ]
+ },
+ "remove": {
+ "description": "Removes a data stream or index from an alias.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices.update_aliases.RemoveAction"
+ }
+ ]
+ },
+ "remove_index": {
+ "description": "Deletes an index.\nYou cannot use this action on aliases or data streams.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices.update_aliases.RemoveIndexAction"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "indices.update_aliases.AddAction": {
+ "type": "object",
+ "properties": {
+ "alias": {
+ "description": "Alias for the action.\nIndex alias names support date math.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexAlias"
+ }
+ ]
+ },
+ "aliases": {
+ "description": "Aliases for the action.\nIndex alias names support date math.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexAlias"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.IndexAlias"
+ }
+ }
+ ]
+ },
+ "filter": {
+ "description": "Query used to limit documents the alias can access.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "index": {
+ "description": "Data stream or index for the action.\nSupports wildcards (`*`).",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "indices": {
+ "description": "Data streams or indices for the action.\nSupports wildcards (`*`).",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Indices"
+ }
+ ]
+ },
+ "index_routing": {
+ "description": "Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.\nData stream aliases don’t support this parameter.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Routing"
+ }
+ ]
+ },
+ "is_hidden": {
+ "description": "If `true`, the alias is hidden.",
+ "default": false,
+ "type": "boolean"
+ },
+ "is_write_index": {
+ "description": "If `true`, sets the write index or data stream for the alias.",
+ "type": "boolean"
+ },
+ "routing": {
+ "description": "Value used to route indexing and search operations to a specific shard.\nData stream aliases don’t support this parameter.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Routing"
+ }
+ ]
+ },
+ "search_routing": {
+ "description": "Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.\nData stream aliases don’t support this parameter.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Routing"
+ }
+ ]
+ },
+ "must_exist": {
+ "description": "If `true`, the alias must exist to perform the action.",
+ "default": false,
+ "type": "boolean"
+ }
+ }
+ },
+ "indices.update_aliases.RemoveAction": {
+ "type": "object",
+ "properties": {
+ "alias": {
+ "description": "Alias for the action.\nIndex alias names support date math.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexAlias"
+ }
+ ]
+ },
+ "aliases": {
+ "description": "Aliases for the action.\nIndex alias names support date math.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexAlias"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.IndexAlias"
+ }
+ }
+ ]
+ },
+ "index": {
+ "description": "Data stream or index for the action.\nSupports wildcards (`*`).",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "indices": {
+ "description": "Data streams or indices for the action.\nSupports wildcards (`*`).",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Indices"
+ }
+ ]
+ },
+ "must_exist": {
+ "description": "If `true`, the alias must exist to perform the action.",
+ "default": false,
+ "type": "boolean"
+ }
+ }
+ },
+ "indices.update_aliases.RemoveIndexAction": {
+ "type": "object",
+ "properties": {
+ "index": {
+ "description": "Data stream or index for the action.\nSupports wildcards (`*`).",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "indices": {
+ "description": "Data streams or indices for the action.\nSupports wildcards (`*`).",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Indices"
+ }
+ ]
+ },
+ "must_exist": {
+ "description": "If `true`, the alias must exist to perform the action.",
+ "default": false,
+ "type": "boolean"
+ }
+ }
+ },
+ "indices.validate_query.IndicesValidationExplanation": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "string"
+ },
+ "explanation": {
+ "type": "string"
+ },
+ "index": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "valid": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "index",
+ "valid"
+ ]
+ },
+ "inference._types.RequestChatCompletion": {
+ "type": "object",
+ "properties": {
+ "messages": {
+ "description": "A list of objects representing the conversation.\nRequests should generally only add new messages from the user (role `user`).\nThe other message roles (`assistant`, `system`, or `tool`) should generally only be copied from the response to a previous completion request, such that the messages array is built up throughout a conversation.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/inference._types.Message"
+ }
+ },
+ "model": {
+ "description": "The ID of the model to use.",
+ "type": "string"
+ },
+ "max_completion_tokens": {
+ "description": "The upper bound limit for the number of tokens that can be generated for a completion request.",
+ "type": "number"
+ },
+ "stop": {
+ "description": "A sequence of strings to control when the model should stop generating additional tokens.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "temperature": {
+ "description": "The sampling temperature to use.",
+ "type": "number"
+ },
+ "tool_choice": {
+ "description": "Controls which tool is called by the model.\nString representation: One of `auto`, `none`, or `requrired`. `auto` allows the model to choose between calling tools and generating a message. `none` causes the model to not call any tools. `required` forces the model to call one or more tools.\nExample (object representation):\n```\n{\n \"tool_choice\": {\n \"type\": \"function\",\n \"function\": {\n \"name\": \"get_current_weather\"\n }\n }\n}\n```",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.CompletionToolType"
+ }
+ ]
+ },
+ "tools": {
+ "description": "A list of tools that the model can call.\nExample:\n```\n{\n \"tools\": [\n {\n \"type\": \"function\",\n \"function\": {\n \"name\": \"get_price_of_item\",\n \"description\": \"Get the current price of an item\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"item\": {\n \"id\": \"12345\"\n },\n \"unit\": {\n \"type\": \"currency\"\n }\n }\n }\n }\n }\n ]\n}\n```",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/inference._types.CompletionTool"
+ }
+ },
+ "top_p": {
+ "description": "Nucleus sampling, an alternative to sampling with temperature.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "messages"
+ ]
+ },
+ "inference._types.Message": {
+ "description": "An object representing part of the conversation.",
+ "type": "object",
+ "properties": {
+ "content": {
+ "description": "The content of the message.\n\nString example:\n```\n{\n \"content\": \"Some string\"\n}\n```\n\nObject example:\n```\n{\n \"content\": [\n {\n \"text\": \"Some text\",\n \"type\": \"text\"\n }\n ]\n}\n```",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.MessageContent"
+ }
+ ]
+ },
+ "role": {
+ "description": "The role of the message author. Valid values are `user`, `assistant`, `system`, and `tool`.",
+ "type": "string"
+ },
+ "tool_call_id": {
+ "description": "Only for `tool` role messages. The tool call that this message is responding to.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "tool_calls": {
+ "description": "Only for `assistant` role messages. The tool calls generated by the model. If it's specified, the `content` field is optional.\nExample:\n```\n{\n \"tool_calls\": [\n {\n \"id\": \"call_KcAjWtAww20AihPHphUh46Gd\",\n \"type\": \"function\",\n \"function\": {\n \"name\": \"get_current_weather\",\n \"arguments\": \"{\\\"location\\\":\\\"Boston, MA\\\"}\"\n }\n }\n ]\n}\n```",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/inference._types.ToolCall"
+ }
+ }
+ },
+ "required": [
+ "role"
+ ]
+ },
+ "inference._types.MessageContent": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/inference._types.ContentObject"
+ }
+ }
+ ]
+ },
+ "inference._types.ContentObject": {
+ "description": "An object style representation of a single portion of a conversation.",
+ "type": "object",
+ "properties": {
+ "text": {
+ "description": "The text content.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of content.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "text",
+ "type"
+ ]
+ },
+ "inference._types.ToolCall": {
+ "description": "A tool call generated by the model.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The identifier of the tool call.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "function": {
+ "description": "The function that the model called.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.ToolCallFunction"
+ }
+ ]
+ },
+ "type": {
+ "description": "The type of the tool call.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "function",
+ "type"
+ ]
+ },
+ "inference._types.ToolCallFunction": {
+ "description": "The function that the model called.",
+ "type": "object",
+ "properties": {
+ "arguments": {
+ "description": "The arguments to call the function with in JSON format.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the function to call.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "arguments",
+ "name"
+ ]
+ },
+ "inference._types.CompletionToolType": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/inference._types.CompletionToolChoice"
+ }
+ ]
+ },
+ "inference._types.CompletionToolChoice": {
+ "description": "Controls which tool is called by the model.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The type of the tool.",
+ "type": "string"
+ },
+ "function": {
+ "description": "The tool choice function.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.CompletionToolChoiceFunction"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "function"
+ ]
+ },
+ "inference._types.CompletionToolChoiceFunction": {
+ "description": "The tool choice function.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the function to call.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "inference._types.CompletionTool": {
+ "description": "A list of tools that the model can call.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The type of tool.",
+ "type": "string"
+ },
+ "function": {
+ "description": "The function definition.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.CompletionToolFunction"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "function"
+ ]
+ },
+ "inference._types.CompletionToolFunction": {
+ "description": "The completion tool function definition.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "A description of what the function does.\nThis is used by the model to choose when and how to call the function.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the function.",
+ "type": "string"
+ },
+ "parameters": {
+ "description": "The parameters the functional accepts. This should be formatted as a JSON object.",
+ "type": "object"
+ },
+ "strict": {
+ "description": "Whether to enable schema adherence when generating the function call.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "_types.StreamResult": {
+ "type": "object"
+ },
+ "inference._types.TaskSettings": {
+ "type": "object"
+ },
+ "inference._types.CompletionInferenceResult": {
+ "description": "Defines the completion result.",
+ "type": "object",
+ "properties": {
+ "completion": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/inference._types.CompletionResult"
+ }
+ }
+ },
+ "required": [
+ "completion"
+ ]
+ },
+ "inference._types.CompletionResult": {
+ "description": "The completion result object",
+ "type": "object",
+ "properties": {
+ "result": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "result"
+ ]
+ },
+ "inference._types.TaskType": {
+ "type": "string",
+ "enum": [
+ "sparse_embedding",
+ "text_embedding",
+ "rerank",
+ "completion",
+ "chat_completion"
+ ]
+ },
+ "inference._types.DeleteInferenceEndpointResult": {
+ "description": "Acknowledged response. For dry_run, contains the list of pipelines which reference the inference endpoint",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "pipelines": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "pipelines"
+ ]
+ }
+ ]
+ },
+ "inference._types.InferenceEndpointInfo": {
+ "description": "Represents an inference endpoint as returned by the GET API",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpoint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inference_id": {
+ "description": "The inference Id",
+ "type": "string"
+ },
+ "task_type": {
+ "description": "The task type",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.TaskType"
+ }
+ ]
+ }
+ },
+ "required": [
+ "inference_id",
+ "task_type"
+ ]
+ }
+ ]
+ },
+ "inference._types.InferenceEndpoint": {
+ "description": "Configuration options when storing the inference endpoint",
+ "type": "object",
+ "properties": {
+ "chunking_settings": {
+ "description": "Chunking configuration object",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.InferenceChunkingSettings"
+ }
+ ]
+ },
+ "service": {
+ "description": "The service type",
+ "type": "string"
+ },
+ "service_settings": {
+ "description": "Settings specific to the service",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.ServiceSettings"
+ }
+ ]
+ },
+ "task_settings": {
+ "description": "Task settings specific to the service and task type",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.TaskSettings"
+ }
+ ]
+ }
+ },
+ "required": [
+ "service",
+ "service_settings"
+ ]
+ },
+ "inference._types.InferenceChunkingSettings": {
+ "description": "Chunking configuration object",
+ "type": "object",
+ "properties": {
+ "max_chunk_size": {
+ "description": "The maximum size of a chunk in words.\nThis value cannot be higher than `300` or lower than `20` (for `sentence` strategy) or `10` (for `word` strategy).",
+ "default": 250.0,
+ "type": "number"
+ },
+ "overlap": {
+ "description": "The number of overlapping words for chunks.\nIt is applicable only to a `word` chunking strategy.\nThis value cannot be higher than half the `max_chunk_size` value.",
+ "default": 100.0,
+ "type": "number"
+ },
+ "sentence_overlap": {
+ "description": "The number of overlapping sentences for chunks.\nIt is applicable only for a `sentence` chunking strategy.\nIt can be either `1` or `0`.",
+ "default": 1.0,
+ "type": "number"
+ },
+ "separator_group": {
+ "description": "This parameter is only applicable when using the `recursive` chunking strategy.\n\nSets a predefined list of separators in the saved chunking settings based on the selected text type.\nValues can be `markdown` or `plaintext`.\n\nUsing this parameter is an alternative to manually specifying a custom `separators` list.",
+ "type": "string"
+ },
+ "separators": {
+ "description": "A list of strings used as possible split points when chunking text with the `recursive` strategy.\n\nEach string can be a plain string or a regular expression (regex) pattern.\nThe system tries each separator in order to split the text, starting from the first item in the list.\n\nAfter splitting, it attempts to recombine smaller pieces into larger chunks that stay within\nthe `max_chunk_size` limit, to reduce the total number of chunks generated.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "strategy": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#chunking-strategies"
+ },
+ "description": "The chunking strategy: `sentence`, `word`, `none` or `recursive`.\n\n * If `strategy` is set to `recursive`, you must also specify:\n\n- `max_chunk_size`\n- either `separators` or`separator_group`\n\nLearn more about different chunking strategies in the linked documentation.",
+ "default": "sentence",
+ "type": "string"
+ }
+ },
+ "required": [
+ "separator_group",
+ "separators"
+ ]
+ },
+ "inference._types.ServiceSettings": {
+ "type": "object"
+ },
+ "inference._types.InferenceResult": {
+ "description": "InferenceResult is an aggregation of mutually exclusive variants",
+ "type": "object",
+ "properties": {
+ "text_embedding_bytes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/inference._types.TextEmbeddingByteResult"
+ }
+ },
+ "text_embedding_bits": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/inference._types.TextEmbeddingByteResult"
+ }
+ },
+ "text_embedding": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/inference._types.TextEmbeddingResult"
+ }
+ },
+ "sparse_embedding": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/inference._types.SparseEmbeddingResult"
+ }
+ },
+ "completion": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/inference._types.CompletionResult"
+ }
+ },
+ "rerank": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/inference._types.RankedDocument"
+ }
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "inference._types.TextEmbeddingByteResult": {
+ "description": "The text embedding result object for byte representation",
+ "type": "object",
+ "properties": {
+ "embedding": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.DenseByteVector"
+ }
+ ]
+ }
+ },
+ "required": [
+ "embedding"
+ ]
+ },
+ "inference._types.DenseByteVector": {
+ "description": "Text Embedding results containing bytes are represented as Dense\nVectors of bytes.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.byte"
+ }
+ },
+ "inference._types.TextEmbeddingResult": {
+ "description": "The text embedding result object",
+ "type": "object",
+ "properties": {
+ "embedding": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.DenseVector"
+ }
+ ]
+ }
+ },
+ "required": [
+ "embedding"
+ ]
+ },
+ "inference._types.DenseVector": {
+ "description": "Text Embedding results are represented as Dense Vectors\nof floats.",
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ },
+ "inference._types.SparseEmbeddingResult": {
+ "type": "object",
+ "properties": {
+ "embedding": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.SparseVector"
+ }
+ ]
+ }
+ },
+ "required": [
+ "embedding"
+ ]
+ },
+ "inference._types.SparseVector": {
+ "description": "Sparse Embedding tokens are represented as a dictionary\nof string to double.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "number"
+ }
+ },
+ "inference._types.RankedDocument": {
+ "description": "The rerank result object representing a single ranked document\nid: the original index of the document in the request\nrelevance_score: the relevance_score of the document relative to the query\ntext: Optional, the text of the document, if requested",
+ "type": "object",
+ "properties": {
+ "index": {
+ "type": "number"
+ },
+ "relevance_score": {
+ "type": "number"
+ },
+ "text": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "index",
+ "relevance_score"
+ ]
+ },
+ "inference._types.Ai21TaskType": {
+ "type": "string",
+ "enum": [
+ "completion",
+ "chat_completion"
+ ]
+ },
+ "inference._types.Ai21ServiceType": {
+ "type": "string",
+ "enum": [
+ "ai21"
+ ]
+ },
+ "inference._types.Ai21ServiceSettings": {
+ "type": "object",
+ "properties": {
+ "model_id": {
+ "externalDocs": {
+ "url": "https://docs.ai21.com/docs/jamba-foundation-models"
+ },
+ "description": "The name of the model to use for the inference task.\nRefer to the AI21 models documentation for the list of supported models and versions.\nService has been tested and confirmed to be working for `completion` and `chat_completion` tasks with the following models:\n* `jamba-mini`\n* `jamba-large`",
+ "type": "string"
+ },
+ "api_key": {
+ "description": "A valid API key for accessing AI21 API.\n\nIMPORTANT: You need to provide the API key only once, during the inference model creation.\nThe get inference endpoint API does not retrieve your API key.\nAfter creating the inference model, you cannot change the associated API key.\nIf you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key.",
+ "type": "string"
+ },
+ "rate_limit": {
+ "externalDocs": {
+ "url": "https://docs.ai21.com/reference/api-rate-limits"
+ },
+ "description": "This setting helps to minimize the number of rate limit errors returned from the AI21 API.\nBy default, the `ai21` service sets the number of requests allowed per minute to 200. Please refer to AI21 documentation for more details.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.RateLimitSetting"
+ }
+ ]
+ }
+ },
+ "required": [
+ "model_id"
+ ]
+ },
+ "inference._types.RateLimitSetting": {
+ "description": "This setting helps to minimize the number of rate limit errors returned from the service.",
+ "type": "object",
+ "properties": {
+ "requests_per_minute": {
+ "description": "The number of requests allowed per minute.\nBy default, the number of requests allowed per minute is set by each service as follows:\n\n* `alibabacloud-ai-search` service: `1000`\n* `anthropic` service: `50`\n* `azureaistudio` service: `240`\n* `azureopenai` service and task type `text_embedding`: `1440`\n* `azureopenai` service and task type `completion`: `120`\n* `cohere` service: `10000`\n* `elastic` service and task type `chat_completion`: `240`\n* `googleaistudio` service: `360`\n* `googlevertexai` service: `30000`\n* `hugging_face` service: `3000`\n* `jinaai` service: `2000`\n* `llama` service: `3000`\n* `mistral` service: `240`\n* `openai` service and task type `text_embedding`: `3000`\n* `openai` service and task type `completion`: `500`\n* `voyageai` service: `2000`\n* `watsonxai` service: `120`",
+ "type": "number"
+ }
+ }
+ },
+ "inference._types.InferenceEndpointInfoAi21": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpoint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inference_id": {
+ "description": "The inference Id",
+ "type": "string"
+ },
+ "task_type": {
+ "description": "The task type",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.TaskTypeAi21"
+ }
+ ]
+ }
+ },
+ "required": [
+ "inference_id",
+ "task_type"
+ ]
+ }
+ ]
+ },
+ "inference._types.TaskTypeAi21": {
+ "type": "string",
+ "enum": [
+ "completion",
+ "chat_completion"
+ ]
+ },
+ "inference._types.AlibabaCloudTaskType": {
+ "type": "string",
+ "enum": [
+ "completion",
+ "rerank",
+ "space_embedding",
+ "text_embedding"
+ ]
+ },
+ "inference._types.AlibabaCloudServiceType": {
+ "type": "string",
+ "enum": [
+ "alibabacloud-ai-search"
+ ]
+ },
+ "inference._types.AlibabaCloudServiceSettings": {
+ "type": "object",
+ "properties": {
+ "api_key": {
+ "description": "A valid API key for the AlibabaCloud AI Search API.",
+ "type": "string"
+ },
+ "host": {
+ "externalDocs": {
+ "url": "https://opensearch.console.aliyun.com/cn-shanghai/rag/api-key"
+ },
+ "description": "The name of the host address used for the inference task.\nYou can find the host address in the API keys section of the documentation.",
+ "type": "string"
+ },
+ "rate_limit": {
+ "description": "This setting helps to minimize the number of rate limit errors returned from AlibabaCloud AI Search.\nBy default, the `alibabacloud-ai-search` service sets the number of requests allowed per minute to `1000`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.RateLimitSetting"
+ }
+ ]
+ },
+ "service_id": {
+ "description": "The name of the model service to use for the inference task.\nThe following service IDs are available for the `completion` task:\n\n* `ops-qwen-turbo`\n* `qwen-turbo`\n* `qwen-plus`\n* `qwen-max ÷ qwen-max-longcontext`\n\nThe following service ID is available for the `rerank` task:\n\n* `ops-bge-reranker-larger`\n\nThe following service ID is available for the `sparse_embedding` task:\n\n* `ops-text-sparse-embedding-001`\n\nThe following service IDs are available for the `text_embedding` task:\n\n`ops-text-embedding-001`\n`ops-text-embedding-zh-001`\n`ops-text-embedding-en-001`\n`ops-text-embedding-002`",
+ "type": "string"
+ },
+ "workspace": {
+ "description": "The name of the workspace used for the inference task.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "api_key",
+ "host",
+ "service_id",
+ "workspace"
+ ]
+ },
+ "inference._types.AlibabaCloudTaskSettings": {
+ "type": "object",
+ "properties": {
+ "input_type": {
+ "description": "For a `sparse_embedding` or `text_embedding` task, specify the type of input passed to the model.\nValid values are:\n\n* `ingest` for storing document embeddings in a vector database.\n* `search` for storing embeddings of search queries run against a vector database to find relevant documents.",
+ "type": "string"
+ },
+ "return_token": {
+ "description": "For a `sparse_embedding` task, it affects whether the token name will be returned in the response.\nIt defaults to `false`, which means only the token ID will be returned in the response.",
+ "type": "boolean"
+ }
+ }
+ },
+ "inference._types.InferenceEndpointInfoAlibabaCloudAI": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpoint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inference_id": {
+ "description": "The inference Id",
+ "type": "string"
+ },
+ "task_type": {
+ "description": "The task type",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.TaskTypeAlibabaCloudAI"
+ }
+ ]
+ }
+ },
+ "required": [
+ "inference_id",
+ "task_type"
+ ]
+ }
+ ]
+ },
+ "inference._types.TaskTypeAlibabaCloudAI": {
+ "type": "string",
+ "enum": [
+ "text_embedding",
+ "rerank",
+ "completion",
+ "sparse_embedding"
+ ]
+ },
+ "inference._types.AmazonBedrockTaskType": {
+ "type": "string",
+ "enum": [
+ "completion",
+ "text_embedding"
+ ]
+ },
+ "inference._types.AmazonBedrockServiceType": {
+ "type": "string",
+ "enum": [
+ "amazonbedrock"
+ ]
+ },
+ "inference._types.AmazonBedrockServiceSettings": {
+ "type": "object",
+ "properties": {
+ "access_key": {
+ "description": "A valid AWS access key that has permissions to use Amazon Bedrock and access to models for inference requests.",
+ "type": "string"
+ },
+ "model": {
+ "externalDocs": {
+ "url": "https://docs.aws.amazon.com/bedrock/latest/userguide/models-supported.html"
+ },
+ "description": "The base model ID or an ARN to a custom model based on a foundational model.\nThe base model IDs can be found in the Amazon Bedrock documentation.\nNote that the model ID must be available for the provider chosen and your IAM user must have access to the model.",
+ "type": "string"
+ },
+ "provider": {
+ "description": "The model provider for your deployment.\nNote that some providers may support only certain task types.\nSupported providers include:\n\n* `amazontitan` - available for `text_embedding` and `completion` task types\n* `anthropic` - available for `completion` task type only\n* `ai21labs` - available for `completion` task type only\n* `cohere` - available for `text_embedding` and `completion` task types\n* `meta` - available for `completion` task type only\n* `mistral` - available for `completion` task type only",
+ "type": "string"
+ },
+ "region": {
+ "externalDocs": {
+ "url": "https://docs.aws.amazon.com/bedrock/latest/userguide/models-supported.html"
+ },
+ "description": "The region that your model or ARN is deployed in.\nThe list of available regions per model can be found in the Amazon Bedrock documentation.",
+ "type": "string"
+ },
+ "rate_limit": {
+ "description": "This setting helps to minimize the number of rate limit errors returned from Watsonx.\nBy default, the `watsonxai` service sets the number of requests allowed per minute to 120.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.RateLimitSetting"
+ }
+ ]
+ },
+ "secret_key": {
+ "externalDocs": {
+ "url": "https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html"
+ },
+ "description": "A valid AWS secret key that is paired with the `access_key`.\nFor informationg about creating and managing access and secret keys, refer to the AWS documentation.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "access_key",
+ "model",
+ "region",
+ "secret_key"
+ ]
+ },
+ "inference._types.AmazonBedrockTaskSettings": {
+ "type": "object",
+ "properties": {
+ "max_new_tokens": {
+ "description": "For a `completion` task, it sets the maximum number for the output tokens to be generated.",
+ "default": 64.0,
+ "type": "number"
+ },
+ "temperature": {
+ "description": "For a `completion` task, it is a number between 0.0 and 1.0 that controls the apparent creativity of the results.\nAt temperature 0.0 the model is most deterministic, at temperature 1.0 most random.\nIt should not be used if `top_p` or `top_k` is specified.",
+ "type": "number"
+ },
+ "top_k": {
+ "description": "For a `completion` task, it limits samples to the top-K most likely words, balancing coherence and variability.\nIt is only available for anthropic, cohere, and mistral providers.\nIt is an alternative to `temperature`; it should not be used if `temperature` is specified.",
+ "type": "number"
+ },
+ "top_p": {
+ "description": "For a `completion` task, it is a number in the range of 0.0 to 1.0, to eliminate low-probability tokens.\nTop-p uses nucleus sampling to select top tokens whose sum of likelihoods does not exceed a certain value, ensuring both variety and coherence.\nIt is an alternative to `temperature`; it should not be used if `temperature` is specified.",
+ "type": "number"
+ }
+ }
+ },
+ "inference._types.InferenceEndpointInfoAmazonBedrock": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpoint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inference_id": {
+ "description": "The inference Id",
+ "type": "string"
+ },
+ "task_type": {
+ "description": "The task type",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.TaskTypeAmazonBedrock"
+ }
+ ]
+ }
+ },
+ "required": [
+ "inference_id",
+ "task_type"
+ ]
+ }
+ ]
+ },
+ "inference._types.TaskTypeAmazonBedrock": {
+ "type": "string",
+ "enum": [
+ "text_embedding",
+ "completion"
+ ]
+ },
+ "inference._types.TaskTypeAmazonSageMaker": {
+ "type": "string",
+ "enum": [
+ "text_embedding",
+ "completion",
+ "chat_completion",
+ "sparse_embedding",
+ "rerank"
+ ]
+ },
+ "inference._types.AmazonSageMakerServiceType": {
+ "type": "string",
+ "enum": [
+ "amazon_sagemaker"
+ ]
+ },
+ "inference._types.AmazonSageMakerServiceSettings": {
+ "type": "object",
+ "properties": {
+ "access_key": {
+ "description": "A valid AWS access key that has permissions to use Amazon SageMaker and access to models for invoking requests.",
+ "type": "string"
+ },
+ "endpoint_name": {
+ "externalDocs": {
+ "url": "https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html"
+ },
+ "description": "The name of the SageMaker endpoint.",
+ "type": "string"
+ },
+ "api": {
+ "description": "The API format to use when calling SageMaker.\nElasticsearch will convert the POST _inference request to this data format when invoking the SageMaker endpoint.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.AmazonSageMakerApi"
+ }
+ ]
+ },
+ "region": {
+ "externalDocs": {
+ "url": "https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html"
+ },
+ "description": "The region that your endpoint or Amazon Resource Name (ARN) is deployed in.\nThe list of available regions per model can be found in the Amazon SageMaker documentation.",
+ "type": "string"
+ },
+ "secret_key": {
+ "externalDocs": {
+ "url": "https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html"
+ },
+ "description": "A valid AWS secret key that is paired with the `access_key`.\nFor information about creating and managing access and secret keys, refer to the AWS documentation.",
+ "type": "string"
+ },
+ "target_model": {
+ "externalDocs": {
+ "url": "https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html"
+ },
+ "description": "The model ID when calling a multi-model endpoint.",
+ "type": "string"
+ },
+ "target_container_hostname": {
+ "externalDocs": {
+ "url": "https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html"
+ },
+ "description": "The container to directly invoke when calling a multi-container endpoint.",
+ "type": "string"
+ },
+ "inference_component_name": {
+ "externalDocs": {
+ "url": "https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html"
+ },
+ "description": "The inference component to directly invoke when calling a multi-component endpoint.",
+ "type": "string"
+ },
+ "batch_size": {
+ "description": "The maximum number of inputs in each batch. This value is used by inference ingestion pipelines\nwhen processing semantic values. It correlates to the number of times the SageMaker endpoint is\ninvoked (one per batch of input).",
+ "default": 256.0,
+ "type": "number"
+ },
+ "dimensions": {
+ "description": "The number of dimensions returned by the text embedding models. If this value is not provided, then\nit is guessed by making invoking the endpoint for the `text_embedding` task.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "access_key",
+ "endpoint_name",
+ "api",
+ "region",
+ "secret_key"
+ ]
+ },
+ "inference._types.AmazonSageMakerApi": {
+ "type": "string",
+ "enum": [
+ "openai",
+ "elastic"
+ ]
+ },
+ "inference._types.AmazonSageMakerTaskSettings": {
+ "type": "object",
+ "properties": {
+ "custom_attributes": {
+ "externalDocs": {
+ "url": "https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html"
+ },
+ "description": "The AWS custom attributes passed verbatim through to the model running in the SageMaker Endpoint.\nValues will be returned in the `X-elastic-sagemaker-custom-attributes` header.",
+ "type": "string"
+ },
+ "enable_explanations": {
+ "externalDocs": {
+ "url": "https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html"
+ },
+ "description": "The optional JMESPath expression used to override the EnableExplanations provided during endpoint creation.",
+ "type": "string"
+ },
+ "inference_id": {
+ "externalDocs": {
+ "url": "https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html"
+ },
+ "description": "The capture data ID when enabled in the endpoint.",
+ "type": "string"
+ },
+ "session_id": {
+ "externalDocs": {
+ "url": "https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html"
+ },
+ "description": "The stateful session identifier for a new or existing session.\nNew sessions will be returned in the `X-elastic-sagemaker-new-session-id` header.\nClosed sessions will be returned in the `X-elastic-sagemaker-closed-session-id` header.",
+ "type": "string"
+ },
+ "target_variant": {
+ "externalDocs": {
+ "url": "https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html"
+ },
+ "description": "Specifies the variant when running with multi-variant Endpoints.",
+ "type": "string"
+ }
+ }
+ },
+ "inference._types.InferenceEndpointInfoAmazonSageMaker": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpoint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inference_id": {
+ "description": "The inference Id",
+ "type": "string"
+ },
+ "task_type": {
+ "description": "The task type",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.TaskTypeAmazonSageMaker"
+ }
+ ]
+ }
+ },
+ "required": [
+ "inference_id",
+ "task_type"
+ ]
+ }
+ ]
+ },
+ "inference._types.AnthropicTaskType": {
+ "type": "string",
+ "enum": [
+ "completion"
+ ]
+ },
+ "inference._types.AnthropicServiceType": {
+ "type": "string",
+ "enum": [
+ "anthropic"
+ ]
+ },
+ "inference._types.AnthropicServiceSettings": {
+ "type": "object",
+ "properties": {
+ "api_key": {
+ "description": "A valid API key for the Anthropic API.",
+ "type": "string"
+ },
+ "model_id": {
+ "description": "The name of the model to use for the inference task.\nRefer to the Anthropic documentation for the list of supported models.",
+ "type": "string"
+ },
+ "rate_limit": {
+ "description": "This setting helps to minimize the number of rate limit errors returned from Anthropic.\nBy default, the `anthropic` service sets the number of requests allowed per minute to 50.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.RateLimitSetting"
+ }
+ ]
+ }
+ },
+ "required": [
+ "api_key",
+ "model_id"
+ ]
+ },
+ "inference._types.AnthropicTaskSettings": {
+ "type": "object",
+ "properties": {
+ "max_tokens": {
+ "description": "For a `completion` task, it is the maximum number of tokens to generate before stopping.",
+ "type": "number"
+ },
+ "temperature": {
+ "externalDocs": {
+ "url": "https://docs.anthropic.com/en/api/messages"
+ },
+ "description": "For a `completion` task, it is the amount of randomness injected into the response.\nFor more details about the supported range, refer to Anthropic documentation.",
+ "type": "number"
+ },
+ "top_k": {
+ "description": "For a `completion` task, it specifies to only sample from the top K options for each subsequent token.\nIt is recommended for advanced use cases only.\nYou usually only need to use `temperature`.",
+ "type": "number"
+ },
+ "top_p": {
+ "description": "For a `completion` task, it specifies to use Anthropic's nucleus sampling.\nIn nucleus sampling, Anthropic computes the cumulative distribution over all the options for each subsequent token in decreasing probability order and cuts it off once it reaches the specified probability.\nYou should either alter `temperature` or `top_p`, but not both.\nIt is recommended for advanced use cases only.\nYou usually only need to use `temperature`.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "max_tokens"
+ ]
+ },
+ "inference._types.InferenceEndpointInfoAnthropic": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpoint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inference_id": {
+ "description": "The inference Id",
+ "type": "string"
+ },
+ "task_type": {
+ "description": "The task type",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.TaskTypeAnthropic"
+ }
+ ]
+ }
+ },
+ "required": [
+ "inference_id",
+ "task_type"
+ ]
+ }
+ ]
+ },
+ "inference._types.TaskTypeAnthropic": {
+ "type": "string",
+ "enum": [
+ "completion"
+ ]
+ },
+ "inference._types.AzureAiStudioTaskType": {
+ "type": "string",
+ "enum": [
+ "completion",
+ "rerank",
+ "text_embedding"
+ ]
+ },
+ "inference._types.AzureAiStudioServiceType": {
+ "type": "string",
+ "enum": [
+ "azureaistudio"
+ ]
+ },
+ "inference._types.AzureAiStudioServiceSettings": {
+ "type": "object",
+ "properties": {
+ "api_key": {
+ "externalDocs": {
+ "url": "https://ai.azure.com/"
+ },
+ "description": "A valid API key of your Azure AI Studio model deployment.\nThis key can be found on the overview page for your deployment in the management section of your Azure AI Studio account.\n\nIMPORTANT: You need to provide the API key only once, during the inference model creation.\nThe get inference endpoint API does not retrieve your API key.\nAfter creating the inference model, you cannot change the associated API key.\nIf you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key.",
+ "type": "string"
+ },
+ "endpoint_type": {
+ "externalDocs": {
+ "url": "https://learn.microsoft.com/en-us/azure/ai-foundry/concepts/deployments-overview#billing-for-deploying-and-inferencing-llms-in-azure-ai-studio"
+ },
+ "description": "The type of endpoint that is available for deployment through Azure AI Studio: `token` or `realtime`.\nThe `token` endpoint type is for \"pay as you go\" endpoints that are billed per token.\nThe `realtime` endpoint type is for \"real-time\" endpoints that are billed per hour of usage.",
+ "type": "string"
+ },
+ "target": {
+ "description": "The target URL of your Azure AI Studio model deployment.\nThis can be found on the overview page for your deployment in the management section of your Azure AI Studio account.",
+ "type": "string"
+ },
+ "provider": {
+ "description": "The model provider for your deployment.\nNote that some providers may support only certain task types.\nSupported providers include:\n\n* `cohere` - available for `text_embedding` and `completion` task types\n* `databricks` - available for `completion` task type only\n* `meta` - available for `completion` task type only\n* `microsoft_phi` - available for `completion` task type only\n* `mistral` - available for `completion` task type only\n* `openai` - available for `text_embedding` and `completion` task types",
+ "type": "string"
+ },
+ "rate_limit": {
+ "description": "This setting helps to minimize the number of rate limit errors returned from Azure AI Studio.\nBy default, the `azureaistudio` service sets the number of requests allowed per minute to 240.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.RateLimitSetting"
+ }
+ ]
+ }
+ },
+ "required": [
+ "api_key",
+ "endpoint_type",
+ "target",
+ "provider"
+ ]
+ },
+ "inference._types.AzureAiStudioTaskSettings": {
+ "type": "object",
+ "properties": {
+ "do_sample": {
+ "description": "For a `completion` task, instruct the inference process to perform sampling.\nIt has no effect unless `temperature` or `top_p` is specified.",
+ "type": "number"
+ },
+ "max_new_tokens": {
+ "description": "For a `completion` task, provide a hint for the maximum number of output tokens to be generated.",
+ "default": 64.0,
+ "type": "number"
+ },
+ "temperature": {
+ "description": "For a `completion` task, control the apparent creativity of generated completions with a sampling temperature.\nIt must be a number in the range of 0.0 to 2.0.\nIt should not be used if `top_p` is specified.",
+ "type": "number"
+ },
+ "top_p": {
+ "description": "For a `completion` task, make the model consider the results of the tokens with nucleus sampling probability.\nIt is an alternative value to `temperature` and must be a number in the range of 0.0 to 2.0.\nIt should not be used if `temperature` is specified.",
+ "type": "number"
+ },
+ "user": {
+ "description": "For a `text_embedding` task, specify the user issuing the request.\nThis information can be used for abuse detection.",
+ "type": "string"
+ },
+ "return_documents": {
+ "description": "For a `rerank` task, return doc text within the results.",
+ "type": "boolean"
+ },
+ "top_n": {
+ "description": "For a `rerank` task, the number of most relevant documents to return.\nIt defaults to the number of the documents.",
+ "type": "number"
+ }
+ }
+ },
+ "inference._types.InferenceEndpointInfoAzureAIStudio": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpoint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inference_id": {
+ "description": "The inference Id",
+ "type": "string"
+ },
+ "task_type": {
+ "description": "The task type",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.TaskTypeAzureAIStudio"
+ }
+ ]
+ }
+ },
+ "required": [
+ "inference_id",
+ "task_type"
+ ]
+ }
+ ]
+ },
+ "inference._types.TaskTypeAzureAIStudio": {
+ "type": "string",
+ "enum": [
+ "text_embedding",
+ "completion",
+ "rerank"
+ ]
+ },
+ "inference._types.AzureOpenAITaskType": {
+ "type": "string",
+ "enum": [
+ "completion",
+ "text_embedding"
+ ]
+ },
+ "inference._types.AzureOpenAIServiceType": {
+ "type": "string",
+ "enum": [
+ "azureopenai"
+ ]
+ },
+ "inference._types.AzureOpenAIServiceSettings": {
+ "type": "object",
+ "properties": {
+ "api_key": {
+ "externalDocs": {
+ "url": "https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#authentication"
+ },
+ "description": "A valid API key for your Azure OpenAI account.\nYou must specify either `api_key` or `entra_id`.\nIf you do not provide either or you provide both, you will receive an error when you try to create your model.\n\nIMPORTANT: You need to provide the API key only once, during the inference model creation.\nThe get inference endpoint API does not retrieve your API key.\nAfter creating the inference model, you cannot change the associated API key.\nIf you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key.",
+ "type": "string"
+ },
+ "api_version": {
+ "description": "The Azure API version ID to use.\nIt is recommended to use the latest supported non-preview version.",
+ "type": "string"
+ },
+ "deployment_id": {
+ "externalDocs": {
+ "url": "https://oai.azure.com/"
+ },
+ "description": "The deployment name of your deployed models.\nYour Azure OpenAI deployments can be found though the Azure OpenAI Studio portal that is linked to your subscription.",
+ "type": "string"
+ },
+ "entra_id": {
+ "externalDocs": {
+ "url": "https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#authentication"
+ },
+ "description": "A valid Microsoft Entra token.\nYou must specify either `api_key` or `entra_id`.\nIf you do not provide either or you provide both, you will receive an error when you try to create your model.",
+ "type": "string"
+ },
+ "rate_limit": {
+ "externalDocs": {
+ "url": "https://learn.microsoft.com/en-us/azure/ai-services/openai/quotas-limits"
+ },
+ "description": "This setting helps to minimize the number of rate limit errors returned from Azure.\nThe `azureopenai` service sets a default number of requests allowed per minute depending on the task type.\nFor `text_embedding`, it is set to `1440`.\nFor `completion`, it is set to `120`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.RateLimitSetting"
+ }
+ ]
+ },
+ "resource_name": {
+ "externalDocs": {
+ "url": "https://portal.azure.com/#view/HubsExtension/BrowseAll"
+ },
+ "description": "The name of your Azure OpenAI resource.\nYou can find this from the list of resources in the Azure Portal for your subscription.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "api_version",
+ "deployment_id",
+ "resource_name"
+ ]
+ },
+ "inference._types.AzureOpenAITaskSettings": {
+ "type": "object",
+ "properties": {
+ "user": {
+ "description": "For a `completion` or `text_embedding` task, specify the user issuing the request.\nThis information can be used for abuse detection.",
+ "type": "string"
+ }
+ }
+ },
+ "inference._types.InferenceEndpointInfoAzureOpenAI": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpoint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inference_id": {
+ "description": "The inference Id",
+ "type": "string"
+ },
+ "task_type": {
+ "description": "The task type",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.TaskTypeAzureOpenAI"
+ }
+ ]
+ }
+ },
+ "required": [
+ "inference_id",
+ "task_type"
+ ]
+ }
+ ]
+ },
+ "inference._types.TaskTypeAzureOpenAI": {
+ "type": "string",
+ "enum": [
+ "text_embedding",
+ "completion"
+ ]
+ },
+ "inference._types.CohereTaskType": {
+ "type": "string",
+ "enum": [
+ "completion",
+ "rerank",
+ "text_embedding"
+ ]
+ },
+ "inference._types.CohereServiceType": {
+ "type": "string",
+ "enum": [
+ "cohere"
+ ]
+ },
+ "inference._types.CohereServiceSettings": {
+ "type": "object",
+ "properties": {
+ "api_key": {
+ "externalDocs": {
+ "url": "https://dashboard.cohere.com/api-keys"
+ },
+ "description": "A valid API key for your Cohere account.\nYou can find or create your Cohere API keys on the Cohere API key settings page.\n\nIMPORTANT: You need to provide the API key only once, during the inference model creation.\nThe get inference endpoint API does not retrieve your API key.\nAfter creating the inference model, you cannot change the associated API key.\nIf you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key.",
+ "type": "string"
+ },
+ "embedding_type": {
+ "description": "For a `text_embedding` task, the types of embeddings you want to get back.\nUse `binary` for binary embeddings, which are encoded as bytes with signed int8 precision.\nUse `bit` for binary embeddings, which are encoded as bytes with signed int8 precision (this is a synonym of `binary`).\nUse `byte` for signed int8 embeddings (this is a synonym of `int8`).\nUse `float` for the default float embeddings.\nUse `int8` for signed int8 embeddings.",
+ "default": "float",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.CohereEmbeddingType"
+ }
+ ]
+ },
+ "model_id": {
+ "description": "For a `completion`, `rerank`, or `text_embedding` task, the name of the model to use for the inference task.\n\n* For the available `completion` models, refer to the [Cohere command docs](https://docs.cohere.com/docs/models#command).\n* For the available `rerank` models, refer to the [Cohere rerank docs](https://docs.cohere.com/reference/rerank-1).\n* For the available `text_embedding` models, refer to [Cohere embed docs](https://docs.cohere.com/reference/embed).",
+ "type": "string"
+ },
+ "rate_limit": {
+ "description": "This setting helps to minimize the number of rate limit errors returned from Cohere.\nBy default, the `cohere` service sets the number of requests allowed per minute to 10000.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.RateLimitSetting"
+ }
+ ]
+ },
+ "similarity": {
+ "description": "The similarity measure.\nIf the `embedding_type` is `float`, the default value is `dot_product`.\nIf the `embedding_type` is `int8` or `byte`, the default value is `cosine`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.CohereSimilarityType"
+ }
+ ]
+ }
+ },
+ "required": [
+ "api_key",
+ "model_id"
+ ]
+ },
+ "inference._types.CohereEmbeddingType": {
+ "type": "string",
+ "enum": [
+ "binary",
+ "bit",
+ "byte",
+ "float",
+ "int8"
+ ]
+ },
+ "inference._types.CohereSimilarityType": {
+ "type": "string",
+ "enum": [
+ "cosine",
+ "dot_product",
+ "l2_norm"
+ ]
+ },
+ "inference._types.CohereTaskSettings": {
+ "type": "object",
+ "properties": {
+ "input_type": {
+ "description": "For a `text_embedding` task, the type of input passed to the model.\nValid values are:\n\n* `classification`: Use it for embeddings passed through a text classifier.\n* `clustering`: Use it for the embeddings run through a clustering algorithm.\n* `ingest`: Use it for storing document embeddings in a vector database.\n* `search`: Use it for storing embeddings of search queries run against a vector database to find relevant documents.\n\nIMPORTANT: The `input_type` field is required when using embedding models `v3` and higher.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.CohereInputType"
+ }
+ ]
+ },
+ "return_documents": {
+ "description": "For a `rerank` task, return doc text within the results.",
+ "type": "boolean"
+ },
+ "top_n": {
+ "description": "For a `rerank` task, the number of most relevant documents to return.\nIt defaults to the number of the documents.\nIf this inference endpoint is used in a `text_similarity_reranker` retriever query and `top_n` is set, it must be greater than or equal to `rank_window_size` in the query.",
+ "type": "number"
+ },
+ "truncate": {
+ "description": "For a `text_embedding` task, the method to handle inputs longer than the maximum token length.\nValid values are:\n\n* `END`: When the input exceeds the maximum input token length, the end of the input is discarded.\n* `NONE`: When the input exceeds the maximum input token length, an error is returned.\n* `START`: When the input exceeds the maximum input token length, the start of the input is discarded.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.CohereTruncateType"
+ }
+ ]
+ }
+ },
+ "required": [
+ "input_type"
+ ]
+ },
+ "inference._types.CohereInputType": {
+ "type": "string",
+ "enum": [
+ "classification",
+ "clustering",
+ "ingest",
+ "search"
+ ]
+ },
+ "inference._types.CohereTruncateType": {
+ "type": "string",
+ "enum": [
+ "END",
+ "NONE",
+ "START"
+ ]
+ },
+ "inference._types.InferenceEndpointInfoCohere": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpoint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inference_id": {
+ "description": "The inference Id",
+ "type": "string"
+ },
+ "task_type": {
+ "description": "The task type",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.TaskTypeCohere"
+ }
+ ]
+ }
+ },
+ "required": [
+ "inference_id",
+ "task_type"
+ ]
+ }
+ ]
+ },
+ "inference._types.TaskTypeCohere": {
+ "type": "string",
+ "enum": [
+ "text_embedding",
+ "rerank",
+ "completion"
+ ]
+ },
+ "inference._types.CustomTaskType": {
+ "type": "string",
+ "enum": [
+ "text_embedding",
+ "sparse_embedding",
+ "rerank",
+ "completion"
+ ]
+ },
+ "inference._types.CustomServiceType": {
+ "type": "string",
+ "enum": [
+ "custom"
+ ]
+ },
+ "inference._types.CustomServiceSettings": {
+ "type": "object",
+ "properties": {
+ "headers": {
+ "description": "Specifies the HTTPS header parameters – such as `Authentication` or `Contet-Type` – that are required to access the custom service.\nFor example:\n```\n\"headers\":{\n \"Authorization\": \"Bearer ${api_key}\",\n \"Content-Type\": \"application/json;charset=utf-8\"\n}\n```",
+ "type": "object"
+ },
+ "input_type": {
+ "description": "Specifies the input type translation values that are used to replace the `${input_type}` template in the request body.\nFor example:\n```\n\"input_type\": {\n \"translation\": {\n \"ingest\": \"do_ingest\",\n \"search\": \"do_search\"\n },\n \"default\": \"a_default\"\n},\n```\nIf the subsequent inference requests come from a search context, the `search` key will be used and the template will be replaced with `do_search`.\nIf it comes from the ingest context `do_ingest` is used. If it's a different context that is not specified, the default value will be used. If no default is specified an empty string is used.\n`translation` can be:\n* `classification`\n* `clustering`\n* `ingest`\n* `search`",
+ "type": "object"
+ },
+ "query_parameters": {
+ "description": "Specifies the query parameters as a list of tuples. The arrays inside the `query_parameters` must have two items, a key and a value.\nFor example:\n```\n\"query_parameters\":[\n [\"param_key\", \"some_value\"],\n [\"param_key\", \"another_value\"],\n [\"other_key\", \"other_value\"]\n]\n```\nIf the base url is `https://www.elastic.co` it results in: `https://www.elastic.co?param_key=some_value¶m_key=another_value&other_key=other_value`.",
+ "type": "object"
+ },
+ "request": {
+ "description": "The request configuration object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.CustomRequestParams"
+ }
+ ]
+ },
+ "response": {
+ "description": "The response configuration object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.CustomResponseParams"
+ }
+ ]
+ },
+ "secret_parameters": {
+ "description": "Specifies secret parameters, like `api_key` or `api_token`, that are required to access the custom service.\nFor example:\n```\n\"secret_parameters\":{\n \"api_key\":\"\"\n}\n```",
+ "type": "object"
+ },
+ "url": {
+ "description": "The URL endpoint to use for the requests.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "request",
+ "response",
+ "secret_parameters"
+ ]
+ },
+ "inference._types.CustomRequestParams": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "description": "The body structure of the request. It requires passing in the string-escaped result of the JSON format HTTP request body.\nFor example:\n```\n\"request\": \"{\\\"input\\\":${input}}\"\n```\n> info\n> The content string needs to be a single line except when using the Kibana console.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "inference._types.CustomResponseParams": {
+ "type": "object",
+ "properties": {
+ "json_parser": {
+ "description": "Specifies the JSON parser that is used to parse the response from the custom service.\nDifferent task types require different json_parser parameters.\nFor example:\n```\n# text_embedding\n# For a response like this:\n\n{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"embedding\",\n \"index\": 0,\n \"embedding\": [\n 0.014539449,\n -0.015288644\n ]\n }\n ],\n \"model\": \"text-embedding-ada-002-v2\",\n \"usage\": {\n \"prompt_tokens\": 8,\n \"total_tokens\": 8\n }\n}\n\n# the json_parser definition should look like this:\n\n\"response\":{\n \"json_parser\":{\n \"text_embeddings\":\"$.data[*].embedding[*]\"\n }\n}\n\n# sparse_embedding\n# For a response like this:\n\n{\n \"request_id\": \"75C50B5B-E79E-4930-****-F48DBB392231\",\n \"latency\": 22,\n \"usage\": {\n \"token_count\": 11\n },\n \"result\": {\n \"sparse_embeddings\": [\n {\n \"index\": 0,\n \"embedding\": [\n {\n \"token_id\": 6,\n \"weight\": 0.101\n },\n {\n \"token_id\": 163040,\n \"weight\": 0.28417\n }\n ]\n }\n ]\n }\n}\n\n# the json_parser definition should look like this:\n\n\"response\":{\n \"json_parser\":{\n \"token_path\":\"$.result.sparse_embeddings[*].embedding[*].token_id\",\n \"weight_path\":\"$.result.sparse_embeddings[*].embedding[*].weight\"\n }\n}\n\n# rerank\n# For a response like this:\n\n{\n \"results\": [\n {\n \"index\": 3,\n \"relevance_score\": 0.999071,\n \"document\": \"abc\"\n },\n {\n \"index\": 4,\n \"relevance_score\": 0.7867867,\n \"document\": \"123\"\n },\n {\n \"index\": 0,\n \"relevance_score\": 0.32713068,\n \"document\": \"super\"\n }\n ],\n}\n\n# the json_parser definition should look like this:\n\n\"response\":{\n \"json_parser\":{\n \"reranked_index\":\"$.result.scores[*].index\", // optional\n \"relevance_score\":\"$.result.scores[*].score\",\n \"document_text\":\"xxx\" // optional\n }\n}\n\n# completion\n# For a response like this:\n\n{\n \"id\": \"chatcmpl-B9MBs8CjcvOU2jLn4n570S5qMJKcT\",\n \"object\": \"chat.completion\",\n \"created\": 1741569952,\n \"model\": \"gpt-4.1-2025-04-14\",\n \"choices\": [\n {\n \"index\": 0,\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"Hello! How can I assist you today?\",\n \"refusal\": null,\n \"annotations\": []\n },\n \"logprobs\": null,\n \"finish_reason\": \"stop\"\n }\n ]\n}\n\n# the json_parser definition should look like this:\n\n\"response\":{\n \"json_parser\":{\n \"completion_result\":\"$.choices[*].message.content\"\n }\n}",
+ "type": "object"
+ }
+ },
+ "required": [
+ "json_parser"
+ ]
+ },
+ "inference._types.CustomTaskSettings": {
+ "type": "object",
+ "properties": {
+ "parameters": {
+ "description": "Specifies parameters that are required to run the custom service. The parameters depend on the model your custom service uses.\nFor example:\n```\n\"task_settings\":{\n \"parameters\":{\n \"input_type\":\"query\",\n \"return_token\":true\n }\n}\n```",
+ "type": "object"
+ }
+ }
+ },
+ "inference._types.InferenceEndpointInfoCustom": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpoint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inference_id": {
+ "description": "The inference Id",
+ "type": "string"
+ },
+ "task_type": {
+ "description": "The task type",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.TaskTypeCustom"
+ }
+ ]
+ }
+ },
+ "required": [
+ "inference_id",
+ "task_type"
+ ]
+ }
+ ]
+ },
+ "inference._types.TaskTypeCustom": {
+ "type": "string",
+ "enum": [
+ "text_embedding",
+ "sparse_embedding",
+ "rerank",
+ "completion"
+ ]
+ },
+ "inference._types.TaskTypeDeepSeek": {
+ "type": "string",
+ "enum": [
+ "completion",
+ "chat_completion"
+ ]
+ },
+ "inference._types.DeepSeekServiceType": {
+ "type": "string",
+ "enum": [
+ "deepseek"
+ ]
+ },
+ "inference._types.DeepSeekServiceSettings": {
+ "type": "object",
+ "properties": {
+ "api_key": {
+ "externalDocs": {
+ "url": "https://api-docs.deepseek.com/"
+ },
+ "description": "A valid API key for your DeepSeek account.\nYou can find or create your DeepSeek API keys on the DeepSeek API key page.\n\nIMPORTANT: You need to provide the API key only once, during the inference model creation.\nThe get inference endpoint API does not retrieve your API key.\nAfter creating the inference model, you cannot change the associated API key.\nIf you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key.",
+ "type": "string"
+ },
+ "model_id": {
+ "description": "For a `completion` or `chat_completion` task, the name of the model to use for the inference task.\n\nFor the available `completion` and `chat_completion` models, refer to the [DeepSeek Models & Pricing docs](https://api-docs.deepseek.com/quick_start/pricing).",
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL endpoint to use for the requests. Defaults to `https://api.deepseek.com/chat/completions`.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "api_key",
+ "model_id"
+ ]
+ },
+ "inference._types.InferenceEndpointInfoDeepSeek": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpoint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inference_id": {
+ "description": "The inference Id",
+ "type": "string"
+ },
+ "task_type": {
+ "description": "The task type",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.TaskTypeDeepSeek"
+ }
+ ]
+ }
+ },
+ "required": [
+ "inference_id",
+ "task_type"
+ ]
+ }
+ ]
+ },
+ "inference._types.ElasticsearchTaskType": {
+ "type": "string",
+ "enum": [
+ "rerank",
+ "sparse_embedding",
+ "text_embedding"
+ ]
+ },
+ "inference._types.ElasticsearchServiceType": {
+ "type": "string",
+ "enum": [
+ "elasticsearch"
+ ]
+ },
+ "inference._types.ElasticsearchServiceSettings": {
+ "type": "object",
+ "properties": {
+ "adaptive_allocations": {
+ "description": "Adaptive allocations configuration details.\nIf `enabled` is true, the number of allocations of the model is set based on the current load the process gets.\nWhen the load is high, a new model allocation is automatically created, respecting the value of `max_number_of_allocations` if it's set.\nWhen the load is low, a model allocation is automatically removed, respecting the value of `min_number_of_allocations` if it's set.\nIf `enabled` is true, do not set the number of allocations manually.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.AdaptiveAllocations"
+ }
+ ]
+ },
+ "deployment_id": {
+ "description": "The deployment identifier for a trained model deployment.\nWhen `deployment_id` is used the `model_id` is optional.",
+ "type": "string"
+ },
+ "model_id": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/explore-analyze/machine-learning/nlp/ml-nlp-import-model#ml-nlp-import-script"
+ },
+ "description": "The name of the model to use for the inference task.\nIt can be the ID of a built-in model (for example, `.multilingual-e5-small` for E5) or a text embedding model that was uploaded by using the Eland client.",
+ "type": "string"
+ },
+ "num_allocations": {
+ "description": "The total number of allocations that are assigned to the model across machine learning nodes.\nIncreasing this value generally increases the throughput.\nIf adaptive allocations are enabled, do not set this value because it's automatically set.",
+ "type": "number"
+ },
+ "num_threads": {
+ "description": "The number of threads used by each model allocation during inference.\nThis setting generally increases the speed per inference request.\nThe inference process is a compute-bound process; `threads_per_allocations` must not exceed the number of available allocated processors per node.\nThe value must be a power of 2.\nThe maximum value is 32.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "model_id",
+ "num_threads"
+ ]
+ },
+ "inference._types.AdaptiveAllocations": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "description": "Turn on `adaptive_allocations`.",
+ "default": false,
+ "type": "boolean"
+ },
+ "max_number_of_allocations": {
+ "description": "The maximum number of allocations to scale to.\nIf set, it must be greater than or equal to `min_number_of_allocations`.",
+ "type": "number"
+ },
+ "min_number_of_allocations": {
+ "description": "The minimum number of allocations to scale to.\nIf set, it must be greater than or equal to 0.\nIf not defined, the deployment scales to 0.",
+ "type": "number"
+ }
+ }
+ },
+ "inference._types.ElasticsearchTaskSettings": {
+ "type": "object",
+ "properties": {
+ "return_documents": {
+ "description": "For a `rerank` task, return the document instead of only the index.",
+ "default": true,
+ "type": "boolean"
+ }
+ }
+ },
+ "inference._types.InferenceEndpointInfoElasticsearch": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpoint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inference_id": {
+ "description": "The inference Id",
+ "type": "string"
+ },
+ "task_type": {
+ "description": "The task type",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.TaskTypeElasticsearch"
+ }
+ ]
+ }
+ },
+ "required": [
+ "inference_id",
+ "task_type"
+ ]
+ }
+ ]
+ },
+ "inference._types.TaskTypeElasticsearch": {
+ "type": "string",
+ "enum": [
+ "sparse_embedding",
+ "text_embedding",
+ "rerank"
+ ]
+ },
+ "inference._types.ElserTaskType": {
+ "type": "string",
+ "enum": [
+ "sparse_embedding"
+ ]
+ },
+ "inference._types.ElserServiceType": {
+ "type": "string",
+ "enum": [
+ "elser"
+ ]
+ },
+ "inference._types.ElserServiceSettings": {
+ "type": "object",
+ "properties": {
+ "adaptive_allocations": {
+ "description": "Adaptive allocations configuration details.\nIf `enabled` is true, the number of allocations of the model is set based on the current load the process gets.\nWhen the load is high, a new model allocation is automatically created, respecting the value of `max_number_of_allocations` if it's set.\nWhen the load is low, a model allocation is automatically removed, respecting the value of `min_number_of_allocations` if it's set.\nIf `enabled` is true, do not set the number of allocations manually.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.AdaptiveAllocations"
+ }
+ ]
+ },
+ "num_allocations": {
+ "description": "The total number of allocations this model is assigned across machine learning nodes.\nIncreasing this value generally increases the throughput.\nIf adaptive allocations is enabled, do not set this value because it's automatically set.",
+ "type": "number"
+ },
+ "num_threads": {
+ "description": "The number of threads used by each model allocation during inference.\nIncreasing this value generally increases the speed per inference request.\nThe inference process is a compute-bound process; `threads_per_allocations` must not exceed the number of available allocated processors per node.\nThe value must be a power of 2.\nThe maximum value is 32.\n\n> info\n> If you want to optimize your ELSER endpoint for ingest, set the number of threads to 1. If you want to optimize your ELSER endpoint for search, set the number of threads to greater than 1.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "num_allocations",
+ "num_threads"
+ ]
+ },
+ "inference._types.InferenceEndpointInfoELSER": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpoint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inference_id": {
+ "description": "The inference Id",
+ "type": "string"
+ },
+ "task_type": {
+ "description": "The task type",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.TaskTypeELSER"
+ }
+ ]
+ }
+ },
+ "required": [
+ "inference_id",
+ "task_type"
+ ]
+ }
+ ]
+ },
+ "inference._types.TaskTypeELSER": {
+ "type": "string",
+ "enum": [
+ "sparse_embedding"
+ ]
+ },
+ "inference._types.GoogleAiStudioTaskType": {
+ "type": "string",
+ "enum": [
+ "completion",
+ "text_embedding"
+ ]
+ },
+ "inference._types.GoogleAiServiceType": {
+ "type": "string",
+ "enum": [
+ "googleaistudio"
+ ]
+ },
+ "inference._types.GoogleAiStudioServiceSettings": {
+ "type": "object",
+ "properties": {
+ "api_key": {
+ "description": "A valid API key of your Google Gemini account.",
+ "type": "string"
+ },
+ "model_id": {
+ "externalDocs": {
+ "url": "https://ai.google.dev/gemini-api/docs/models"
+ },
+ "description": "The name of the model to use for the inference task.\nRefer to the Google documentation for the list of supported models.",
+ "type": "string"
+ },
+ "rate_limit": {
+ "description": "This setting helps to minimize the number of rate limit errors returned from Google AI Studio.\nBy default, the `googleaistudio` service sets the number of requests allowed per minute to 360.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.RateLimitSetting"
+ }
+ ]
+ }
+ },
+ "required": [
+ "api_key",
+ "model_id"
+ ]
+ },
+ "inference._types.InferenceEndpointInfoGoogleAIStudio": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpoint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inference_id": {
+ "description": "The inference Id",
+ "type": "string"
+ },
+ "task_type": {
+ "description": "The task type",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.TaskTypeGoogleAIStudio"
+ }
+ ]
+ }
+ },
+ "required": [
+ "inference_id",
+ "task_type"
+ ]
+ }
+ ]
+ },
+ "inference._types.TaskTypeGoogleAIStudio": {
+ "type": "string",
+ "enum": [
+ "text_embedding",
+ "completion"
+ ]
+ },
+ "inference._types.GoogleVertexAITaskType": {
+ "type": "string",
+ "enum": [
+ "rerank",
+ "text_embedding",
+ "completion",
+ "chat_completion"
+ ]
+ },
+ "inference._types.GoogleVertexAIServiceType": {
+ "type": "string",
+ "enum": [
+ "googlevertexai"
+ ]
+ },
+ "inference._types.GoogleVertexAIServiceSettings": {
+ "type": "object",
+ "properties": {
+ "location": {
+ "externalDocs": {
+ "url": "https://cloud.google.com/vertex-ai/generative-ai/docs/learn/locations"
+ },
+ "description": "The name of the location to use for the inference task.\nRefer to the Google documentation for the list of supported locations.",
+ "type": "string"
+ },
+ "model_id": {
+ "externalDocs": {
+ "url": "https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/text-embeddings-api"
+ },
+ "description": "The name of the model to use for the inference task.\nRefer to the Google documentation for the list of supported models.",
+ "type": "string"
+ },
+ "project_id": {
+ "description": "The name of the project to use for the inference task.",
+ "type": "string"
+ },
+ "rate_limit": {
+ "description": "This setting helps to minimize the number of rate limit errors returned from Google Vertex AI.\nBy default, the `googlevertexai` service sets the number of requests allowed per minute to 30.000.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.RateLimitSetting"
+ }
+ ]
+ },
+ "service_account_json": {
+ "description": "A valid service account in JSON format for the Google Vertex AI API.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "location",
+ "model_id",
+ "project_id",
+ "service_account_json"
+ ]
+ },
+ "inference._types.GoogleVertexAITaskSettings": {
+ "type": "object",
+ "properties": {
+ "auto_truncate": {
+ "description": "For a `text_embedding` task, truncate inputs longer than the maximum token length automatically.",
+ "type": "boolean"
+ },
+ "top_n": {
+ "description": "For a `rerank` task, the number of the top N documents that should be returned.",
+ "type": "number"
+ }
+ }
+ },
+ "inference._types.InferenceEndpointInfoGoogleVertexAI": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpoint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inference_id": {
+ "description": "The inference Id",
+ "type": "string"
+ },
+ "task_type": {
+ "description": "The task type",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.TaskTypeGoogleVertexAI"
+ }
+ ]
+ }
+ },
+ "required": [
+ "inference_id",
+ "task_type"
+ ]
+ }
+ ]
+ },
+ "inference._types.TaskTypeGoogleVertexAI": {
+ "type": "string",
+ "enum": [
+ "text_embedding",
+ "rerank"
+ ]
+ },
+ "inference._types.HuggingFaceTaskType": {
+ "type": "string",
+ "enum": [
+ "chat_completion",
+ "completion",
+ "rerank",
+ "text_embedding"
+ ]
+ },
+ "inference._types.HuggingFaceServiceType": {
+ "type": "string",
+ "enum": [
+ "hugging_face"
+ ]
+ },
+ "inference._types.HuggingFaceServiceSettings": {
+ "type": "object",
+ "properties": {
+ "api_key": {
+ "externalDocs": {
+ "url": "https://huggingface.co/settings/tokens"
+ },
+ "description": "A valid access token for your HuggingFace account.\nYou can create or find your access tokens on the HuggingFace settings page.\n\nIMPORTANT: You need to provide the API key only once, during the inference model creation.\nThe get inference endpoint API does not retrieve your API key.\nAfter creating the inference model, you cannot change the associated API key.\nIf you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key.",
+ "type": "string"
+ },
+ "rate_limit": {
+ "description": "This setting helps to minimize the number of rate limit errors returned from Hugging Face.\nBy default, the `hugging_face` service sets the number of requests allowed per minute to 3000 for all supported tasks.\nHugging Face does not publish a universal rate limit — actual limits may vary.\nIt is recommended to adjust this value based on the capacity and limits of your specific deployment environment.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.RateLimitSetting"
+ }
+ ]
+ },
+ "url": {
+ "externalDocs": {
+ "url": "https://huggingface.co/docs/inference-providers/en/tasks/chat-completion#conversational-large-language-models-llms"
+ },
+ "description": "The URL endpoint to use for the requests.\nFor `completion` and `chat_completion` tasks, the deployed model must be compatible with the Hugging Face Chat Completion interface (see the linked external documentation for details). The endpoint URL for the request must include `/v1/chat/completions`.\nIf the model supports the OpenAI Chat Completion schema, a toggle should appear in the interface. Enabling this toggle doesn't change any model behavior, it reveals the full endpoint URL needed (which should include `/v1/chat/completions`) when configuring the inference endpoint in Elasticsearch. If the model doesn't support this schema, the toggle may not be shown.",
+ "type": "string"
+ },
+ "model_id": {
+ "description": "The name of the HuggingFace model to use for the inference task.\nFor `completion` and `chat_completion` tasks, this field is optional but may be required for certain models — particularly when using serverless inference endpoints.\nFor the `text_embedding` task, this field should not be included. Otherwise, the request will fail.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "api_key",
+ "url"
+ ]
+ },
+ "inference._types.HuggingFaceTaskSettings": {
+ "type": "object",
+ "properties": {
+ "return_documents": {
+ "description": "For a `rerank` task, return doc text within the results.",
+ "type": "boolean"
+ },
+ "top_n": {
+ "description": "For a `rerank` task, the number of most relevant documents to return.\nIt defaults to the number of the documents.",
+ "type": "number"
+ }
+ }
+ },
+ "inference._types.InferenceEndpointInfoHuggingFace": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpoint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inference_id": {
+ "description": "The inference Id",
+ "type": "string"
+ },
+ "task_type": {
+ "description": "The task type",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.TaskTypeHuggingFace"
+ }
+ ]
+ }
+ },
+ "required": [
+ "inference_id",
+ "task_type"
+ ]
+ }
+ ]
+ },
+ "inference._types.TaskTypeHuggingFace": {
+ "type": "string",
+ "enum": [
+ "chat_completion",
+ "completion",
+ "rerank",
+ "text_embedding"
+ ]
+ },
+ "inference._types.JinaAITaskType": {
+ "type": "string",
+ "enum": [
+ "rerank",
+ "text_embedding"
+ ]
+ },
+ "inference._types.JinaAIServiceType": {
+ "type": "string",
+ "enum": [
+ "jinaai"
+ ]
+ },
+ "inference._types.JinaAIServiceSettings": {
+ "type": "object",
+ "properties": {
+ "api_key": {
+ "externalDocs": {
+ "url": "https://jina.ai/embeddings/"
+ },
+ "description": "A valid API key of your JinaAI account.\n\nIMPORTANT: You need to provide the API key only once, during the inference model creation.\nThe get inference endpoint API does not retrieve your API key.\nAfter creating the inference model, you cannot change the associated API key.\nIf you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key.",
+ "type": "string"
+ },
+ "model_id": {
+ "description": "The name of the model to use for the inference task.\nFor a `rerank` task, it is required.\nFor a `text_embedding` task, it is optional.",
+ "type": "string"
+ },
+ "rate_limit": {
+ "externalDocs": {
+ "url": "https://jina.ai/contact-sales/#rate-limit"
+ },
+ "description": "This setting helps to minimize the number of rate limit errors returned from JinaAI.\nBy default, the `jinaai` service sets the number of requests allowed per minute to 2000 for all task types.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.RateLimitSetting"
+ }
+ ]
+ },
+ "similarity": {
+ "description": "For a `text_embedding` task, the similarity measure. One of cosine, dot_product, l2_norm.\nThe default values varies with the embedding type.\nFor example, a float embedding type uses a `dot_product` similarity measure by default.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.JinaAISimilarityType"
+ }
+ ]
+ }
+ },
+ "required": [
+ "api_key"
+ ]
+ },
+ "inference._types.JinaAISimilarityType": {
+ "type": "string",
+ "enum": [
+ "cosine",
+ "dot_product",
+ "l2_norm"
+ ]
+ },
+ "inference._types.JinaAITaskSettings": {
+ "type": "object",
+ "properties": {
+ "return_documents": {
+ "description": "For a `rerank` task, return the doc text within the results.",
+ "type": "boolean"
+ },
+ "task": {
+ "description": "For a `text_embedding` task, the task passed to the model.\nValid values are:\n\n* `classification`: Use it for embeddings passed through a text classifier.\n* `clustering`: Use it for the embeddings run through a clustering algorithm.\n* `ingest`: Use it for storing document embeddings in a vector database.\n* `search`: Use it for storing embeddings of search queries run against a vector database to find relevant documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.JinaAITextEmbeddingTask"
+ }
+ ]
+ },
+ "top_n": {
+ "description": "For a `rerank` task, the number of most relevant documents to return.\nIt defaults to the number of the documents.\nIf this inference endpoint is used in a `text_similarity_reranker` retriever query and `top_n` is set, it must be greater than or equal to `rank_window_size` in the query.",
+ "type": "number"
+ }
+ }
+ },
+ "inference._types.JinaAITextEmbeddingTask": {
+ "type": "string",
+ "enum": [
+ "classification",
+ "clustering",
+ "ingest",
+ "search"
+ ]
+ },
+ "inference._types.InferenceEndpointInfoJinaAi": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpoint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inference_id": {
+ "description": "The inference Id",
+ "type": "string"
+ },
+ "task_type": {
+ "description": "The task type",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.TaskTypeJinaAi"
+ }
+ ]
+ }
+ },
+ "required": [
+ "inference_id",
+ "task_type"
+ ]
+ }
+ ]
+ },
+ "inference._types.TaskTypeJinaAi": {
+ "type": "string",
+ "enum": [
+ "text_embedding",
+ "rerank"
+ ]
+ },
+ "inference._types.LlamaTaskType": {
+ "type": "string",
+ "enum": [
+ "text_embedding",
+ "completion",
+ "chat_completion"
+ ]
+ },
+ "inference._types.LlamaServiceType": {
+ "type": "string",
+ "enum": [
+ "llama"
+ ]
+ },
+ "inference._types.LlamaServiceSettings": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "description": "The URL endpoint of the Llama stack endpoint.\nURL must contain:\n* For `text_embedding` task - `/v1/inference/embeddings`.\n* For `completion` and `chat_completion` tasks - `/v1/openai/v1/chat/completions`.",
+ "type": "string"
+ },
+ "model_id": {
+ "externalDocs": {
+ "url": "https://llama-stack.readthedocs.io/en/latest/references/llama_cli_reference/download_models.html/"
+ },
+ "description": "The name of the model to use for the inference task.\nRefer to the Llama downloading models documentation for different ways of getting a list of available models and downloading them.\nService has been tested and confirmed to be working with the following models:\n* For `text_embedding` task - `all-MiniLM-L6-v2`.\n* For `completion` and `chat_completion` tasks - `llama3.2:3b`.",
+ "type": "string"
+ },
+ "max_input_tokens": {
+ "description": "For a `text_embedding` task, the maximum number of tokens per input before chunking occurs.",
+ "type": "number"
+ },
+ "similarity": {
+ "description": "For a `text_embedding` task, the similarity measure. One of cosine, dot_product, l2_norm.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.LlamaSimilarityType"
+ }
+ ]
+ },
+ "rate_limit": {
+ "description": "This setting helps to minimize the number of rate limit errors returned from the Llama API.\nBy default, the `llama` service sets the number of requests allowed per minute to 3000.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.RateLimitSetting"
+ }
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "model_id"
+ ]
+ },
+ "inference._types.LlamaSimilarityType": {
+ "type": "string",
+ "enum": [
+ "cosine",
+ "dot_product",
+ "l2_norm"
+ ]
+ },
+ "inference._types.InferenceEndpointInfoLlama": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpoint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inference_id": {
+ "description": "The inference Id",
+ "type": "string"
+ },
+ "task_type": {
+ "description": "The task type",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.TaskTypeLlama"
+ }
+ ]
+ }
+ },
+ "required": [
+ "inference_id",
+ "task_type"
+ ]
+ }
+ ]
+ },
+ "inference._types.TaskTypeLlama": {
+ "type": "string",
+ "enum": [
+ "text_embedding",
+ "chat_completion",
+ "completion"
+ ]
+ },
+ "inference._types.MistralTaskType": {
+ "type": "string",
+ "enum": [
+ "text_embedding",
+ "completion",
+ "chat_completion"
+ ]
+ },
+ "inference._types.MistralServiceType": {
+ "type": "string",
+ "enum": [
+ "mistral"
+ ]
+ },
+ "inference._types.MistralServiceSettings": {
+ "type": "object",
+ "properties": {
+ "api_key": {
+ "externalDocs": {
+ "url": "https://console.mistral.ai/api-keys/"
+ },
+ "description": "A valid API key of your Mistral account.\nYou can find your Mistral API keys or you can create a new one on the API Keys page.\n\nIMPORTANT: You need to provide the API key only once, during the inference model creation.\nThe get inference endpoint API does not retrieve your API key.\nAfter creating the inference model, you cannot change the associated API key.\nIf you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key.",
+ "type": "string"
+ },
+ "max_input_tokens": {
+ "description": "The maximum number of tokens per input before chunking occurs.",
+ "type": "number"
+ },
+ "model": {
+ "externalDocs": {
+ "url": "https://docs.mistral.ai/getting-started/models/"
+ },
+ "description": "The name of the model to use for the inference task.\nRefer to the Mistral models documentation for the list of available models.",
+ "type": "string"
+ },
+ "rate_limit": {
+ "description": "This setting helps to minimize the number of rate limit errors returned from the Mistral API.\nBy default, the `mistral` service sets the number of requests allowed per minute to 240.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.RateLimitSetting"
+ }
+ ]
+ }
+ },
+ "required": [
+ "api_key",
+ "model"
+ ]
+ },
+ "inference._types.InferenceEndpointInfoMistral": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpoint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inference_id": {
+ "description": "The inference Id",
+ "type": "string"
+ },
+ "task_type": {
+ "description": "The task type",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.TaskTypeMistral"
+ }
+ ]
+ }
+ },
+ "required": [
+ "inference_id",
+ "task_type"
+ ]
+ }
+ ]
+ },
+ "inference._types.TaskTypeMistral": {
+ "type": "string",
+ "enum": [
+ "text_embedding",
+ "chat_completion",
+ "completion"
+ ]
+ },
+ "inference._types.OpenAITaskType": {
+ "type": "string",
+ "enum": [
+ "chat_completion",
+ "completion",
+ "text_embedding"
+ ]
+ },
+ "inference._types.OpenAIServiceType": {
+ "type": "string",
+ "enum": [
+ "openai"
+ ]
+ },
+ "inference._types.OpenAIServiceSettings": {
+ "type": "object",
+ "properties": {
+ "api_key": {
+ "externalDocs": {
+ "url": "https://platform.openai.com/api-keys"
+ },
+ "description": "A valid API key of your OpenAI account.\nYou can find your OpenAI API keys in your OpenAI account under the API keys section.\n\nIMPORTANT: You need to provide the API key only once, during the inference model creation.\nThe get inference endpoint API does not retrieve your API key.\nAfter creating the inference model, you cannot change the associated API key.\nIf you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key.",
+ "type": "string"
+ },
+ "dimensions": {
+ "description": "The number of dimensions the resulting output embeddings should have.\nIt is supported only in `text-embedding-3` and later models.\nIf it is not set, the OpenAI defined default for the model is used.",
+ "type": "number"
+ },
+ "model_id": {
+ "externalDocs": {
+ "url": "https://platform.openai.com/docs/guides/embeddings/what-are-embeddings"
+ },
+ "description": "The name of the model to use for the inference task.\nRefer to the OpenAI documentation for the list of available text embedding models.",
+ "type": "string"
+ },
+ "organization_id": {
+ "description": "The unique identifier for your organization.\nYou can find the Organization ID in your OpenAI account under *Settings > Organizations*.",
+ "type": "string"
+ },
+ "rate_limit": {
+ "description": "This setting helps to minimize the number of rate limit errors returned from OpenAI.\nThe `openai` service sets a default number of requests allowed per minute depending on the task type.\nFor `text_embedding`, it is set to `3000`.\nFor `completion`, it is set to `500`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.RateLimitSetting"
+ }
+ ]
+ },
+ "url": {
+ "description": "The URL endpoint to use for the requests.\nIt can be changed for testing purposes.",
+ "default": "https://api.openai.com/v1/embeddings.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "api_key",
+ "model_id"
+ ]
+ },
+ "inference._types.OpenAITaskSettings": {
+ "type": "object",
+ "properties": {
+ "user": {
+ "description": "For a `completion` or `text_embedding` task, specify the user issuing the request.\nThis information can be used for abuse detection.",
+ "type": "string"
+ }
+ }
+ },
+ "inference._types.InferenceEndpointInfoOpenAI": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpoint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inference_id": {
+ "description": "The inference Id",
+ "type": "string"
+ },
+ "task_type": {
+ "description": "The task type",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.TaskTypeOpenAI"
+ }
+ ]
+ }
+ },
+ "required": [
+ "inference_id",
+ "task_type"
+ ]
+ }
+ ]
+ },
+ "inference._types.TaskTypeOpenAI": {
+ "type": "string",
+ "enum": [
+ "text_embedding",
+ "chat_completion",
+ "completion"
+ ]
+ },
+ "inference._types.VoyageAITaskType": {
+ "type": "string",
+ "enum": [
+ "text_embedding",
+ "rerank"
+ ]
+ },
+ "inference._types.VoyageAIServiceType": {
+ "type": "string",
+ "enum": [
+ "voyageai"
+ ]
+ },
+ "inference._types.VoyageAIServiceSettings": {
+ "type": "object",
+ "properties": {
+ "dimensions": {
+ "externalDocs": {
+ "url": "https://docs.voyageai.com/docs/embeddings"
+ },
+ "description": "The number of dimensions for resulting output embeddings.\nThis setting maps to `output_dimension` in the VoyageAI documentation.\nOnly for the `text_embedding` task type.",
+ "type": "number"
+ },
+ "model_id": {
+ "externalDocs": {
+ "url": "https://docs.voyageai.com/docs/reranker"
+ },
+ "description": "The name of the model to use for the inference task.\nRefer to the VoyageAI documentation for the list of available text embedding and rerank models.",
+ "type": "string"
+ },
+ "rate_limit": {
+ "description": "This setting helps to minimize the number of rate limit errors returned from VoyageAI.\nThe `voyageai` service sets a default number of requests allowed per minute depending on the task type.\nFor both `text_embedding` and `rerank`, it is set to `2000`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.RateLimitSetting"
+ }
+ ]
+ },
+ "embedding_type": {
+ "externalDocs": {
+ "url": "https://docs.voyageai.com/docs/embeddings"
+ },
+ "description": "The data type for the embeddings to be returned.\nThis setting maps to `output_dtype` in the VoyageAI documentation.\nPermitted values: float, int8, bit.\n`int8` is a synonym of `byte` in the VoyageAI documentation.\n`bit` is a synonym of `binary` in the VoyageAI documentation.\nOnly for the `text_embedding` task type.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "model_id"
+ ]
+ },
+ "inference._types.VoyageAITaskSettings": {
+ "type": "object",
+ "properties": {
+ "input_type": {
+ "description": "Type of the input text.\nPermitted values: `ingest` (maps to `document` in the VoyageAI documentation), `search` (maps to `query` in the VoyageAI documentation).\nOnly for the `text_embedding` task type.",
+ "type": "string"
+ },
+ "return_documents": {
+ "description": "Whether to return the source documents in the response.\nOnly for the `rerank` task type.",
+ "default": false,
+ "type": "boolean"
+ },
+ "top_k": {
+ "description": "The number of most relevant documents to return.\nIf not specified, the reranking results of all documents will be returned.\nOnly for the `rerank` task type.",
+ "type": "number"
+ },
+ "truncation": {
+ "description": "Whether to truncate the input texts to fit within the context length.",
+ "default": true,
+ "type": "boolean"
+ }
+ }
+ },
+ "inference._types.InferenceEndpointInfoVoyageAI": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpoint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inference_id": {
+ "description": "The inference Id",
+ "type": "string"
+ },
+ "task_type": {
+ "description": "The task type",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.TaskTypeVoyageAI"
+ }
+ ]
+ }
+ },
+ "required": [
+ "inference_id",
+ "task_type"
+ ]
+ }
+ ]
+ },
+ "inference._types.TaskTypeVoyageAI": {
+ "type": "string",
+ "enum": [
+ "text_embedding",
+ "rerank"
+ ]
+ },
+ "inference._types.WatsonxTaskType": {
+ "type": "string",
+ "enum": [
+ "text_embedding",
+ "chat_completion",
+ "completion"
+ ]
+ },
+ "inference._types.WatsonxServiceType": {
+ "type": "string",
+ "enum": [
+ "watsonxai"
+ ]
+ },
+ "inference._types.WatsonxServiceSettings": {
+ "type": "object",
+ "properties": {
+ "api_key": {
+ "externalDocs": {
+ "url": "https://cloud.ibm.com/iam/apikeys"
+ },
+ "description": "A valid API key of your Watsonx account.\nYou can find your Watsonx API keys or you can create a new one on the API keys page.\n\nIMPORTANT: You need to provide the API key only once, during the inference model creation.\nThe get inference endpoint API does not retrieve your API key.\nAfter creating the inference model, you cannot change the associated API key.\nIf you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key.",
+ "type": "string"
+ },
+ "api_version": {
+ "externalDocs": {
+ "url": "https://cloud.ibm.com/apidocs/watsonx-ai#active-version-dates"
+ },
+ "description": "A version parameter that takes a version date in the format of `YYYY-MM-DD`.\nFor the active version data parameters, refer to the Wastonx documentation.",
+ "type": "string"
+ },
+ "model_id": {
+ "externalDocs": {
+ "url": "https://www.ibm.com/products/watsonx-ai/foundation-models"
+ },
+ "description": "The name of the model to use for the inference task.\nRefer to the IBM Embedding Models section in the Watsonx documentation for the list of available text embedding models.\nRefer to the IBM library - Foundation models in Watsonx.ai.",
+ "type": "string"
+ },
+ "project_id": {
+ "description": "The identifier of the IBM Cloud project to use for the inference task.",
+ "type": "string"
+ },
+ "rate_limit": {
+ "description": "This setting helps to minimize the number of rate limit errors returned from Watsonx.\nBy default, the `watsonxai` service sets the number of requests allowed per minute to 120.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.RateLimitSetting"
+ }
+ ]
+ },
+ "url": {
+ "description": "The URL of the inference endpoint that you created on Watsonx.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "api_key",
+ "api_version",
+ "model_id",
+ "project_id",
+ "url"
+ ]
+ },
+ "inference._types.InferenceEndpointInfoWatsonx": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpoint"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inference_id": {
+ "description": "The inference Id",
+ "type": "string"
+ },
+ "task_type": {
+ "description": "The task type",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.TaskTypeWatsonx"
+ }
+ ]
+ }
+ },
+ "required": [
+ "inference_id",
+ "task_type"
+ ]
+ }
+ ]
+ },
+ "inference._types.TaskTypeWatsonx": {
+ "type": "string",
+ "enum": [
+ "text_embedding",
+ "chat_completion",
+ "completion"
+ ]
+ },
+ "inference._types.RerankedInferenceResult": {
+ "description": "Defines the response for a rerank request.",
+ "type": "object",
+ "properties": {
+ "rerank": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/inference._types.RankedDocument"
+ }
+ }
+ },
+ "required": [
+ "rerank"
+ ]
+ },
+ "inference._types.SparseEmbeddingInferenceResult": {
+ "description": "The response format for the sparse embedding request.",
+ "type": "object",
+ "properties": {
+ "sparse_embedding": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/inference._types.SparseEmbeddingResult"
+ }
+ }
+ },
+ "required": [
+ "sparse_embedding"
+ ]
+ },
+ "inference._types.TextEmbeddingInferenceResult": {
+ "description": "TextEmbeddingInferenceResult is an aggregation of mutually exclusive text_embedding variants",
+ "type": "object",
+ "properties": {
+ "text_embedding_bytes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/inference._types.TextEmbeddingByteResult"
+ }
+ },
+ "text_embedding_bits": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/inference._types.TextEmbeddingByteResult"
+ }
+ },
+ "text_embedding": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/inference._types.TextEmbeddingResult"
+ }
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "_types.ElasticsearchVersionInfo": {
+ "type": "object",
+ "properties": {
+ "build_date": {
+ "description": "The Elasticsearch Git commit's date.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "build_flavor": {
+ "description": "The build flavor. For example, `default`.",
+ "type": "string"
+ },
+ "build_hash": {
+ "description": "The Elasticsearch Git commit's SHA hash.",
+ "type": "string"
+ },
+ "build_snapshot": {
+ "description": "Indicates whether the Elasticsearch build was a snapshot.",
+ "type": "boolean"
+ },
+ "build_type": {
+ "description": "The build type that corresponds to how Elasticsearch was installed.\nFor example, `docker`, `rpm`, or `tar`.",
+ "type": "string"
+ },
+ "lucene_version": {
+ "description": "The version number of Elasticsearch's underlying Lucene software.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ },
+ "minimum_index_compatibility_version": {
+ "description": "The minimum index version with which the responding node can read from disk.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ },
+ "minimum_wire_compatibility_version": {
+ "description": "The minimum node version with which the responding node can communicate.\nAlso the minimum version from which you can perform a rolling upgrade.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ },
+ "number": {
+ "description": "The Elasticsearch version number.\n\n::: IMPORTANT: For Serverless deployments, this static value is always `8.11.0` and is used solely for backward compatibility with legacy clients.\n Serverless environments are versionless and automatically upgraded, so this value can be safely ignored.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "build_date",
+ "build_flavor",
+ "build_hash",
+ "build_snapshot",
+ "build_type",
+ "lucene_version",
+ "minimum_index_compatibility_version",
+ "minimum_wire_compatibility_version",
+ "number"
+ ]
+ },
+ "ingest._types.Pipeline": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Description of the ingest pipeline.",
+ "type": "string"
+ },
+ "on_failure": {
+ "description": "Processors to run immediately after a processor failure.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ingest._types.ProcessorContainer"
+ }
+ },
+ "processors": {
+ "description": "Processors used to perform transformations on documents before indexing.\nProcessors run sequentially in the order specified.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ingest._types.ProcessorContainer"
+ }
+ },
+ "version": {
+ "description": "Version number used by external systems to track ingest pipelines.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ }
+ ]
+ },
+ "deprecated": {
+ "description": "Marks this ingest pipeline as deprecated.\nWhen a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning.",
+ "default": false,
+ "type": "boolean"
+ },
+ "_meta": {
+ "description": "Arbitrary metadata about the ingest pipeline. This map is not automatically generated by Elasticsearch.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ },
+ "created_date": {
+ "description": "Date and time when the pipeline was created. Only returned if the `human` query parameter is `true`.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "created_date_millis": {
+ "description": "Date and time when the pipeline was created, in milliseconds since the epoch.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "modified_date": {
+ "description": "Date and time when the pipeline was last modified. Only returned if the `human` query parameter is `true`.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "modified_date_millis": {
+ "description": "Date and time when the pipeline was last modified, in milliseconds since the epoch.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ }
+ }
+ },
+ "ingest._types.ProcessorContainer": {
+ "type": "object",
+ "properties": {
+ "append": {
+ "description": "Appends one or more values to an existing array if the field already exists and it is an array.\nConverts a scalar to an array and appends one or more values to it if the field exists and it is a scalar.\nCreates an array containing the provided values if the field doesn’t exist.\nAccepts a single value or an array of values.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.AppendProcessor"
+ }
+ ]
+ },
+ "attachment": {
+ "description": "The attachment processor lets Elasticsearch extract file attachments in common formats (such as PPT, XLS, and PDF) by using the Apache text extraction library Tika.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.AttachmentProcessor"
+ }
+ ]
+ },
+ "bytes": {
+ "description": "Converts a human readable byte value (for example `1kb`) to its value in bytes (for example `1024`).\nIf the field is an array of strings, all members of the array will be converted.\nSupported human readable units are \"b\", \"kb\", \"mb\", \"gb\", \"tb\", \"pb\" case insensitive.\nAn error will occur if the field is not a supported format or resultant value exceeds 2^63.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.BytesProcessor"
+ }
+ ]
+ },
+ "circle": {
+ "description": "Converts circle definitions of shapes to regular polygons which approximate them.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.CircleProcessor"
+ }
+ ]
+ },
+ "community_id": {
+ "description": "Computes the Community ID for network flow data as defined in the\nCommunity ID Specification. You can use a community ID to correlate network\nevents related to a single flow.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.CommunityIDProcessor"
+ }
+ ]
+ },
+ "convert": {
+ "description": "Converts a field in the currently ingested document to a different type, such as converting a string to an integer.\nIf the field value is an array, all members will be converted.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ConvertProcessor"
+ }
+ ]
+ },
+ "csv": {
+ "description": "Extracts fields from CSV line out of a single text field within a document.\nAny empty field in CSV will be skipped.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.CsvProcessor"
+ }
+ ]
+ },
+ "date": {
+ "description": "Parses dates from fields, and then uses the date or timestamp as the timestamp for the document.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.DateProcessor"
+ }
+ ]
+ },
+ "date_index_name": {
+ "description": "The purpose of this processor is to point documents to the right time based index based on a date or timestamp field in a document by using the date math index name support.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.DateIndexNameProcessor"
+ }
+ ]
+ },
+ "dissect": {
+ "description": "Extracts structured fields out of a single text field by matching the text field against a delimiter-based pattern.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.DissectProcessor"
+ }
+ ]
+ },
+ "dot_expander": {
+ "description": "Expands a field with dots into an object field.\nThis processor allows fields with dots in the name to be accessible by other processors in the pipeline.\nOtherwise these fields can’t be accessed by any processor.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.DotExpanderProcessor"
+ }
+ ]
+ },
+ "drop": {
+ "description": "Drops the document without raising any errors.\nThis is useful to prevent the document from getting indexed based on some condition.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.DropProcessor"
+ }
+ ]
+ },
+ "enrich": {
+ "description": "The `enrich` processor can enrich documents with data from another index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.EnrichProcessor"
+ }
+ ]
+ },
+ "fail": {
+ "description": "Raises an exception.\nThis is useful for when you expect a pipeline to fail and want to relay a specific message to the requester.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.FailProcessor"
+ }
+ ]
+ },
+ "fingerprint": {
+ "description": "Computes a hash of the document’s content. You can use this hash for\ncontent fingerprinting.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.FingerprintProcessor"
+ }
+ ]
+ },
+ "foreach": {
+ "description": "Runs an ingest processor on each element of an array or object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ForeachProcessor"
+ }
+ ]
+ },
+ "ip_location": {
+ "description": "Currently an undocumented alias for GeoIP Processor.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.IpLocationProcessor"
+ }
+ ]
+ },
+ "geo_grid": {
+ "description": "Converts geo-grid definitions of grid tiles or cells to regular bounding boxes or polygons which describe their shape.\nThis is useful if there is a need to interact with the tile shapes as spatially indexable fields.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.GeoGridProcessor"
+ }
+ ]
+ },
+ "geoip": {
+ "description": "The `geoip` processor adds information about the geographical location of an IPv4 or IPv6 address.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.GeoIpProcessor"
+ }
+ ]
+ },
+ "grok": {
+ "description": "Extracts structured fields out of a single text field within a document.\nYou choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.GrokProcessor"
+ }
+ ]
+ },
+ "gsub": {
+ "description": "Converts a string field by applying a regular expression and a replacement.\nIf the field is an array of string, all members of the array will be converted.\nIf any non-string values are encountered, the processor will throw an exception.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.GsubProcessor"
+ }
+ ]
+ },
+ "html_strip": {
+ "description": "Removes HTML tags from the field.\nIf the field is an array of strings, HTML tags will be removed from all members of the array.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.HtmlStripProcessor"
+ }
+ ]
+ },
+ "inference": {
+ "description": "Uses a pre-trained data frame analytics model or a model deployed for natural language processing tasks to infer against the data that is being ingested in the pipeline.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.InferenceProcessor"
+ }
+ ]
+ },
+ "join": {
+ "description": "Joins each element of an array into a single string using a separator character between each element.\nThrows an error when the field is not an array.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.JoinProcessor"
+ }
+ ]
+ },
+ "json": {
+ "description": "Converts a JSON string into a structured JSON object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.JsonProcessor"
+ }
+ ]
+ },
+ "kv": {
+ "description": "This processor helps automatically parse messages (or specific event fields) which are of the `foo=bar` variety.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.KeyValueProcessor"
+ }
+ ]
+ },
+ "lowercase": {
+ "description": "Converts a string to its lowercase equivalent.\nIf the field is an array of strings, all members of the array will be converted.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.LowercaseProcessor"
+ }
+ ]
+ },
+ "network_direction": {
+ "description": "Calculates the network direction given a source IP address, destination IP\naddress, and a list of internal networks.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.NetworkDirectionProcessor"
+ }
+ ]
+ },
+ "pipeline": {
+ "description": "Executes another pipeline.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.PipelineProcessor"
+ }
+ ]
+ },
+ "redact": {
+ "description": "The Redact processor uses the Grok rules engine to obscure text in the input document matching the given Grok patterns.\nThe processor can be used to obscure Personal Identifying Information (PII) by configuring it to detect known patterns such as email or IP addresses.\nText that matches a Grok pattern is replaced with a configurable string such as `` where an email address is matched or simply replace all matches with the text `` if preferred.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.RedactProcessor"
+ }
+ ]
+ },
+ "registered_domain": {
+ "description": "Extracts the registered domain (also known as the effective top-level\ndomain or eTLD), sub-domain, and top-level domain from a fully qualified\ndomain name (FQDN). Uses the registered domains defined in the Mozilla\nPublic Suffix List.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.RegisteredDomainProcessor"
+ }
+ ]
+ },
+ "remove": {
+ "description": "Removes existing fields.\nIf one field doesn’t exist, an exception will be thrown.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.RemoveProcessor"
+ }
+ ]
+ },
+ "rename": {
+ "description": "Renames an existing field.\nIf the field doesn’t exist or the new name is already used, an exception will be thrown.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.RenameProcessor"
+ }
+ ]
+ },
+ "reroute": {
+ "description": "Routes a document to another target index or data stream.\nWhen setting the `destination` option, the target is explicitly specified and the dataset and namespace options can’t be set.\nWhen the `destination` option is not set, this processor is in a data stream mode. Note that in this mode, the reroute processor can only be used on data streams that follow the data stream naming scheme.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.RerouteProcessor"
+ }
+ ]
+ },
+ "script": {
+ "description": "Runs an inline or stored script on incoming documents.\nThe script runs in the `ingest` context.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ScriptProcessor"
+ }
+ ]
+ },
+ "set": {
+ "description": "Adds a field with the specified value.\nIf the field already exists, its value will be replaced with the provided one.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.SetProcessor"
+ }
+ ]
+ },
+ "set_security_user": {
+ "description": "Sets user-related details (such as `username`, `roles`, `email`, `full_name`, `metadata`, `api_key`, `realm` and `authentication_type`) from the current authenticated user to the current document by pre-processing the ingest.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.SetSecurityUserProcessor"
+ }
+ ]
+ },
+ "sort": {
+ "description": "Sorts the elements of an array ascending or descending.\nHomogeneous arrays of numbers will be sorted numerically, while arrays of strings or heterogeneous arrays of strings + numbers will be sorted lexicographically.\nThrows an error when the field is not an array.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.SortProcessor"
+ }
+ ]
+ },
+ "split": {
+ "description": "Splits a field into an array using a separator character.\nOnly works on string fields.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.SplitProcessor"
+ }
+ ]
+ },
+ "terminate": {
+ "description": "Terminates the current ingest pipeline, causing no further processors to be run.\nThis will normally be executed conditionally, using the `if` option.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.TerminateProcessor"
+ }
+ ]
+ },
+ "trim": {
+ "description": "Trims whitespace from a field.\nIf the field is an array of strings, all members of the array will be trimmed.\nThis only works on leading and trailing whitespace.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.TrimProcessor"
+ }
+ ]
+ },
+ "uppercase": {
+ "description": "Converts a string to its uppercase equivalent.\nIf the field is an array of strings, all members of the array will be converted.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.UppercaseProcessor"
+ }
+ ]
+ },
+ "urldecode": {
+ "description": "URL-decodes a string.\nIf the field is an array of strings, all members of the array will be decoded.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.UrlDecodeProcessor"
+ }
+ ]
+ },
+ "uri_parts": {
+ "description": "Parses a Uniform Resource Identifier (URI) string and extracts its components as an object.\nThis URI object includes properties for the URI’s domain, path, fragment, port, query, scheme, user info, username, and password.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.UriPartsProcessor"
+ }
+ ]
+ },
+ "user_agent": {
+ "description": "The `user_agent` processor extracts details from the user agent string a browser sends with its web requests.\nThis processor adds this information by default under the `user_agent` field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.UserAgentProcessor"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "ingest._types.AppendProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The field to be appended to.\nSupports template snippets.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "value": {
+ "description": "The value to be appended. Supports template snippets.",
+ "oneOf": [
+ {
+ "type": "object"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ }
+ ]
+ },
+ "allow_duplicates": {
+ "description": "If `false`, the processor does not append values already present in the field.",
+ "default": true,
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "field",
+ "value"
+ ]
+ }
+ ]
+ },
+ "ingest._types.ProcessorBase": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Description of the processor.\nUseful for describing the purpose of the processor or its configuration.",
+ "type": "string"
+ },
+ "if": {
+ "description": "Conditionally execute the processor.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ },
+ "ignore_failure": {
+ "description": "Ignore failures for the processor.",
+ "type": "boolean"
+ },
+ "on_failure": {
+ "description": "Handle failures for the processor.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ingest._types.ProcessorContainer"
+ }
+ },
+ "tag": {
+ "description": "Identifier for the processor.\nUseful for debugging and metrics.",
+ "type": "string"
+ }
+ }
+ },
+ "ingest._types.AttachmentProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The field to get the base64 encoded field from.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If `true` and field does not exist, the processor quietly exits without modifying the document.",
+ "default": false,
+ "type": "boolean"
+ },
+ "indexed_chars": {
+ "description": "The number of chars being used for extraction to prevent huge fields.\nUse `-1` for no limit.",
+ "default": 100000.0,
+ "type": "number"
+ },
+ "indexed_chars_field": {
+ "description": "Field name from which you can overwrite the number of chars being used for extraction.",
+ "default": "null",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "properties": {
+ "description": "Array of properties to select to be stored.\nCan be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "target_field": {
+ "description": "The field that will hold the attachment information.",
+ "default": "attachment",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "remove_binary": {
+ "description": "If true, the binary field will be removed from the document",
+ "default": false,
+ "type": "boolean"
+ },
+ "resource_name": {
+ "description": "Field containing the name of the resource to decode.\nIf specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "field"
+ ]
+ }
+ ]
+ },
+ "ingest._types.BytesProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The field to convert.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.",
+ "default": false,
+ "type": "boolean"
+ },
+ "target_field": {
+ "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.",
+ "default": "field",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field"
+ ]
+ }
+ ]
+ },
+ "ingest._types.CircleProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "error_distance": {
+ "description": "The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for `geo_shape`, unit-less for `shape`).",
+ "type": "number"
+ },
+ "field": {
+ "description": "The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.",
+ "default": false,
+ "type": "boolean"
+ },
+ "shape_type": {
+ "description": "Which field mapping type is to be used when processing the circle: `geo_shape` or `shape`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ShapeType"
+ }
+ ]
+ },
+ "target_field": {
+ "description": "The field to assign the polygon shape to\nBy default, the field is updated in-place.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "error_distance",
+ "field",
+ "shape_type"
+ ]
+ }
+ ]
+ },
+ "ingest._types.ShapeType": {
+ "type": "string",
+ "enum": [
+ "geo_shape",
+ "shape"
+ ]
+ },
+ "ingest._types.CommunityIDProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "source_ip": {
+ "description": "Field containing the source IP address.",
+ "default": "source.ip",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "source_port": {
+ "description": "Field containing the source port.",
+ "default": "source.port",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "destination_ip": {
+ "description": "Field containing the destination IP address.",
+ "default": "destination.ip",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "destination_port": {
+ "description": "Field containing the destination port.",
+ "default": "destination.port",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "iana_number": {
+ "description": "Field containing the IANA number.",
+ "default": "network.iana_number",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "icmp_type": {
+ "description": "Field containing the ICMP type.",
+ "default": "icmp.type",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "icmp_code": {
+ "description": "Field containing the ICMP code.",
+ "default": "icmp.code",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "transport": {
+ "description": "Field containing the transport protocol name or number. Used only when the\niana_number field is not present. The following protocol names are currently\nsupported: eigrp, gre, icmp, icmpv6, igmp, ipv6-icmp, ospf, pim, sctp, tcp, udp",
+ "default": "network.transport",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "target_field": {
+ "description": "Output field for the community ID.",
+ "default": "network.community_id",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "seed": {
+ "description": "Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The\nseed can prevent hash collisions between network domains, such as a staging\nand production network that use the same addressing scheme.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "ignore_missing": {
+ "description": "If true and any required fields are missing, the processor quietly exits\nwithout modifying the document.",
+ "default": true,
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "ingest._types.ConvertProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The field whose value is to be converted.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.",
+ "default": false,
+ "type": "boolean"
+ },
+ "target_field": {
+ "description": "The field to assign the converted value to.\nBy default, the `field` is updated in-place.",
+ "default": "field",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "type": {
+ "description": "The type to convert the existing value to.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ConvertType"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field",
+ "type"
+ ]
+ }
+ ]
+ },
+ "ingest._types.ConvertType": {
+ "type": "string",
+ "enum": [
+ "integer",
+ "long",
+ "double",
+ "float",
+ "boolean",
+ "ip",
+ "string",
+ "auto"
+ ]
+ },
+ "ingest._types.CsvProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "empty_value": {
+ "description": "Value used to fill empty fields.\nEmpty fields are skipped if this is not provided.\nAn empty field is one with no value (2 consecutive separators) or empty quotes (`\"\"`).",
+ "type": "object"
+ },
+ "field": {
+ "description": "The field to extract data from.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.",
+ "type": "boolean"
+ },
+ "quote": {
+ "description": "Quote used in CSV, has to be single character string.",
+ "default": "\"",
+ "type": "string"
+ },
+ "separator": {
+ "description": "Separator used in CSV, has to be single character string.",
+ "default": ",",
+ "type": "string"
+ },
+ "target_fields": {
+ "description": "The array of fields to assign extracted values to.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ },
+ "trim": {
+ "description": "Trim whitespaces in unquoted fields.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "field",
+ "target_fields"
+ ]
+ }
+ ]
+ },
+ "ingest._types.DateProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The field to get the date from.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "formats": {
+ "description": "An array of the expected date formats.\nCan be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "locale": {
+ "description": "The locale to use when parsing the date, relevant when parsing month names or week days.\nSupports template snippets.",
+ "default": "ENGLISH",
+ "type": "string"
+ },
+ "target_field": {
+ "description": "The field that will hold the parsed date.",
+ "default": "`@timestamp`",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "timezone": {
+ "description": "The timezone to use when parsing the date.\nSupports template snippets.",
+ "default": "UTC",
+ "type": "string"
+ },
+ "output_format": {
+ "description": "The format to use when writing the date to target_field. Must be a valid\njava time pattern.",
+ "default": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
+ "type": "string"
+ }
+ },
+ "required": [
+ "field",
+ "formats"
+ ]
+ }
+ ]
+ },
+ "ingest._types.DateIndexNameProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "date_formats": {
+ "description": "An array of the expected date formats for parsing dates / timestamps in the document being preprocessed.\nCan be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "date_rounding": {
+ "description": "How to round the date when formatting the date into the index name. Valid values are:\n`y` (year), `M` (month), `w` (week), `d` (day), `h` (hour), `m` (minute) and `s` (second).\nSupports template snippets.",
+ "type": "string"
+ },
+ "field": {
+ "description": "The field to get the date or timestamp from.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "index_name_format": {
+ "description": "The format to be used when printing the parsed date into the index name.\nA valid java time pattern is expected here.\nSupports template snippets.",
+ "default": "yyyy-MM-dd",
+ "type": "string"
+ },
+ "index_name_prefix": {
+ "description": "A prefix of the index name to be prepended before the printed date.\nSupports template snippets.",
+ "type": "string"
+ },
+ "locale": {
+ "description": "The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days.",
+ "default": "ENGLISH",
+ "type": "string"
+ },
+ "timezone": {
+ "description": "The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names.",
+ "default": "UTC",
+ "type": "string"
+ }
+ },
+ "required": [
+ "date_rounding",
+ "field"
+ ]
+ }
+ ]
+ },
+ "ingest._types.DissectProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "append_separator": {
+ "description": "The character(s) that separate the appended fields.",
+ "default": "\"\"",
+ "type": "string"
+ },
+ "field": {
+ "description": "The field to dissect.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.",
+ "default": false,
+ "type": "boolean"
+ },
+ "pattern": {
+ "description": "The pattern to apply to the field.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "field",
+ "pattern"
+ ]
+ }
+ ]
+ },
+ "ingest._types.DotExpanderProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The field to expand into an object field.\nIf set to `*`, all top-level fields will be expanded.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "override": {
+ "description": "Controls the behavior when there is already an existing nested object that conflicts with the expanded field.\nWhen `false`, the processor will merge conflicts by combining the old and the new values into an array.\nWhen `true`, the value from the expanded field will overwrite the existing value.",
+ "default": false,
+ "type": "boolean"
+ },
+ "path": {
+ "description": "The field that contains the field to expand.\nOnly required if the field to expand is part another object field, because the `field` option can only understand leaf fields.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "field"
+ ]
+ }
+ ]
+ },
+ "ingest._types.DropProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "ingest._types.EnrichProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The field in the input document that matches the policies match_field used to retrieve the enrichment data.\nSupports template snippets.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.",
+ "default": false,
+ "type": "boolean"
+ },
+ "max_matches": {
+ "description": "The maximum number of matched documents to include under the configured target field.\nThe `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object.\nIn order to avoid documents getting too large, the maximum allowed value is 128.",
+ "default": 1.0,
+ "type": "number"
+ },
+ "override": {
+ "description": "If processor will update fields with pre-existing non-null-valued field.\nWhen set to `false`, such fields will not be touched.",
+ "default": true,
+ "type": "boolean"
+ },
+ "policy_name": {
+ "description": "The name of the enrich policy to use.",
+ "type": "string"
+ },
+ "shape_relation": {
+ "description": "A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index.\nThis option is only used for `geo_match` enrich policy types.\n\nSupported values include:\n - `intersects`: Return all documents whose `geo_shape` or `geo_point` field intersects the query geometry.\n - `disjoint`: Return all documents whose `geo_shape` or `geo_point` field has nothing in common with the query geometry.\n - `within`: Return all documents whose `geo_shape` or `geo_point` field is within the query geometry.\nLine geometries are not supported.\n - `contains`: Return all documents whose `geo_shape` or `geo_point` field contains the query geometry.\n\n",
+ "default": "INTERSECTS",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.GeoShapeRelation"
+ }
+ ]
+ },
+ "target_field": {
+ "description": "Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.\nSupports template snippets.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field",
+ "policy_name",
+ "target_field"
+ ]
+ }
+ ]
+ },
+ "_types.GeoShapeRelation": {
+ "type": "string",
+ "enum": [
+ "intersects",
+ "disjoint",
+ "within",
+ "contains"
+ ]
+ },
+ "ingest._types.FailProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "The error message thrown by the processor.\nSupports template snippets.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "message"
+ ]
+ }
+ ]
+ },
+ "ingest._types.FingerprintProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "fields": {
+ "description": "Array of fields to include in the fingerprint. For objects, the processor\nhashes both the field key and value. For other fields, the processor hashes\nonly the field value.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ },
+ "target_field": {
+ "description": "Output field for the fingerprint.",
+ "default": "fingerprint",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "salt": {
+ "description": "Salt value for the hash function.",
+ "type": "string"
+ },
+ "method": {
+ "description": "The hash method used to compute the fingerprint. Must be one of MD5, SHA-1,\nSHA-256, SHA-512, or MurmurHash3.",
+ "default": "SHA-1",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.FingerprintDigest"
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If true, the processor ignores any missing fields. If all fields are\nmissing, the processor silently exits without modifying the document.",
+ "default": false,
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "fields"
+ ]
+ }
+ ]
+ },
+ "ingest._types.FingerprintDigest": {
+ "type": "string",
+ "enum": [
+ "MD5",
+ "SHA-1",
+ "SHA-256",
+ "SHA-512",
+ "MurmurHash3"
+ ]
+ },
+ "ingest._types.ForeachProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "Field containing array or object values.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If `true`, the processor silently exits without changing the document if the `field` is `null` or missing.",
+ "default": false,
+ "type": "boolean"
+ },
+ "processor": {
+ "description": "Ingest processor to run on each element.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorContainer"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field",
+ "processor"
+ ]
+ }
+ ]
+ },
+ "ingest._types.IpLocationProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "database_file": {
+ "description": "The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory.",
+ "default": "GeoLite2-City.mmdb",
+ "type": "string"
+ },
+ "field": {
+ "description": "The field to get the ip address from for the geographical lookup.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "first_only": {
+ "description": "If `true`, only the first found IP location data will be returned, even if the field contains an array.",
+ "default": true,
+ "type": "boolean"
+ },
+ "ignore_missing": {
+ "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.",
+ "default": false,
+ "type": "boolean"
+ },
+ "properties": {
+ "description": "Controls what properties are added to the `target_field` based on the IP location lookup.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "target_field": {
+ "description": "The field that will hold the geographical information looked up from the MaxMind database.",
+ "default": "geoip",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "download_database_on_pipeline_creation": {
+ "description": "If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created.\nElse, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "field"
+ ]
+ }
+ ]
+ },
+ "ingest._types.GeoGridProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The field to interpret as a geo-tile.=\nThe field format is determined by the `tile_type`.",
+ "type": "string"
+ },
+ "tile_type": {
+ "description": "Three tile formats are understood: geohash, geotile and geohex.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.GeoGridTileType"
+ }
+ ]
+ },
+ "target_field": {
+ "description": "The field to assign the polygon shape to, by default, the `field` is updated in-place.",
+ "default": "field",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "parent_field": {
+ "description": "If specified and a parent tile exists, save that tile address to this field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "children_field": {
+ "description": "If specified and children tiles exist, save those tile addresses to this field as an array of strings.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "non_children_field": {
+ "description": "If specified and intersecting non-child tiles exist, save their addresses to this field as an array of strings.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "precision_field": {
+ "description": "If specified, save the tile precision (zoom) as an integer to this field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.",
+ "default": false,
+ "type": "boolean"
+ },
+ "target_format": {
+ "description": "Which format to save the generated polygon in.",
+ "default": "geojson",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.GeoGridTargetFormat"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field",
+ "tile_type"
+ ]
+ }
+ ]
+ },
+ "ingest._types.GeoGridTileType": {
+ "type": "string",
+ "enum": [
+ "geotile",
+ "geohex",
+ "geohash"
+ ]
+ },
+ "ingest._types.GeoGridTargetFormat": {
+ "type": "string",
+ "enum": [
+ "geojson",
+ "wkt"
+ ]
+ },
+ "ingest._types.GeoIpProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "database_file": {
+ "description": "The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory.",
+ "default": "GeoLite2-City.mmdb",
+ "type": "string"
+ },
+ "field": {
+ "description": "The field to get the ip address from for the geographical lookup.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "first_only": {
+ "description": "If `true`, only the first found geoip data will be returned, even if the field contains an array.",
+ "default": true,
+ "type": "boolean"
+ },
+ "ignore_missing": {
+ "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.",
+ "default": false,
+ "type": "boolean"
+ },
+ "properties": {
+ "description": "Controls what properties are added to the `target_field` based on the geoip lookup.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "target_field": {
+ "description": "The field that will hold the geographical information looked up from the MaxMind database.",
+ "default": "geoip",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "download_database_on_pipeline_creation": {
+ "description": "If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created.\nElse, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "field"
+ ]
+ }
+ ]
+ },
+ "ingest._types.GrokProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "ecs_compatibility": {
+ "description": "Must be disabled or v1. If v1, the processor uses patterns with Elastic\nCommon Schema (ECS) field names.",
+ "default": "disabled",
+ "type": "string"
+ },
+ "field": {
+ "description": "The field to use for grok expression parsing.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.",
+ "default": false,
+ "type": "boolean"
+ },
+ "pattern_definitions": {
+ "description": "A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor.\nPatterns matching existing names will override the pre-existing definition.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "patterns": {
+ "description": "An ordered list of grok expression to match and extract named captures with.\nReturns on the first expression in the list that matches.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.GrokPattern"
+ }
+ },
+ "trace_match": {
+ "description": "When `true`, `_ingest._grok_match_index` will be inserted into your matched document’s metadata with the index into the pattern found in `patterns` that matched.",
+ "default": false,
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "field",
+ "patterns"
+ ]
+ }
+ ]
+ },
+ "_types.GrokPattern": {
+ "type": "string"
+ },
+ "ingest._types.GsubProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The field to apply the replacement to.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.",
+ "default": false,
+ "type": "boolean"
+ },
+ "pattern": {
+ "description": "The pattern to be replaced.",
+ "type": "string"
+ },
+ "replacement": {
+ "description": "The string to replace the matching patterns with.",
+ "type": "string"
+ },
+ "target_field": {
+ "description": "The field to assign the converted value to\nBy default, the `field` is updated in-place.",
+ "default": "field",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field",
+ "pattern",
+ "replacement"
+ ]
+ }
+ ]
+ },
+ "ingest._types.HtmlStripProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The string-valued field to remove HTML tags from.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document,",
+ "default": false,
+ "type": "boolean"
+ },
+ "target_field": {
+ "description": "The field to assign the converted value to\nBy default, the `field` is updated in-place.",
+ "default": "field",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field"
+ ]
+ }
+ ]
+ },
+ "ingest._types.InferenceProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "model_id": {
+ "description": "The ID or alias for the trained model, or the ID of the deployment.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "target_field": {
+ "description": "Field added to incoming documents to contain results objects.",
+ "default": "ml.inference.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "field_map": {
+ "description": "Maps the document field names to the known field names of the model.\nThis mapping takes precedence over any default mappings provided in the model configuration.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "inference_config": {
+ "description": "Contains the inference type and its options.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.InferenceConfig"
+ }
+ ]
+ },
+ "input_output": {
+ "description": "Input fields for inference and output (destination) fields for the inference results.\nThis option is incompatible with the target_field and field_map options.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.InputConfig"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ingest._types.InputConfig"
+ }
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If true and any of the input fields defined in input_ouput are missing\nthen those missing fields are quietly ignored, otherwise a missing field causes a failure.\nOnly applies when using input_output configurations to explicitly list the input fields.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "model_id"
+ ]
+ }
+ ]
+ },
+ "ingest._types.InferenceConfig": {
+ "type": "object",
+ "properties": {
+ "regression": {
+ "description": "Regression configuration for inference.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.InferenceConfigRegression"
+ }
+ ]
+ },
+ "classification": {
+ "description": "Classification configuration for inference.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.InferenceConfigClassification"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "ingest._types.InferenceConfigRegression": {
+ "type": "object",
+ "properties": {
+ "results_field": {
+ "description": "The field that is added to incoming documents to contain the inference prediction.",
+ "default": "_prediction",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "num_top_feature_importance_values": {
+ "description": "Specifies the maximum number of feature importance values per document.",
+ "default": 0.0,
+ "type": "number"
+ }
+ }
+ },
+ "ingest._types.InferenceConfigClassification": {
+ "type": "object",
+ "properties": {
+ "num_top_classes": {
+ "description": "Specifies the number of top class predictions to return.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "num_top_feature_importance_values": {
+ "description": "Specifies the maximum number of feature importance values per document.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "results_field": {
+ "description": "The field that is added to incoming documents to contain the inference prediction.",
+ "default": "_prediction",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "top_classes_results_field": {
+ "description": "Specifies the field to which the top classes are written.",
+ "default": "top_classes",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "prediction_field_type": {
+ "description": "Specifies the type of the predicted field to write.\nValid values are: `string`, `number`, `boolean`.",
+ "type": "string"
+ }
+ }
+ },
+ "ingest._types.InputConfig": {
+ "type": "object",
+ "properties": {
+ "input_field": {
+ "type": "string"
+ },
+ "output_field": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "input_field",
+ "output_field"
+ ]
+ },
+ "ingest._types.JoinProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "Field containing array values to join.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "separator": {
+ "description": "The separator character.",
+ "type": "string"
+ },
+ "target_field": {
+ "description": "The field to assign the joined value to.\nBy default, the field is updated in-place.",
+ "default": "field",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field",
+ "separator"
+ ]
+ }
+ ]
+ },
+ "ingest._types.JsonProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "add_to_root": {
+ "description": "Flag that forces the parsed JSON to be added at the top level of the document.\n`target_field` must not be set when this option is chosen.",
+ "default": false,
+ "type": "boolean"
+ },
+ "add_to_root_conflict_strategy": {
+ "description": "When set to `replace`, root fields that conflict with fields from the parsed JSON will be overridden.\nWhen set to `merge`, conflicting fields will be merged.\nOnly applicable `if add_to_root` is set to true.\n\nSupported values include:\n - `replace`: Root fields that conflict with fields from the parsed JSON will be overridden.\n - `merge`: Conflicting fields will be merged.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.JsonProcessorConflictStrategy"
+ }
+ ]
+ },
+ "allow_duplicate_keys": {
+ "description": "When set to `true`, the JSON parser will not fail if the JSON contains duplicate keys.\nInstead, the last encountered value for any duplicate key wins.",
+ "default": false,
+ "type": "boolean"
+ },
+ "field": {
+ "description": "The field to be parsed.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "target_field": {
+ "description": "The field that the converted structured object will be written into.\nAny existing content in this field will be overwritten.",
+ "default": "field",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field"
+ ]
+ }
+ ]
+ },
+ "ingest._types.JsonProcessorConflictStrategy": {
+ "type": "string",
+ "enum": [
+ "replace",
+ "merge"
+ ]
+ },
+ "ingest._types.KeyValueProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "exclude_keys": {
+ "description": "List of keys to exclude from document.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "field": {
+ "description": "The field to be parsed.\nSupports template snippets.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "field_split": {
+ "description": "Regex pattern to use for splitting key-value pairs.",
+ "type": "string"
+ },
+ "ignore_missing": {
+ "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.",
+ "default": false,
+ "type": "boolean"
+ },
+ "include_keys": {
+ "description": "List of keys to filter and insert into document.\nDefaults to including all keys.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "prefix": {
+ "description": "Prefix to be added to extracted keys.",
+ "default": "null",
+ "type": "string"
+ },
+ "strip_brackets": {
+ "description": "If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `\"` from extracted values.",
+ "default": false,
+ "type": "boolean"
+ },
+ "target_field": {
+ "description": "The field to insert the extracted keys into.\nDefaults to the root of the document.\nSupports template snippets.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "trim_key": {
+ "description": "String of characters to trim from extracted keys.",
+ "type": "string"
+ },
+ "trim_value": {
+ "description": "String of characters to trim from extracted values.",
+ "type": "string"
+ },
+ "value_split": {
+ "description": "Regex pattern to use for splitting the key from the value within a key-value pair.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "field",
+ "field_split",
+ "value_split"
+ ]
+ }
+ ]
+ },
+ "ingest._types.LowercaseProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The field to make lowercase.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.",
+ "default": false,
+ "type": "boolean"
+ },
+ "target_field": {
+ "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.",
+ "default": "field",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field"
+ ]
+ }
+ ]
+ },
+ "ingest._types.NetworkDirectionProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "source_ip": {
+ "description": "Field containing the source IP address.",
+ "default": "source.ip",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "destination_ip": {
+ "description": "Field containing the destination IP address.",
+ "default": "destination.ip",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "target_field": {
+ "description": "Output field for the network direction.",
+ "default": "network.direction",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "internal_networks": {
+ "description": "List of internal networks. Supports IPv4 and IPv6 addresses and ranges in\nCIDR notation. Also supports the named ranges listed below. These may be\nconstructed with template snippets. Must specify only one of\ninternal_networks or internal_networks_field.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "internal_networks_field": {
+ "description": "A field on the given document to read the internal_networks configuration\nfrom.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If true and any required fields are missing, the processor quietly exits\nwithout modifying the document.",
+ "default": true,
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "ingest._types.PipelineProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the pipeline to execute.\nSupports template snippets.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "ignore_missing_pipeline": {
+ "description": "Whether to ignore missing pipelines instead of failing.",
+ "default": false,
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "name"
+ ]
+ }
+ ]
+ },
+ "ingest._types.RedactProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The field to be redacted",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "patterns": {
+ "description": "A list of grok expressions to match and redact named captures with",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.GrokPattern"
+ }
+ },
+ "pattern_definitions": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "prefix": {
+ "description": "Start a redacted section with this token",
+ "default": "<",
+ "type": "string"
+ },
+ "suffix": {
+ "description": "End a redacted section with this token",
+ "default": ">",
+ "type": "string"
+ },
+ "ignore_missing": {
+ "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.",
+ "default": false,
+ "type": "boolean"
+ },
+ "skip_if_unlicensed": {
+ "description": "If `true` and the current license does not support running redact processors, then the processor quietly exits without modifying the document",
+ "default": false,
+ "type": "boolean"
+ },
+ "trace_redact": {
+ "description": "If `true` then ingest metadata `_ingest._redact._is_redacted` is set to `true` if the document has been redacted",
+ "default": false,
+ "x-state": "Generally available",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "field",
+ "patterns"
+ ]
+ }
+ ]
+ },
+ "ingest._types.RegisteredDomainProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "Field containing the source FQDN.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "target_field": {
+ "description": "Object field containing extracted domain components. If an empty string,\nthe processor adds components to the document’s root.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If true and any required fields are missing, the processor quietly exits\nwithout modifying the document.",
+ "default": true,
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "field"
+ ]
+ }
+ ]
+ },
+ "ingest._types.RemoveProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "Fields to be removed. Supports template snippets.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ },
+ "keep": {
+ "description": "Fields to be kept. When set, all fields other than those specified are removed.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.",
+ "default": false,
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "field"
+ ]
+ }
+ ]
+ },
+ "ingest._types.RenameProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The field to be renamed.\nSupports template snippets.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.",
+ "default": false,
+ "type": "boolean"
+ },
+ "target_field": {
+ "description": "The new name of the field.\nSupports template snippets.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field",
+ "target_field"
+ ]
+ }
+ ]
+ },
+ "ingest._types.RerouteProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "destination": {
+ "description": "A static value for the target. Can’t be set when the dataset or namespace option is set.",
+ "type": "string"
+ },
+ "dataset": {
+ "description": "Field references or a static value for the dataset part of the data stream name.\nIn addition to the criteria for index names, cannot contain - and must be no longer than 100 characters.\nExample values are nginx.access and nginx.error.\n\nSupports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).\nWhen resolving field references, the processor replaces invalid characters with _. Uses the part\nof the index name as a fallback if all field references resolve to a null, missing, or non-string value.\n\ndefault {{data_stream.dataset}}",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "namespace": {
+ "description": "Field references or a static value for the namespace part of the data stream name. See the criteria for\nindex names for allowed characters. Must be no longer than 100 characters.\n\nSupports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).\nWhen resolving field references, the processor replaces invalid characters with _. Uses the part\nof the index name as a fallback if all field references resolve to a null, missing, or non-string value.\n\ndefault {{data_stream.namespace}}",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "ingest._types.ScriptProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "ID of a stored script.\nIf no `source` is specified, this parameter is required.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "lang": {
+ "description": "Script language.\n\nSupported values include:\n - `painless`: Painless scripting language, purpose-built for Elasticsearch.\n - `expression`: Lucene’s expressions language, compiles a JavaScript expression to bytecode.\n - `mustache`: Mustache templated, used for templates.\n - `java`: Expert Java API\n\n",
+ "default": "painless",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScriptLanguage"
+ }
+ ]
+ },
+ "params": {
+ "description": "Object containing parameters for the script.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "source": {
+ "description": "Inline script.\nIf no `id` is specified, this parameter is required.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScriptSource"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "ingest._types.SetProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "copy_from": {
+ "description": "The origin field which will be copied to `field`, cannot set `value` simultaneously.\nSupported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "field": {
+ "description": "The field to insert, upsert, or update.\nSupports template snippets.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "ignore_empty_value": {
+ "description": "If `true` and `value` is a template snippet that evaluates to `null` or the empty string, the processor quietly exits without modifying the document.",
+ "default": false,
+ "type": "boolean"
+ },
+ "media_type": {
+ "description": "The media type for encoding `value`.\nApplies only when value is a template snippet.\nMust be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`.",
+ "type": "string"
+ },
+ "override": {
+ "description": "If `true` processor will update fields with pre-existing non-null-valued field.\nWhen set to `false`, such fields will not be touched.",
+ "default": true,
+ "type": "boolean"
+ },
+ "value": {
+ "description": "The value to be set for the field.\nSupports template snippets.\nMay specify only one of `value` or `copy_from`.",
+ "type": "object"
+ }
+ },
+ "required": [
+ "field"
+ ]
+ }
+ ]
+ },
+ "ingest._types.SetSecurityUserProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The field to store the user information into.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "properties": {
+ "description": "Controls what user related properties are added to the field.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "field"
+ ]
+ }
+ ]
+ },
+ "ingest._types.SortProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The field to be sorted.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "order": {
+ "description": "The sort order to use.\nAccepts `\"asc\"` or `\"desc\"`.\n\nSupported values include:\n - `asc`: Ascending (smallest to largest)\n - `desc`: Descending (largest to smallest)\n\n",
+ "default": "asc",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SortOrder"
+ }
+ ]
+ },
+ "target_field": {
+ "description": "The field to assign the sorted value to.\nBy default, the field is updated in-place.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field"
+ ]
+ }
+ ]
+ },
+ "ingest._types.SplitProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The field to split.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.",
+ "default": false,
+ "type": "boolean"
+ },
+ "preserve_trailing": {
+ "description": "Preserves empty trailing fields, if any.",
+ "default": false,
+ "type": "boolean"
+ },
+ "separator": {
+ "description": "A regex which matches the separator, for example, `,` or `\\s+`.",
+ "type": "string"
+ },
+ "target_field": {
+ "description": "The field to assign the split value to.\nBy default, the field is updated in-place.",
+ "default": "field",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field",
+ "separator"
+ ]
+ }
+ ]
+ },
+ "ingest._types.TerminateProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "ingest._types.TrimProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The string-valued field to trim whitespace from.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.",
+ "default": false,
+ "type": "boolean"
+ },
+ "target_field": {
+ "description": "The field to assign the trimmed value to.\nBy default, the field is updated in-place.",
+ "default": "field",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field"
+ ]
+ }
+ ]
+ },
+ "ingest._types.UppercaseProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The field to make uppercase.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.",
+ "default": false,
+ "type": "boolean"
+ },
+ "target_field": {
+ "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.",
+ "default": "field",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field"
+ ]
+ }
+ ]
+ },
+ "ingest._types.UrlDecodeProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The field to decode.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.",
+ "default": false,
+ "type": "boolean"
+ },
+ "target_field": {
+ "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.",
+ "default": "field",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field"
+ ]
+ }
+ ]
+ },
+ "ingest._types.UriPartsProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "Field containing the URI string.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.",
+ "default": false,
+ "type": "boolean"
+ },
+ "keep_original": {
+ "description": "If `true`, the processor copies the unparsed URI to `.original`.",
+ "default": true,
+ "type": "boolean"
+ },
+ "remove_if_successful": {
+ "description": "If `true`, the processor removes the `field` after parsing the URI string.\nIf parsing fails, the processor does not remove the `field`.",
+ "default": false,
+ "type": "boolean"
+ },
+ "target_field": {
+ "description": "Output field for the URI object.",
+ "default": "url",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field"
+ ]
+ }
+ ]
+ },
+ "ingest._types.UserAgentProcessor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.ProcessorBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The field containing the user agent string.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "ignore_missing": {
+ "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.",
+ "default": false,
+ "type": "boolean"
+ },
+ "regex_file": {
+ "description": "The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the `regexes.yaml` from uap-core it ships with.",
+ "type": "string"
+ },
+ "target_field": {
+ "description": "The field that will be filled with the user agent details.",
+ "default": "user_agent",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "properties": {
+ "description": "Controls what properties are added to `target_field`.",
+ "default": [
+ "name",
+ "major",
+ "minor",
+ "patch",
+ "build",
+ "os",
+ "os_name",
+ "os_major",
+ "os_minor",
+ "device"
+ ],
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ingest._types.UserAgentProperty"
+ }
+ },
+ "extract_device_type": {
+ "description": "Extracts device type from the user agent string on a best-effort basis.",
+ "default": false,
+ "x-state": "Generally available",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "field"
+ ]
+ }
+ ]
+ },
+ "ingest._types.UserAgentProperty": {
+ "type": "string",
+ "enum": [
+ "name",
+ "os",
+ "device",
+ "original",
+ "version"
+ ]
+ },
+ "ingest._types.Document": {
+ "type": "object",
+ "properties": {
+ "_id": {
+ "description": "Unique identifier for the document.\nThis ID must be unique within the `_index`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "_index": {
+ "description": "Name of the index containing the document.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "_source": {
+ "description": "JSON body for the document.",
+ "type": "object"
+ }
+ },
+ "required": [
+ "_source"
+ ]
+ },
+ "ingest._types.SimulateDocumentResult": {
+ "type": "object",
+ "properties": {
+ "doc": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.DocumentSimulation"
+ }
+ ]
+ },
+ "error": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ErrorCause"
+ }
+ ]
+ },
+ "processor_results": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ingest._types.PipelineProcessorResult"
+ }
+ }
+ }
+ },
+ "ingest._types.DocumentSimulation": {
+ "description": "The simulated document, with optional metadata.",
+ "type": "object",
+ "properties": {
+ "_id": {
+ "description": "Unique identifier for the document. This ID must be unique within the `_index`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "_index": {
+ "description": "Name of the index containing the document.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "_ingest": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.Ingest"
+ }
+ ]
+ },
+ "_routing": {
+ "description": "Value used to send the document to a specific primary shard.",
+ "type": "string"
+ },
+ "_source": {
+ "description": "JSON body for the document.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "_version": {
+ "description": "",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_spec_utils.StringifiedVersionNumber"
+ }
+ ]
+ },
+ "_version_type": {
+ "description": "\n\nSupported values include:\n - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n - `force`: This option is deprecated because it can cause primary and replica shards to diverge.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionType"
+ }
+ ]
+ }
+ },
+ "required": [
+ "_id",
+ "_index",
+ "_ingest",
+ "_source"
+ ]
+ },
+ "ingest._types.Ingest": {
+ "type": "object",
+ "properties": {
+ "_redact": {
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.Redact"
+ }
+ ]
+ },
+ "timestamp": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "pipeline": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ }
+ },
+ "required": [
+ "timestamp"
+ ]
+ },
+ "ingest._types.Redact": {
+ "type": "object",
+ "properties": {
+ "_is_redacted": {
+ "description": "indicates if document has been redacted",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "_is_redacted"
+ ]
+ },
+ "_spec_utils.StringifiedVersionNumber": {
+ "description": "Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior\nis used to capture this behavior while keeping the semantics of the field type.\n\nDepending on the target language, code generators can keep the union or remove it and leniently parse\nstrings to the target type.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "ingest._types.PipelineProcessorResult": {
+ "type": "object",
+ "properties": {
+ "doc": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.DocumentSimulation"
+ }
+ ]
+ },
+ "tag": {
+ "type": "string"
+ },
+ "processor_type": {
+ "type": "string"
+ },
+ "status": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.PipelineSimulationStatusOptions"
+ }
+ ]
+ },
+ "description": {
+ "type": "string"
+ },
+ "ignored_error": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ErrorCause"
+ }
+ ]
+ },
+ "error": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ErrorCause"
+ }
+ ]
+ }
+ }
+ },
+ "ingest._types.PipelineSimulationStatusOptions": {
+ "type": "string",
+ "enum": [
+ "success",
+ "error",
+ "error_ignored",
+ "skipped",
+ "dropped"
+ ]
+ },
+ "license.get.LicenseInformation": {
+ "type": "object",
+ "properties": {
+ "expiry_date": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "expiry_date_in_millis": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "issue_date": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "issue_date_in_millis": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "issued_to": {
+ "type": "string"
+ },
+ "issuer": {
+ "type": "string"
+ },
+ "max_nodes": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "max_resource_units": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "status": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/license._types.LicenseStatus"
+ }
+ ]
+ },
+ "type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/license._types.LicenseType"
+ }
+ ]
+ },
+ "uid": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Uuid"
+ }
+ ]
+ },
+ "start_date_in_millis": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ }
+ },
+ "required": [
+ "issue_date",
+ "issue_date_in_millis",
+ "issued_to",
+ "issuer",
+ "max_nodes",
+ "status",
+ "type",
+ "uid",
+ "start_date_in_millis"
+ ]
+ },
+ "license._types.LicenseStatus": {
+ "type": "string",
+ "enum": [
+ "active",
+ "valid",
+ "invalid",
+ "expired"
+ ]
+ },
+ "license._types.LicenseType": {
+ "type": "string",
+ "enum": [
+ "missing",
+ "trial",
+ "basic",
+ "standard",
+ "dev",
+ "silver",
+ "gold",
+ "platinum",
+ "enterprise"
+ ]
+ },
+ "logstash._types.Pipeline": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "A description of the pipeline.\nThis description is not used by Elasticsearch or Logstash.",
+ "type": "string"
+ },
+ "last_modified": {
+ "description": "The date the pipeline was last updated.\nIt must be in the `yyyy-MM-dd'T'HH:mm:ss.SSSZZ` strict_date_time format.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "pipeline": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/logstash/configuration-file-structure"
+ },
+ "description": "The configuration for the pipeline.",
+ "type": "string"
+ },
+ "pipeline_metadata": {
+ "description": "Optional metadata about the pipeline, which can have any contents.\nThis metadata is not generated or used by Elasticsearch or Logstash.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/logstash._types.PipelineMetadata"
+ }
+ ]
+ },
+ "pipeline_settings": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/logstash/logstash-settings-file"
+ },
+ "description": "Settings for the pipeline.\nIt supports only flat keys in dot notation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/logstash._types.PipelineSettings"
+ }
+ ]
+ },
+ "username": {
+ "description": "The user who last updated the pipeline.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "description",
+ "last_modified",
+ "pipeline",
+ "pipeline_metadata",
+ "pipeline_settings",
+ "username"
+ ]
+ },
+ "logstash._types.PipelineMetadata": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "version": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "version"
+ ]
+ },
+ "logstash._types.PipelineSettings": {
+ "type": "object",
+ "properties": {
+ "pipeline.workers": {
+ "description": "The number of workers that will, in parallel, execute the filter and output stages of the pipeline.",
+ "type": "number"
+ },
+ "pipeline.batch.size": {
+ "description": "The maximum number of events an individual worker thread will collect from inputs before attempting to execute its filters and outputs.",
+ "type": "number"
+ },
+ "pipeline.batch.delay": {
+ "description": "When creating pipeline event batches, how long in milliseconds to wait for each event before dispatching an undersized batch to pipeline workers.",
+ "type": "number"
+ },
+ "queue.type": {
+ "description": "The internal queuing model to use for event buffering.",
+ "type": "string"
+ },
+ "queue.max_bytes": {
+ "description": "The total capacity of the queue (`queue.type: persisted`) in number of bytes.",
+ "type": "string"
+ },
+ "queue.checkpoint.writes": {
+ "description": "The maximum number of written events before forcing a checkpoint when persistent queues are enabled (`queue.type: persisted`).",
+ "type": "number"
+ }
+ },
+ "required": [
+ "pipeline.workers",
+ "pipeline.batch.size",
+ "pipeline.batch.delay",
+ "queue.type",
+ "queue.max_bytes",
+ "queue.checkpoint.writes"
+ ]
+ },
+ "_global.mget.Operation": {
+ "type": "object",
+ "properties": {
+ "_id": {
+ "description": "The unique document ID.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "_index": {
+ "description": "The index that contains the document.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "routing": {
+ "description": "The key for the primary shard the document resides on. Required if routing is used during indexing.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Routing"
+ }
+ ]
+ },
+ "_source": {
+ "description": "If `false`, excludes all _source fields.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.SourceConfig"
+ }
+ ]
+ },
+ "stored_fields": {
+ "description": "The stored fields you want to retrieve.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ },
+ "version": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ }
+ ]
+ },
+ "version_type": {
+ "description": "\n\nSupported values include:\n - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n - `force`: This option is deprecated because it can cause primary and replica shards to diverge.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionType"
+ }
+ ]
+ }
+ },
+ "required": [
+ "_id"
+ ]
+ },
+ "_global.mget.ResponseItem": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_global.get.GetResult"
+ },
+ {
+ "$ref": "#/components/schemas/_global.mget.MultiGetError"
+ }
+ ]
+ },
+ "_global.mget.MultiGetError": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ErrorCause"
+ }
+ ]
+ },
+ "_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "_index": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ }
+ },
+ "required": [
+ "error",
+ "_id",
+ "_index"
+ ]
+ },
+ "ml._types.AnalysisConfig": {
+ "type": "object",
+ "properties": {
+ "bucket_span": {
+ "description": "The size of the interval that the analysis is aggregated into, typically between `5m` and `1h`. This value should be either a whole number of days or equate to a\nwhole number of buckets in one day. If the anomaly detection job uses a datafeed with aggregations, this value must also be divisible by the interval of the date histogram aggregation.",
+ "default": "5m",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "categorization_analyzer": {
+ "description": "If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as `categorization_filters`. The categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process. The `categorization_analyzer` field can be specified either as a string or as an object. If it is a string, it must refer to a built-in analyzer or one added by another plugin.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.CategorizationAnalyzer"
+ }
+ ]
+ },
+ "categorization_field_name": {
+ "description": "If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "categorization_filters": {
+ "description": "If `categorization_field_name` is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as `categorization_analyzer`. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the `categorization_analyzer` property instead and include the filters as pattern_replace character filters. The effect is exactly the same.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "detectors": {
+ "description": "Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.Detector"
+ }
+ },
+ "influencers": {
+ "description": "A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ },
+ "latency": {
+ "description": "The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is applicable only when you send data by using the post data API.",
+ "default": "0",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "model_prune_window": {
+ "description": "Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the `bucket_span`. If set too low, important information may be removed from the model. For jobs created in 8.1 and later, the default value is the greater of `30d` or 20 times `bucket_span`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "multivariate_by_fields": {
+ "description": "This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to `true`, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the `multivariate_by_fields` property, you must also specify `by_field_name` in your detector.",
+ "type": "boolean"
+ },
+ "per_partition_categorization": {
+ "description": "Settings related to how categorization interacts with partition fields.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.PerPartitionCategorization"
+ }
+ ]
+ },
+ "summary_count_field_name": {
+ "description": "If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "detectors"
+ ]
+ },
+ "ml._types.CategorizationAnalyzer": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/ml._types.CategorizationAnalyzerDefinition"
+ }
+ ]
+ },
+ "ml._types.CategorizationAnalyzerDefinition": {
+ "type": "object",
+ "properties": {
+ "char_filter": {
+ "description": "One or more character filters. In addition to the built-in character filters, other plugins can provide more character filters. If this property is not specified, no character filters are applied prior to categorization. If you are customizing some other aspect of the analyzer and you need to achieve the equivalent of `categorization_filters` (which are not permitted when some other aspect of the analyzer is customized), add them here as pattern replace character filters.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.analysis.CharFilter"
+ }
+ },
+ "filter": {
+ "description": "One or more token filters. In addition to the built-in token filters, other plugins can provide more token filters. If this property is not specified, no token filters are applied prior to categorization.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilter"
+ }
+ },
+ "tokenizer": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/text-analysis/tokenizer-reference"
+ },
+ "description": "The name or definition of the tokenizer to use after character filters are applied. This property is compulsory if `categorization_analyzer` is specified as an object. Machine learning provides a tokenizer called `ml_standard` that tokenizes in a way that has been determined to produce good categorization results on a variety of log file formats for logs in English. If you want to use that tokenizer but change the character or token filters, specify \"tokenizer\": \"ml_standard\" in your `categorization_analyzer`. Additionally, the `ml_classic` tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2). `ml_classic` was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify \"tokenizer\": \"ml_classic\" in your `categorization_analyzer`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.Tokenizer"
+ }
+ ]
+ }
+ }
+ },
+ "ml._types.Detector": {
+ "type": "object",
+ "properties": {
+ "by_field_name": {
+ "description": "The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "custom_rules": {
+ "description": "Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.DetectionRule"
+ }
+ },
+ "detector_description": {
+ "description": "A description of the detector.",
+ "type": "string"
+ },
+ "detector_index": {
+ "description": "A unique identifier for the detector. This identifier is based on the order of the detectors in the `analysis_config`, starting at zero. If you specify a value for this property, it is ignored.",
+ "type": "number"
+ },
+ "exclude_frequent": {
+ "description": "If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set `exclude_frequent` to `all` for both fields, or to `by` or `over` for those specific fields.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.ExcludeFrequent"
+ }
+ ]
+ },
+ "field_name": {
+ "description": "The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "function": {
+ "description": "The analysis function that is used. For example, `count`, `rare`, `mean`, `min`, `max`, or `sum`.",
+ "type": "string"
+ },
+ "over_field_name": {
+ "description": "The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "partition_field_name": {
+ "description": "The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "use_null": {
+ "description": "Defines whether a new series is used as the null series when there is no value for the by or partition fields.",
+ "default": false,
+ "type": "boolean"
+ }
+ }
+ },
+ "ml._types.DetectionRule": {
+ "type": "object",
+ "properties": {
+ "actions": {
+ "description": "The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined.\n\nSupported values include:\n - `skip_result`: The result will not be created. Unless you also specify `skip_model_update`, the model will be updated as usual with the corresponding series value.\n - `skip_model_update`: The value for that series will not be used to update the model. Unless you also specify `skip_result`, the results will be created as usual. This action is suitable when certain values are expected to be consistently anomalous and they affect the model in a way that negatively impacts the rest of the results.\n\n",
+ "default": [
+ "skip_result"
+ ],
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.RuleAction"
+ }
+ },
+ "conditions": {
+ "description": "An array of numeric conditions when the rule applies. A rule must either have a non-empty scope or at least one condition. Multiple conditions are combined together with a logical AND.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.RuleCondition"
+ }
+ },
+ "scope": {
+ "description": "A scope of series where the rule applies. A rule must either have a non-empty scope or at least one condition. By default, the scope includes all series. Scoping is allowed for any of the fields that are also specified in `by_field_name`, `over_field_name`, or `partition_field_name`.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/ml._types.FilterRef"
+ }
+ }
+ }
+ },
+ "ml._types.RuleAction": {
+ "type": "string",
+ "enum": [
+ "skip_result",
+ "skip_model_update"
+ ]
+ },
+ "ml._types.RuleCondition": {
+ "type": "object",
+ "properties": {
+ "applies_to": {
+ "description": "Specifies the result property to which the condition applies. If your detector uses `lat_long`, `metric`, `rare`, or `freq_rare` functions, you can only specify conditions that apply to time.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.AppliesTo"
+ }
+ ]
+ },
+ "operator": {
+ "description": "Specifies the condition operator. The available options are greater than, greater than or equals, less than, and less than or equals.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.ConditionOperator"
+ }
+ ]
+ },
+ "value": {
+ "description": "The value that is compared against the `applies_to` field using the operator.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "applies_to",
+ "operator",
+ "value"
+ ]
+ },
+ "ml._types.AppliesTo": {
+ "type": "string",
+ "enum": [
+ "actual",
+ "typical",
+ "diff_from_typical",
+ "time"
+ ]
+ },
+ "ml._types.ConditionOperator": {
+ "type": "string",
+ "enum": [
+ "gt",
+ "gte",
+ "lt",
+ "lte"
+ ]
+ },
+ "ml._types.FilterRef": {
+ "type": "object",
+ "properties": {
+ "filter_id": {
+ "description": "The identifier for the filter.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "filter_type": {
+ "description": "If set to `include`, the rule applies for values in the filter. If set to `exclude`, the rule applies for values not in the filter.",
+ "default": "include",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.FilterType"
+ }
+ ]
+ }
+ },
+ "required": [
+ "filter_id"
+ ]
+ },
+ "ml._types.FilterType": {
+ "type": "string",
+ "enum": [
+ "include",
+ "exclude"
+ ]
+ },
+ "ml._types.ExcludeFrequent": {
+ "type": "string",
+ "enum": [
+ "all",
+ "none",
+ "by",
+ "over"
+ ]
+ },
+ "ml._types.PerPartitionCategorization": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "description": "To enable this setting, you must also set the `partition_field_name` property to the same value in every detector that uses the keyword `mlcategory`. Otherwise, job creation fails.",
+ "type": "boolean"
+ },
+ "stop_on_warn": {
+ "description": "This setting can be set to true only if per-partition categorization is enabled. If true, both categorization and subsequent anomaly detection stops for partitions where the categorization status changes to warn. This setting makes it viable to have a job where it is expected that categorization works well for some partitions but not others; you do not pay the cost of bad categorization forever in the partitions where it works badly.",
+ "type": "boolean"
+ }
+ }
+ },
+ "ml._types.DataframeEvaluationContainer": {
+ "type": "object",
+ "properties": {
+ "classification": {
+ "description": "Classification evaluation evaluates the results of a classification analysis which outputs a prediction that identifies to which of the classes each document belongs.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeEvaluationClassification"
+ }
+ ]
+ },
+ "outlier_detection": {
+ "description": "Outlier detection evaluates the results of an outlier detection analysis which outputs the probability that each document is an outlier.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeEvaluationOutlierDetection"
+ }
+ ]
+ },
+ "regression": {
+ "description": "Regression evaluation evaluates the results of a regression analysis which outputs a prediction of values.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeEvaluationRegression"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "ml._types.DataframeEvaluationClassification": {
+ "type": "object",
+ "properties": {
+ "actual_field": {
+ "description": "The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true).",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "predicted_field": {
+ "description": "The field in the index which contains the predicted value, in other words the results of the classification analysis.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "top_classes_field": {
+ "description": "The field of the index which is an array of documents of the form { \"class_name\": XXX, \"class_probability\": YYY }. This field must be defined as nested in the mappings.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "metrics": {
+ "description": "Specifies the metrics that are used for the evaluation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeEvaluationClassificationMetrics"
+ }
+ ]
+ }
+ },
+ "required": [
+ "actual_field"
+ ]
+ },
+ "ml._types.DataframeEvaluationClassificationMetrics": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeEvaluationMetrics"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "accuracy": {
+ "description": "Accuracy of predictions (per-class and overall).",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "multiclass_confusion_matrix": {
+ "description": "Multiclass confusion matrix.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ ]
+ },
+ "ml._types.DataframeEvaluationMetrics": {
+ "type": "object",
+ "properties": {
+ "auc_roc": {
+ "description": "The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as \"class_name\") treated as positive.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeEvaluationClassificationMetricsAucRoc"
+ }
+ ]
+ },
+ "precision": {
+ "description": "Precision of predictions (per-class and average).",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "recall": {
+ "description": "Recall of predictions (per-class and average).",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "ml._types.DataframeEvaluationClassificationMetricsAucRoc": {
+ "type": "object",
+ "properties": {
+ "class_name": {
+ "description": "Name of the only class that is treated as positive during AUC ROC calculation. Other classes are treated as negative (\"one-vs-all\" strategy). All the evaluated documents must have class_name in the list of their top classes.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "include_curve": {
+ "description": "Whether or not the curve should be returned in addition to the score. Default value is false.",
+ "type": "boolean"
+ }
+ }
+ },
+ "ml._types.DataframeEvaluationOutlierDetection": {
+ "type": "object",
+ "properties": {
+ "actual_field": {
+ "description": "The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true).",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "predicted_probability_field": {
+ "description": "The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "metrics": {
+ "description": "Specifies the metrics that are used for the evaluation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeEvaluationOutlierDetectionMetrics"
+ }
+ ]
+ }
+ },
+ "required": [
+ "actual_field",
+ "predicted_probability_field"
+ ]
+ },
+ "ml._types.DataframeEvaluationOutlierDetectionMetrics": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeEvaluationMetrics"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "confusion_matrix": {
+ "description": "Accuracy of predictions (per-class and overall).",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ ]
+ },
+ "ml._types.DataframeEvaluationRegression": {
+ "type": "object",
+ "properties": {
+ "actual_field": {
+ "description": "The field of the index which contains the ground truth. The data type of this field must be numerical.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "predicted_field": {
+ "description": "The field in the index that contains the predicted value, in other words the results of the regression analysis.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "metrics": {
+ "description": "Specifies the metrics that are used for the evaluation. For more information on mse, msle, and huber, consult the Jupyter notebook on regression loss functions.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeEvaluationRegressionMetrics"
+ }
+ ]
+ }
+ },
+ "required": [
+ "actual_field",
+ "predicted_field"
+ ]
+ },
+ "ml._types.DataframeEvaluationRegressionMetrics": {
+ "type": "object",
+ "properties": {
+ "mse": {
+ "description": "Average squared difference between the predicted values and the actual (ground truth) value. For more information, read this wiki article.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "msle": {
+ "description": "Average squared difference between the logarithm of the predicted values and the logarithm of the actual (ground truth) value.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeEvaluationRegressionMetricsMsle"
+ }
+ ]
+ },
+ "huber": {
+ "description": "Pseudo Huber loss function.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeEvaluationRegressionMetricsHuber"
+ }
+ ]
+ },
+ "r_squared": {
+ "description": "Proportion of the variance in the dependent variable that is predictable from the independent variables.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "ml._types.DataframeEvaluationRegressionMetricsMsle": {
+ "type": "object",
+ "properties": {
+ "offset": {
+ "description": "Defines the transition point at which you switch from minimizing quadratic error to minimizing quadratic log error. Defaults to 1.",
+ "type": "number"
+ }
+ }
+ },
+ "ml._types.DataframeEvaluationRegressionMetricsHuber": {
+ "type": "object",
+ "properties": {
+ "delta": {
+ "description": "Approximates 1/2 (prediction - actual)2 for values much less than delta and approximates a straight line with slope delta for values much larger than delta. Defaults to 1. Delta needs to be greater than 0.",
+ "type": "number"
+ }
+ }
+ },
+ "ml.evaluate_data_frame.DataframeClassificationSummary": {
+ "type": "object",
+ "properties": {
+ "auc_roc": {
+ "description": "The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve.\nIt is calculated for a specific class (provided as \"class_name\") treated as positive.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationSummaryAucRoc"
+ }
+ ]
+ },
+ "accuracy": {
+ "description": "Accuracy of predictions (per-class and overall).",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummaryAccuracy"
+ }
+ ]
+ },
+ "multiclass_confusion_matrix": {
+ "description": "Multiclass confusion matrix.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummaryMulticlassConfusionMatrix"
+ }
+ ]
+ },
+ "precision": {
+ "description": "Precision of predictions (per-class and average).",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummaryPrecision"
+ }
+ ]
+ },
+ "recall": {
+ "description": "Recall of predictions (per-class and average).",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeClassificationSummaryRecall"
+ }
+ ]
+ }
+ }
+ },
+ "ml.evaluate_data_frame.DataframeEvaluationSummaryAucRoc": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "curve": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationSummaryAucRocCurveItem"
+ }
+ }
+ }
+ }
+ ]
+ },
+ "ml.evaluate_data_frame.DataframeEvaluationSummaryAucRocCurveItem": {
+ "type": "object",
+ "properties": {
+ "tpr": {
+ "type": "number"
+ },
+ "fpr": {
+ "type": "number"
+ },
+ "threshold": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "tpr",
+ "fpr",
+ "threshold"
+ ]
+ },
+ "ml.evaluate_data_frame.DataframeEvaluationValue": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "value"
+ ]
+ },
+ "ml.evaluate_data_frame.DataframeClassificationSummaryAccuracy": {
+ "type": "object",
+ "properties": {
+ "classes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationClass"
+ }
+ },
+ "overall_accuracy": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "classes",
+ "overall_accuracy"
+ ]
+ },
+ "ml.evaluate_data_frame.DataframeEvaluationClass": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "class_name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ }
+ },
+ "required": [
+ "class_name"
+ ]
+ }
+ ]
+ },
+ "ml.evaluate_data_frame.DataframeClassificationSummaryMulticlassConfusionMatrix": {
+ "type": "object",
+ "properties": {
+ "confusion_matrix": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml.evaluate_data_frame.ConfusionMatrixItem"
+ }
+ },
+ "other_actual_class_count": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "confusion_matrix",
+ "other_actual_class_count"
+ ]
+ },
+ "ml.evaluate_data_frame.ConfusionMatrixItem": {
+ "type": "object",
+ "properties": {
+ "actual_class": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "actual_class_doc_count": {
+ "type": "number"
+ },
+ "predicted_classes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml.evaluate_data_frame.ConfusionMatrixPrediction"
+ }
+ },
+ "other_predicted_class_doc_count": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "actual_class",
+ "actual_class_doc_count",
+ "predicted_classes",
+ "other_predicted_class_doc_count"
+ ]
+ },
+ "ml.evaluate_data_frame.ConfusionMatrixPrediction": {
+ "type": "object",
+ "properties": {
+ "predicted_class": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "count": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "predicted_class",
+ "count"
+ ]
+ },
+ "ml.evaluate_data_frame.DataframeClassificationSummaryPrecision": {
+ "type": "object",
+ "properties": {
+ "classes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationClass"
+ }
+ },
+ "avg_precision": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "classes",
+ "avg_precision"
+ ]
+ },
+ "ml.evaluate_data_frame.DataframeClassificationSummaryRecall": {
+ "type": "object",
+ "properties": {
+ "classes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationClass"
+ }
+ },
+ "avg_recall": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "classes",
+ "avg_recall"
+ ]
+ },
+ "ml.evaluate_data_frame.DataframeOutlierDetectionSummary": {
+ "type": "object",
+ "properties": {
+ "auc_roc": {
+ "description": "The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve.",
+ "default": "{\"include_curve\": false}",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationSummaryAucRoc"
+ }
+ ]
+ },
+ "precision": {
+ "description": "Set the different thresholds of the outlier score at where the metric is calculated.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "number"
+ }
+ },
+ "recall": {
+ "description": "Set the different thresholds of the outlier score at where the metric is calculated.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "number"
+ }
+ },
+ "confusion_matrix": {
+ "description": "Set the different thresholds of the outlier score at where the metrics (`tp` - true positive, `fp` - false positive, `tn` - true negative, `fn` - false negative) are calculated.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/ml.evaluate_data_frame.ConfusionMatrixThreshold"
+ }
+ }
+ }
+ },
+ "ml.evaluate_data_frame.ConfusionMatrixThreshold": {
+ "type": "object",
+ "properties": {
+ "tp": {
+ "description": "True Positive",
+ "type": "number"
+ },
+ "fp": {
+ "description": "False Positive",
+ "type": "number"
+ },
+ "tn": {
+ "description": "True Negative",
+ "type": "number"
+ },
+ "fn": {
+ "description": "False Negative",
+ "type": "number"
+ }
+ },
+ "required": [
+ "tp",
+ "fp",
+ "tn",
+ "fn"
+ ]
+ },
+ "ml.evaluate_data_frame.DataframeRegressionSummary": {
+ "type": "object",
+ "properties": {
+ "huber": {
+ "description": "Pseudo Huber loss function.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue"
+ }
+ ]
+ },
+ "mse": {
+ "description": "Average squared difference between the predicted values and the actual (`ground truth`) value.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue"
+ }
+ ]
+ },
+ "msle": {
+ "description": "Average squared difference between the logarithm of the predicted values and the logarithm of the actual (`ground truth`) value.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue"
+ }
+ ]
+ },
+ "r_squared": {
+ "description": "Proportion of the variance in the dependent variable that is predictable from the independent variables.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.evaluate_data_frame.DataframeEvaluationValue"
+ }
+ ]
+ }
+ }
+ },
+ "ml._types.CalendarEvent": {
+ "type": "object",
+ "properties": {
+ "calendar_id": {
+ "description": "A string that uniquely identifies a calendar.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "event_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "description": {
+ "description": "A description of the scheduled event.",
+ "type": "string"
+ },
+ "end_time": {
+ "description": "The timestamp for the end of the scheduled event in milliseconds since the epoch or ISO 8601 format.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "start_time": {
+ "description": "The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "skip_result": {
+ "description": "When true the model will not create results for this calendar period.",
+ "default": true,
+ "type": "boolean"
+ },
+ "skip_model_update": {
+ "description": "When true the model will not be updated for this calendar period.",
+ "default": true,
+ "type": "boolean"
+ },
+ "force_time_shift": {
+ "description": "Shift time by this many seconds. For example adjust time for daylight savings changes",
+ "type": "number"
+ }
+ },
+ "required": [
+ "description",
+ "end_time",
+ "start_time"
+ ]
+ },
+ "ml._types.Page": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "Skips the specified number of items.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "size": {
+ "description": "Specifies the maximum number of items to obtain.",
+ "default": 10000.0,
+ "type": "number"
+ }
+ }
+ },
+ "ml.get_calendars.Calendar": {
+ "type": "object",
+ "properties": {
+ "calendar_id": {
+ "description": "A string that uniquely identifies a calendar.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "description": {
+ "description": "A description of the calendar.",
+ "type": "string"
+ },
+ "job_ids": {
+ "description": "An array of anomaly detection job identifiers.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ }
+ },
+ "required": [
+ "calendar_id",
+ "job_ids"
+ ]
+ },
+ "ml._types.DataframeAnalyticsSummary": {
+ "type": "object",
+ "properties": {
+ "allow_lazy_start": {
+ "type": "boolean"
+ },
+ "analysis": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer"
+ }
+ ]
+ },
+ "analyzed_fields": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields"
+ }
+ ]
+ },
+ "authorization": {
+ "description": "The security privileges that the job uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the job, this property is omitted.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalyticsAuthorization"
+ }
+ ]
+ },
+ "create_time": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "description": {
+ "type": "string"
+ },
+ "dest": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalyticsDestination"
+ }
+ ]
+ },
+ "id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "max_num_threads": {
+ "type": "number"
+ },
+ "model_memory_limit": {
+ "type": "string"
+ },
+ "source": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource"
+ }
+ ]
+ },
+ "version": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ },
+ "_meta": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ }
+ },
+ "required": [
+ "analysis",
+ "dest",
+ "id",
+ "source"
+ ]
+ },
+ "ml._types.DataframeAnalysisContainer": {
+ "type": "object",
+ "properties": {
+ "classification": {
+ "description": "The configuration information necessary to perform classification.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalysisClassification"
+ }
+ ]
+ },
+ "outlier_detection": {
+ "description": "The configuration information necessary to perform outlier detection. NOTE: Advanced parameters are for fine-tuning classification analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalysisOutlierDetection"
+ }
+ ]
+ },
+ "regression": {
+ "description": "The configuration information necessary to perform regression. NOTE: Advanced parameters are for fine-tuning regression analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalysisRegression"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "ml._types.DataframeAnalysisClassification": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalysis"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "class_assignment_objective": {
+ "type": "string"
+ },
+ "num_top_classes": {
+ "description": "Defines the number of categories for which the predicted probabilities are reported. It must be non-negative or -1. If it is -1 or greater than the total number of categories, probabilities are reported for all categories; if you have a large number of categories, there could be a significant effect on the size of your destination index. NOTE: To use the AUC ROC evaluation method, `num_top_classes` must be set to -1 or a value greater than or equal to the total number of categories.",
+ "default": 2.0,
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "ml._types.DataframeAnalysis": {
+ "type": "object",
+ "properties": {
+ "alpha": {
+ "description": "Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero.",
+ "type": "number"
+ },
+ "dependent_variable": {
+ "description": "Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable.\nFor classification analysis, the data type of the field must be numeric (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or `boolean`. There must be no more than 30 different values in this field.\nFor regression analysis, the data type of the field must be numeric.",
+ "type": "string"
+ },
+ "downsample_factor": {
+ "description": "Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1.",
+ "type": "number"
+ },
+ "early_stopping_enabled": {
+ "description": "Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable.",
+ "default": true,
+ "type": "boolean"
+ },
+ "eta": {
+ "description": "Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1.",
+ "type": "number"
+ },
+ "eta_growth_rate_per_tree": {
+ "description": "Advanced configuration option. Specifies the rate at which `eta` increases for each new tree that is added to the forest. For example, a rate of 1.05 increases `eta` by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2.",
+ "type": "number"
+ },
+ "feature_bag_fraction": {
+ "description": "Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization.",
+ "type": "number"
+ },
+ "feature_processors": {
+ "description": "Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple `feature_processors` entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessor"
+ }
+ },
+ "gamma": {
+ "description": "Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value.",
+ "type": "number"
+ },
+ "lambda": {
+ "description": "Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value.",
+ "type": "number"
+ },
+ "max_optimization_rounds_per_hyperparameter": {
+ "description": "Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization.",
+ "type": "number"
+ },
+ "max_trees": {
+ "description": "Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization.",
+ "type": "number"
+ },
+ "num_top_feature_importance_values": {
+ "description": "Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "prediction_field_name": {
+ "description": "Defines the name of the prediction field in the results. Defaults to `_prediction`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "randomize_seed": {
+ "description": "Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as `source` and `analyzed_fields` are the same).",
+ "type": "number"
+ },
+ "soft_tree_depth_limit": {
+ "description": "Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.",
+ "type": "number"
+ },
+ "soft_tree_depth_tolerance": {
+ "description": "Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01.",
+ "type": "number"
+ },
+ "training_percent": {
+ "description": "Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage.",
+ "default": 100.0,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Percentage"
+ }
+ ]
+ }
+ },
+ "required": [
+ "dependent_variable"
+ ]
+ },
+ "ml._types.DataframeAnalysisFeatureProcessor": {
+ "type": "object",
+ "properties": {
+ "frequency_encoding": {
+ "description": "The configuration information necessary to perform frequency encoding.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorFrequencyEncoding"
+ }
+ ]
+ },
+ "multi_encoding": {
+ "description": "The configuration information necessary to perform multi encoding. It allows multiple processors to be changed together. This way the output of a processor can then be passed to another as an input.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorMultiEncoding"
+ }
+ ]
+ },
+ "n_gram_encoding": {
+ "description": "The configuration information necessary to perform n-gram encoding. Features created by this encoder have the following name format: .. For example, if the feature_prefix is f, the feature name for the second unigram in a string is f.11.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorNGramEncoding"
+ }
+ ]
+ },
+ "one_hot_encoding": {
+ "description": "The configuration information necessary to perform one hot encoding.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorOneHotEncoding"
+ }
+ ]
+ },
+ "target_mean_encoding": {
+ "description": "The configuration information necessary to perform target mean encoding.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalysisFeatureProcessorTargetMeanEncoding"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "ml._types.DataframeAnalysisFeatureProcessorFrequencyEncoding": {
+ "type": "object",
+ "properties": {
+ "feature_name": {
+ "description": "The resulting feature name.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "field": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "frequency_map": {
+ "description": "The resulting frequency map for the field value. If the field value is missing from the frequency_map, the resulting value is 0.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "number"
+ }
+ }
+ },
+ "required": [
+ "feature_name",
+ "field",
+ "frequency_map"
+ ]
+ },
+ "ml._types.DataframeAnalysisFeatureProcessorMultiEncoding": {
+ "type": "object",
+ "properties": {
+ "processors": {
+ "description": "The ordered array of custom processors to execute. Must be more than 1.",
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ }
+ },
+ "required": [
+ "processors"
+ ]
+ },
+ "ml._types.DataframeAnalysisFeatureProcessorNGramEncoding": {
+ "type": "object",
+ "properties": {
+ "feature_prefix": {
+ "description": "The feature name prefix. Defaults to ngram__.",
+ "type": "string"
+ },
+ "field": {
+ "description": "The name of the text field to encode.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "length": {
+ "description": "Specifies the length of the n-gram substring. Defaults to 50. Must be greater than 0.",
+ "type": "number"
+ },
+ "n_grams": {
+ "description": "Specifies which n-grams to gather. It’s an array of integer values where the minimum value is 1, and a maximum value is 5.",
+ "type": "array",
+ "items": {
+ "type": "number"
+ }
+ },
+ "start": {
+ "description": "Specifies the zero-indexed start of the n-gram substring. Negative values are allowed for encoding n-grams of string suffixes. Defaults to 0.",
+ "type": "number"
+ },
+ "custom": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "field",
+ "n_grams"
+ ]
+ },
+ "ml._types.DataframeAnalysisFeatureProcessorOneHotEncoding": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The name of the field to encode.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "hot_map": {
+ "description": "The one hot map mapping the field value with the column name.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "field",
+ "hot_map"
+ ]
+ },
+ "ml._types.DataframeAnalysisFeatureProcessorTargetMeanEncoding": {
+ "type": "object",
+ "properties": {
+ "default_value": {
+ "description": "The default value if field value is not found in the target_map.",
+ "type": "number"
+ },
+ "feature_name": {
+ "description": "The resulting feature name.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "field": {
+ "description": "The name of the field to encode.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "target_map": {
+ "description": "The field value to target mean transition map.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "required": [
+ "default_value",
+ "feature_name",
+ "field",
+ "target_map"
+ ]
+ },
+ "_types.Percentage": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "number"
+ }
+ ]
+ },
+ "ml._types.DataframeAnalysisOutlierDetection": {
+ "type": "object",
+ "properties": {
+ "compute_feature_influence": {
+ "description": "Specifies whether the feature influence calculation is enabled.",
+ "default": true,
+ "type": "boolean"
+ },
+ "feature_influence_threshold": {
+ "description": "The minimum outlier score that a document needs to have in order to calculate its feature influence score. Value range: 0-1.",
+ "default": 0.1,
+ "type": "number"
+ },
+ "method": {
+ "description": "The method that outlier detection uses. Available methods are `lof`, `ldof`, `distance_kth_nn`, `distance_knn`, and `ensemble`. The default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score.",
+ "default": "ensemble",
+ "type": "string"
+ },
+ "n_neighbors": {
+ "description": "Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score. When the value is not set, different values are used for different ensemble members. This default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set.",
+ "type": "number"
+ },
+ "outlier_fraction": {
+ "description": "The proportion of the data set that is assumed to be outlying prior to outlier detection. For example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers.",
+ "type": "number"
+ },
+ "standardization_enabled": {
+ "description": "If true, the following operation is performed on the columns before computing outlier scores: `(x_i - mean(x_i)) / sd(x_i)`.",
+ "default": true,
+ "type": "boolean"
+ }
+ }
+ },
+ "ml._types.DataframeAnalysisRegression": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalysis"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "loss_function": {
+ "description": "The loss function used during regression. Available options are `mse` (mean squared error), `msle` (mean squared logarithmic error), `huber` (Pseudo-Huber loss).",
+ "default": "mse",
+ "type": "string"
+ },
+ "loss_function_parameter": {
+ "description": "A positive number that is used as a parameter to the `loss_function`.",
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "ml._types.DataframeAnalysisAnalyzedFields": {
+ "type": "object",
+ "properties": {
+ "includes": {
+ "description": "An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "excludes": {
+ "description": "An array of strings that defines the fields that will be included in the analysis.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "ml._types.DataframeAnalyticsAuthorization": {
+ "type": "object",
+ "properties": {
+ "api_key": {
+ "description": "If an API key was used for the most recent update to the job, its name and identifier are listed in the response.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.ApiKeyAuthorization"
+ }
+ ]
+ },
+ "roles": {
+ "description": "If a user ID was used for the most recent update to the job, its roles at the time of the update are listed in the response.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "service_account": {
+ "description": "If a service account was used for the most recent update to the job, the account name is listed in the response.",
+ "type": "string"
+ }
+ }
+ },
+ "ml._types.ApiKeyAuthorization": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The identifier for the API key.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the API key.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ]
+ },
+ "ml._types.DataframeAnalyticsDestination": {
+ "type": "object",
+ "properties": {
+ "index": {
+ "description": "Defines the destination index to store the results of the data frame analytics job.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "results_field": {
+ "description": "Defines the name of the field in which to store the results of the analysis. Defaults to `ml`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "index"
+ ]
+ },
+ "ml._types.DataframeAnalyticsSource": {
+ "type": "object",
+ "properties": {
+ "index": {
+ "description": "Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Indices"
+ }
+ ]
+ },
+ "query": {
+ "description": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {\"match_all\": {}}.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "runtime_mappings": {
+ "description": "Definitions of runtime fields that will become part of the mapping of the destination index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RuntimeFields"
+ }
+ ]
+ },
+ "_source": {
+ "description": "Specify `includes` and/or `excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields"
+ }
+ ]
+ }
+ },
+ "required": [
+ "index"
+ ]
+ },
+ "ml._types.DataframeAnalytics": {
+ "type": "object",
+ "properties": {
+ "analysis_stats": {
+ "description": "An object containing information about the analysis job.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsContainer"
+ }
+ ]
+ },
+ "assignment_explanation": {
+ "description": "For running jobs only, contains messages relating to the selection of a node to run the job.",
+ "type": "string"
+ },
+ "data_counts": {
+ "description": "An object that provides counts for the quantity of documents skipped, used in training, or available for testing.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsDataCounts"
+ }
+ ]
+ },
+ "id": {
+ "description": "The unique identifier of the data frame analytics job.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "memory_usage": {
+ "description": "An object describing memory usage of the analytics. It is present only after the job is started and memory usage is reported.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsMemoryUsage"
+ }
+ ]
+ },
+ "progress": {
+ "description": "The progress report of the data frame analytics job by phase.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsProgress"
+ }
+ },
+ "state": {
+ "description": "The status of the data frame analytics job, which can be one of the following values: failed, started, starting, stopping, stopped.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeState"
+ }
+ ]
+ }
+ },
+ "required": [
+ "data_counts",
+ "id",
+ "memory_usage",
+ "progress",
+ "state"
+ ]
+ },
+ "ml._types.DataframeAnalyticsStatsContainer": {
+ "type": "object",
+ "properties": {
+ "classification_stats": {
+ "description": "An object containing information about the classification analysis job.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsHyperparameters"
+ }
+ ]
+ },
+ "outlier_detection_stats": {
+ "description": "An object containing information about the outlier detection job.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsOutlierDetection"
+ }
+ ]
+ },
+ "regression_stats": {
+ "description": "An object containing information about the regression analysis.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalyticsStatsHyperparameters"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "ml._types.DataframeAnalyticsStatsHyperparameters": {
+ "type": "object",
+ "properties": {
+ "hyperparameters": {
+ "description": "An object containing the parameters of the classification analysis job.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.Hyperparameters"
+ }
+ ]
+ },
+ "iteration": {
+ "description": "The number of iterations on the analysis.",
+ "type": "number"
+ },
+ "timestamp": {
+ "description": "The timestamp when the statistics were reported in milliseconds since the epoch.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "timing_stats": {
+ "description": "An object containing time statistics about the data frame analytics job.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TimingStats"
+ }
+ ]
+ },
+ "validation_loss": {
+ "description": "An object containing information about validation loss.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.ValidationLoss"
+ }
+ ]
+ }
+ },
+ "required": [
+ "hyperparameters",
+ "iteration",
+ "timestamp",
+ "timing_stats",
+ "validation_loss"
+ ]
+ },
+ "ml._types.Hyperparameters": {
+ "type": "object",
+ "properties": {
+ "alpha": {
+ "description": "Advanced configuration option.\nMachine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly.\nThis parameter affects loss calculations by acting as a multiplier of the tree depth.\nHigher alpha values result in shallower trees and faster training times.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be greater than or equal to zero.",
+ "type": "number"
+ },
+ "lambda": {
+ "description": "Advanced configuration option.\nRegularization parameter to prevent overfitting on the training data set.\nMultiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest.\nA high lambda value causes training to favor small leaf weights.\nThis behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable.\nA small lambda value results in large individual trees and slower training.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be a nonnegative value.",
+ "type": "number"
+ },
+ "gamma": {
+ "description": "Advanced configuration option.\nRegularization parameter to prevent overfitting on the training data set.\nMultiplies a linear penalty associated with the size of individual trees in the forest.\nA high gamma value causes training to prefer small trees.\nA small gamma value results in larger individual trees and slower training.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be a nonnegative value.",
+ "type": "number"
+ },
+ "eta": {
+ "description": "Advanced configuration option.\nThe shrinkage applied to the weights.\nSmaller values result in larger forests which have a better generalization error.\nHowever, larger forests cause slower training.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be a value between `0.001` and `1`.",
+ "type": "number"
+ },
+ "eta_growth_rate_per_tree": {
+ "description": "Advanced configuration option.\nSpecifies the rate at which `eta` increases for each new tree that is added to the forest.\nFor example, a rate of 1.05 increases `eta` by 5% for each extra tree.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be between `0.5` and `2`.",
+ "type": "number"
+ },
+ "feature_bag_fraction": {
+ "description": "Advanced configuration option.\nDefines the fraction of features that will be used when selecting a random bag for each candidate split.\nBy default, this value is calculated during hyperparameter optimization.",
+ "type": "number"
+ },
+ "downsample_factor": {
+ "description": "Advanced configuration option.\nControls the fraction of data that is used to compute the derivatives of the loss function for tree training.\nA small value results in the use of a small fraction of the data.\nIf this value is set to be less than 1, accuracy typically improves.\nHowever, too small a value may result in poor convergence for the ensemble and so require more trees.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be greater than zero and less than or equal to 1.",
+ "type": "number"
+ },
+ "max_attempts_to_add_tree": {
+ "description": "If the algorithm fails to determine a non-trivial tree (more than a single leaf), this parameter determines how many of such consecutive failures are tolerated.\nOnce the number of attempts exceeds the threshold, the forest training stops.",
+ "type": "number"
+ },
+ "max_optimization_rounds_per_hyperparameter": {
+ "description": "Advanced configuration option.\nA multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure.\nThe maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter.\nBy default, this value is calculated during hyperparameter optimization.",
+ "type": "number"
+ },
+ "max_trees": {
+ "description": "Advanced configuration option.\nDefines the maximum number of decision trees in the forest.\nThe maximum value is 2000.\nBy default, this value is calculated during hyperparameter optimization.",
+ "type": "number"
+ },
+ "num_folds": {
+ "description": "The maximum number of folds for the cross-validation procedure.",
+ "type": "number"
+ },
+ "num_splits_per_feature": {
+ "description": "Determines the maximum number of splits for every feature that can occur in a decision tree when the tree is trained.",
+ "type": "number"
+ },
+ "soft_tree_depth_limit": {
+ "description": "Advanced configuration option.\nMachine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly.\nThis soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be greater than or equal to 0.",
+ "type": "number"
+ },
+ "soft_tree_depth_tolerance": {
+ "description": "Advanced configuration option.\nThis option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`.\nBy default, this value is calculated during hyperparameter optimization.\nIt must be greater than or equal to 0.01.",
+ "type": "number"
+ }
+ }
+ },
+ "ml._types.TimingStats": {
+ "type": "object",
+ "properties": {
+ "elapsed_time": {
+ "description": "Runtime of the analysis in milliseconds.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitMillis"
+ }
+ ]
+ },
+ "iteration_time": {
+ "description": "Runtime of the latest iteration of the analysis in milliseconds.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitMillis"
+ }
+ ]
+ }
+ },
+ "required": [
+ "elapsed_time"
+ ]
+ },
+ "ml._types.ValidationLoss": {
+ "type": "object",
+ "properties": {
+ "fold_values": {
+ "description": "Validation loss values for every added decision tree during the forest growing procedure.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "loss_type": {
+ "description": "The type of the loss metric. For example, binomial_logistic.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "fold_values",
+ "loss_type"
+ ]
+ },
+ "ml._types.DataframeAnalyticsStatsOutlierDetection": {
+ "type": "object",
+ "properties": {
+ "parameters": {
+ "description": "The list of job parameters specified by the user or determined by algorithmic heuristics.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.OutlierDetectionParameters"
+ }
+ ]
+ },
+ "timestamp": {
+ "description": "The timestamp when the statistics were reported in milliseconds since the epoch.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "timing_stats": {
+ "description": "An object containing time statistics about the data frame analytics job.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TimingStats"
+ }
+ ]
+ }
+ },
+ "required": [
+ "parameters",
+ "timestamp",
+ "timing_stats"
+ ]
+ },
+ "ml._types.OutlierDetectionParameters": {
+ "type": "object",
+ "properties": {
+ "compute_feature_influence": {
+ "description": "Specifies whether the feature influence calculation is enabled.",
+ "default": true,
+ "type": "boolean"
+ },
+ "feature_influence_threshold": {
+ "description": "The minimum outlier score that a document needs to have in order to calculate its feature influence score.\nValue range: 0-1",
+ "default": 0.1,
+ "type": "number"
+ },
+ "method": {
+ "description": "The method that outlier detection uses.\nAvailable methods are `lof`, `ldof`, `distance_kth_nn`, `distance_knn`, and `ensemble`.\nThe default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score.",
+ "type": "string"
+ },
+ "n_neighbors": {
+ "description": "Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score.\nWhen the value is not set, different values are used for different ensemble members.\nThis default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set.",
+ "type": "number"
+ },
+ "outlier_fraction": {
+ "description": "The proportion of the data set that is assumed to be outlying prior to outlier detection.\nFor example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers.",
+ "type": "number"
+ },
+ "standardization_enabled": {
+ "description": "If `true`, the following operation is performed on the columns before computing outlier scores: (x_i - mean(x_i)) / sd(x_i).",
+ "default": true,
+ "type": "boolean"
+ }
+ }
+ },
+ "ml._types.DataframeAnalyticsStatsDataCounts": {
+ "type": "object",
+ "properties": {
+ "skipped_docs_count": {
+ "description": "The number of documents that are skipped during the analysis because they contained values that are not supported by the analysis. For example, outlier detection does not support missing fields so it skips documents with missing fields. Likewise, all types of analysis skip documents that contain arrays with more than one element.",
+ "type": "number"
+ },
+ "test_docs_count": {
+ "description": "The number of documents that are not used for training the model and can be used for testing.",
+ "type": "number"
+ },
+ "training_docs_count": {
+ "description": "The number of documents that are used for training the model.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "skipped_docs_count",
+ "test_docs_count",
+ "training_docs_count"
+ ]
+ },
+ "ml._types.DataframeAnalyticsStatsMemoryUsage": {
+ "type": "object",
+ "properties": {
+ "memory_reestimate_bytes": {
+ "description": "This value is present when the status is hard_limit and it is a new estimate of how much memory the job needs.",
+ "type": "number"
+ },
+ "peak_usage_bytes": {
+ "description": "The number of bytes used at the highest peak of memory usage.",
+ "type": "number"
+ },
+ "status": {
+ "description": "The memory usage status.",
+ "type": "string"
+ },
+ "timestamp": {
+ "description": "The timestamp when memory usage was calculated.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ }
+ },
+ "required": [
+ "peak_usage_bytes",
+ "status"
+ ]
+ },
+ "ml._types.DataframeAnalyticsStatsProgress": {
+ "type": "object",
+ "properties": {
+ "phase": {
+ "description": "Defines the phase of the data frame analytics job.",
+ "type": "string"
+ },
+ "progress_percent": {
+ "description": "The progress that the data frame analytics job has made expressed in percentage.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "phase",
+ "progress_percent"
+ ]
+ },
+ "ml._types.DataframeState": {
+ "type": "string",
+ "enum": [
+ "started",
+ "stopped",
+ "starting",
+ "stopping",
+ "failed"
+ ]
+ },
+ "ml._types.DatafeedStats": {
+ "type": "object",
+ "properties": {
+ "assignment_explanation": {
+ "description": "For started datafeeds only, contains messages relating to the selection of a node.",
+ "type": "string"
+ },
+ "datafeed_id": {
+ "description": "A numerical character string that uniquely identifies the datafeed.\nThis identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.\nIt must start and end with alphanumeric characters.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "state": {
+ "description": "The status of the datafeed, which can be one of the following values: `starting`, `started`, `stopping`, `stopped`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DatafeedState"
+ }
+ ]
+ },
+ "timing_stats": {
+ "description": "An object that provides statistical information about timing aspect of this datafeed.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DatafeedTimingStats"
+ }
+ ]
+ },
+ "running_state": {
+ "description": "An object containing the running state for this datafeed.\nIt is only provided if the datafeed is started.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DatafeedRunningState"
+ }
+ ]
+ }
+ },
+ "required": [
+ "datafeed_id",
+ "state"
+ ]
+ },
+ "ml._types.DatafeedTimingStats": {
+ "type": "object",
+ "properties": {
+ "bucket_count": {
+ "description": "The number of buckets processed.",
+ "type": "number"
+ },
+ "exponential_average_search_time_per_hour_ms": {
+ "description": "The exponential average search time per hour, in milliseconds.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
+ }
+ ]
+ },
+ "exponential_average_calculation_context": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.ExponentialAverageCalculationContext"
+ }
+ ]
+ },
+ "job_id": {
+ "description": "Identifier for the anomaly detection job.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "search_count": {
+ "description": "The number of searches run by the datafeed.",
+ "type": "number"
+ },
+ "total_search_time_ms": {
+ "description": "The total time the datafeed spent searching, in milliseconds.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
+ }
+ ]
+ },
+ "average_search_time_per_bucket_ms": {
+ "description": "The average search time per bucket, in milliseconds.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
+ }
+ ]
+ }
+ },
+ "required": [
+ "bucket_count",
+ "exponential_average_search_time_per_hour_ms",
+ "job_id",
+ "search_count",
+ "total_search_time_ms"
+ ]
+ },
+ "_types.DurationValueUnitFloatMillis": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.UnitFloatMillis"
+ }
+ ]
+ },
+ "_types.UnitFloatMillis": {
+ "description": "Time unit for fractional milliseconds",
+ "type": "number"
+ },
+ "ml._types.ExponentialAverageCalculationContext": {
+ "type": "object",
+ "properties": {
+ "incremental_metric_value_ms": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
+ }
+ ]
+ },
+ "latest_timestamp": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "previous_exponential_average_ms": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
+ }
+ ]
+ }
+ },
+ "required": [
+ "incremental_metric_value_ms"
+ ]
+ },
+ "ml._types.DatafeedRunningState": {
+ "type": "object",
+ "properties": {
+ "real_time_configured": {
+ "description": "Indicates if the datafeed is \"real-time\"; meaning that the datafeed has no configured `end` time.",
+ "type": "boolean"
+ },
+ "real_time_running": {
+ "description": "Indicates whether the datafeed has finished running on the available past data.\nFor datafeeds without a configured `end` time, this means that the datafeed is now running on \"real-time\" data.",
+ "type": "boolean"
+ },
+ "search_interval": {
+ "description": "Provides the latest time interval the datafeed has searched.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.RunningStateSearchInterval"
+ }
+ ]
+ }
+ },
+ "required": [
+ "real_time_configured",
+ "real_time_running"
+ ]
+ },
+ "ml._types.RunningStateSearchInterval": {
+ "type": "object",
+ "properties": {
+ "end": {
+ "description": "The end time.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "end_ms": {
+ "description": "The end time as an epoch in milliseconds.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitMillis"
+ }
+ ]
+ },
+ "start": {
+ "description": "The start time.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "start_ms": {
+ "description": "The start time as an epoch in milliseconds.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitMillis"
+ }
+ ]
+ }
+ },
+ "required": [
+ "end_ms",
+ "start_ms"
+ ]
+ },
+ "ml._types.Datafeed": {
+ "type": "object",
+ "properties": {
+ "aggregations": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.AggregationContainer"
+ }
+ },
+ "authorization": {
+ "description": "The security privileges that the datafeed uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the datafeed, this property is omitted.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DatafeedAuthorization"
+ }
+ ]
+ },
+ "chunking_config": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.ChunkingConfig"
+ }
+ ]
+ },
+ "datafeed_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "frequency": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "indices": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "indexes": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "job_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "max_empty_searches": {
+ "type": "number"
+ },
+ "query": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl"
+ },
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "query_delay": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "script_fields": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.ScriptField"
+ }
+ },
+ "scroll_size": {
+ "type": "number"
+ },
+ "delayed_data_check_config": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig"
+ }
+ ]
+ },
+ "runtime_mappings": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RuntimeFields"
+ }
+ ]
+ },
+ "indices_options": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndicesOptions"
+ }
+ ]
+ }
+ },
+ "required": [
+ "datafeed_id",
+ "indices",
+ "job_id",
+ "query",
+ "delayed_data_check_config"
+ ]
+ },
+ "ml._types.DatafeedAuthorization": {
+ "type": "object",
+ "properties": {
+ "api_key": {
+ "description": "If an API key was used for the most recent update to the datafeed, its name and identifier are listed in the response.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.ApiKeyAuthorization"
+ }
+ ]
+ },
+ "roles": {
+ "description": "If a user ID was used for the most recent update to the datafeed, its roles at the time of the update are listed in the response.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "service_account": {
+ "description": "If a service account was used for the most recent update to the datafeed, the account name is listed in the response.",
+ "type": "string"
+ }
+ }
+ },
+ "ml._types.ChunkingConfig": {
+ "type": "object",
+ "properties": {
+ "mode": {
+ "description": "If the mode is `auto`, the chunk size is dynamically calculated;\nthis is the recommended value when the datafeed does not use aggregations.\nIf the mode is `manual`, chunking is applied according to the specified `time_span`;\nuse this mode when the datafeed uses aggregations. If the mode is `off`, no chunking is applied.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.ChunkingMode"
+ }
+ ]
+ },
+ "time_span": {
+ "description": "The time span that each search will be querying. This setting is applicable only when the `mode` is set to `manual`.",
+ "default": "3h",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ }
+ },
+ "required": [
+ "mode"
+ ]
+ },
+ "ml._types.ChunkingMode": {
+ "type": "string",
+ "enum": [
+ "auto",
+ "manual",
+ "off"
+ ]
+ },
+ "ml._types.DelayedDataCheckConfig": {
+ "type": "object",
+ "properties": {
+ "check_window": {
+ "description": "The window of time that is searched for late data. This window of time ends with the latest finalized bucket.\nIt defaults to null, which causes an appropriate `check_window` to be calculated when the real-time datafeed runs.\nIn particular, the default `check_window` span calculation is based on the maximum of `2h` or `8 * bucket_span`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "enabled": {
+ "description": "Specifies whether the datafeed periodically checks for delayed data.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "enabled"
+ ]
+ },
+ "_types.IndicesOptions": {
+ "description": "Controls how to deal with unavailable concrete indices (closed or missing), how wildcard expressions are expanded\nto actual indices (all, closed or open indices) and how to deal with wildcard expressions that resolve to no indices.",
+ "type": "object",
+ "properties": {
+ "allow_no_indices": {
+ "description": "If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only\nmissing or closed indices. This behavior applies even if the request targets other open indices. For example,\na request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.",
+ "type": "boolean"
+ },
+ "expand_wildcards": {
+ "description": "Type of index that wildcard patterns can match. If the request can target data streams, this argument\ndetermines whether wildcard expressions match hidden data streams. Supports comma-separated values,\nsuch as `open,hidden`.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ExpandWildcards"
+ }
+ ]
+ },
+ "ignore_unavailable": {
+ "description": "If true, missing or closed indices are not included in the response.",
+ "default": false,
+ "type": "boolean"
+ },
+ "ignore_throttled": {
+ "description": "If true, concrete, expanded or aliased indices are ignored when frozen.",
+ "default": true,
+ "type": "boolean"
+ }
+ }
+ },
+ "ml._types.Filter": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "A description of the filter.",
+ "type": "string"
+ },
+ "filter_id": {
+ "description": "A string that uniquely identifies a filter.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "items": {
+ "description": "An array of strings which is the filter item list.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "filter_id",
+ "items"
+ ]
+ },
+ "ml._types.JobStats": {
+ "type": "object",
+ "properties": {
+ "assignment_explanation": {
+ "description": "For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job.",
+ "type": "string"
+ },
+ "data_counts": {
+ "description": "An object that describes the quantity of input to the job and any related error counts.\nThe `data_count` values are cumulative for the lifetime of a job.\nIf a model snapshot is reverted or old results are deleted, the job counts are not reset.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataCounts"
+ }
+ ]
+ },
+ "forecasts_stats": {
+ "description": "An object that provides statistical information about forecasts belonging to this job.\nSome statistics are omitted if no forecasts have been made.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.JobForecastStatistics"
+ }
+ ]
+ },
+ "job_id": {
+ "description": "Identifier for the anomaly detection job.",
+ "type": "string"
+ },
+ "model_size_stats": {
+ "description": "An object that provides information about the size and contents of the model.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.ModelSizeStats"
+ }
+ ]
+ },
+ "open_time": {
+ "description": "For open jobs only, the elapsed time for which the job has been open.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "state": {
+ "description": "The status of the anomaly detection job, which can be one of the following values: `closed`, `closing`, `failed`, `opened`, `opening`.\n\nSupported values include:\n - `closing`: The job close action is in progress and has not yet completed. A closing job cannot accept further data.\n - `closed`: The job finished successfully with its model state persisted. The job must be opened before it can accept further data.\n - `opened`: The job is available to receive and process data.\n - `failed`: The job did not finish successfully due to an error.\nThis situation can occur due to invalid input data, a fatal error occurring during the analysis, or an external interaction such as the process being killed by the Linux out of memory (OOM) killer.\nIf the job had irrevocably failed, it must be force closed and then deleted.\nIf the datafeed can be corrected, the job can be closed and then re-opened.\n - `opening`: The job open action is in progress and has not yet completed.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.JobState"
+ }
+ ]
+ },
+ "timing_stats": {
+ "description": "An object that provides statistical information about timing aspect of this job.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.JobTimingStats"
+ }
+ ]
+ },
+ "deleting": {
+ "description": "Indicates that the process of deleting the job is in progress but not yet completed. It is only reported when `true`.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "data_counts",
+ "forecasts_stats",
+ "job_id",
+ "model_size_stats",
+ "state",
+ "timing_stats"
+ ]
+ },
+ "ml._types.DataCounts": {
+ "type": "object",
+ "properties": {
+ "bucket_count": {
+ "type": "number"
+ },
+ "earliest_record_timestamp": {
+ "type": "number"
+ },
+ "empty_bucket_count": {
+ "type": "number"
+ },
+ "input_bytes": {
+ "type": "number"
+ },
+ "input_field_count": {
+ "type": "number"
+ },
+ "input_record_count": {
+ "type": "number"
+ },
+ "invalid_date_count": {
+ "type": "number"
+ },
+ "job_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "last_data_time": {
+ "type": "number"
+ },
+ "latest_empty_bucket_timestamp": {
+ "type": "number"
+ },
+ "latest_record_timestamp": {
+ "type": "number"
+ },
+ "latest_sparse_bucket_timestamp": {
+ "type": "number"
+ },
+ "latest_bucket_timestamp": {
+ "type": "number"
+ },
+ "log_time": {
+ "type": "number"
+ },
+ "missing_field_count": {
+ "type": "number"
+ },
+ "out_of_order_timestamp_count": {
+ "type": "number"
+ },
+ "processed_field_count": {
+ "type": "number"
+ },
+ "processed_record_count": {
+ "type": "number"
+ },
+ "sparse_bucket_count": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "bucket_count",
+ "empty_bucket_count",
+ "input_bytes",
+ "input_field_count",
+ "input_record_count",
+ "invalid_date_count",
+ "job_id",
+ "missing_field_count",
+ "out_of_order_timestamp_count",
+ "processed_field_count",
+ "processed_record_count",
+ "sparse_bucket_count"
+ ]
+ },
+ "ml._types.JobForecastStatistics": {
+ "type": "object",
+ "properties": {
+ "memory_bytes": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.JobStatistics"
+ }
+ ]
+ },
+ "processing_time_ms": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.JobStatistics"
+ }
+ ]
+ },
+ "records": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.JobStatistics"
+ }
+ ]
+ },
+ "status": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "number"
+ }
+ },
+ "total": {
+ "type": "number"
+ },
+ "forecasted_jobs": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "total",
+ "forecasted_jobs"
+ ]
+ },
+ "ml._types.JobStatistics": {
+ "type": "object",
+ "properties": {
+ "avg": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ },
+ "total": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "avg",
+ "max",
+ "min",
+ "total"
+ ]
+ },
+ "ml._types.ModelSizeStats": {
+ "type": "object",
+ "properties": {
+ "bucket_allocation_failures_count": {
+ "type": "number"
+ },
+ "job_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "log_time": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "memory_status": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.MemoryStatus"
+ }
+ ]
+ },
+ "model_bytes": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "model_bytes_exceeded": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "model_bytes_memory_limit": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "output_memory_allocator_bytes": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "peak_model_bytes": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "assignment_memory_basis": {
+ "type": "string"
+ },
+ "result_type": {
+ "type": "string"
+ },
+ "total_by_field_count": {
+ "type": "number"
+ },
+ "total_over_field_count": {
+ "type": "number"
+ },
+ "total_partition_field_count": {
+ "type": "number"
+ },
+ "categorization_status": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.CategorizationStatus"
+ }
+ ]
+ },
+ "categorized_doc_count": {
+ "type": "number"
+ },
+ "dead_category_count": {
+ "type": "number"
+ },
+ "failed_category_count": {
+ "type": "number"
+ },
+ "frequent_category_count": {
+ "type": "number"
+ },
+ "rare_category_count": {
+ "type": "number"
+ },
+ "total_category_count": {
+ "type": "number"
+ },
+ "timestamp": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "bucket_allocation_failures_count",
+ "job_id",
+ "log_time",
+ "memory_status",
+ "model_bytes",
+ "result_type",
+ "total_by_field_count",
+ "total_over_field_count",
+ "total_partition_field_count",
+ "categorization_status",
+ "categorized_doc_count",
+ "dead_category_count",
+ "failed_category_count",
+ "frequent_category_count",
+ "rare_category_count",
+ "total_category_count"
+ ]
+ },
+ "ml._types.JobTimingStats": {
+ "type": "object",
+ "properties": {
+ "average_bucket_processing_time_ms": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
+ }
+ ]
+ },
+ "bucket_count": {
+ "type": "number"
+ },
+ "exponential_average_bucket_processing_time_ms": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
+ }
+ ]
+ },
+ "exponential_average_bucket_processing_time_per_hour_ms": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
+ }
+ ]
+ },
+ "job_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "total_bucket_processing_time_ms": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
+ }
+ ]
+ },
+ "maximum_bucket_processing_time_ms": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
+ }
+ ]
+ },
+ "minimum_bucket_processing_time_ms": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
+ }
+ ]
+ }
+ },
+ "required": [
+ "bucket_count",
+ "exponential_average_bucket_processing_time_per_hour_ms",
+ "job_id",
+ "total_bucket_processing_time_ms"
+ ]
+ },
+ "ml._types.Job": {
+ "type": "object",
+ "properties": {
+ "allow_lazy_open": {
+ "description": "Advanced configuration option.\nSpecifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node.",
+ "type": "boolean"
+ },
+ "analysis_config": {
+ "description": "The analysis configuration, which specifies how to analyze the data.\nAfter you create a job, you cannot change the analysis configuration; all the properties are informational.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.AnalysisConfig"
+ }
+ ]
+ },
+ "analysis_limits": {
+ "description": "Limits can be applied for the resources required to hold the mathematical models in memory.\nThese limits are approximate and can be set per job.\nThey do not control the memory used by other processes, for example the Elasticsearch Java processes.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.AnalysisLimits"
+ }
+ ]
+ },
+ "background_persist_interval": {
+ "description": "Advanced configuration option.\nThe time between each periodic persistence of the model.\nThe default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time.\nThe smallest allowed value is 1 hour.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "blocked": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.JobBlocked"
+ }
+ ]
+ },
+ "create_time": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "custom_settings": {
+ "description": "Advanced configuration option.\nContains custom metadata about the job.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.CustomSettings"
+ }
+ ]
+ },
+ "daily_model_snapshot_retention_after_days": {
+ "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job.\nIt specifies a period of time (in days) after which only the first snapshot per day is retained.\nThis period is relative to the timestamp of the most recent snapshot for this job.\nValid values range from 0 to `model_snapshot_retention_days`.",
+ "default": 1.0,
+ "type": "number"
+ },
+ "data_description": {
+ "description": "The data description defines the format of the input data when you send data to the job by using the post data API.\nNote that when configuring a datafeed, these properties are automatically set.\nWhen data is received via the post data API, it is not stored in Elasticsearch.\nOnly the results for anomaly detection are retained.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataDescription"
+ }
+ ]
+ },
+ "datafeed_config": {
+ "description": "The datafeed, which retrieves data from Elasticsearch for analysis by the job.\nYou can associate only one datafeed with each anomaly detection job.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.Datafeed"
+ }
+ ]
+ },
+ "deleting": {
+ "description": "Indicates that the process of deleting the job is in progress but not yet completed.\nIt is only reported when `true`.",
+ "type": "boolean"
+ },
+ "description": {
+ "description": "A description of the job.",
+ "type": "string"
+ },
+ "finished_time": {
+ "description": "If the job closed or failed, this is the time the job finished, otherwise it is `null`.\nThis property is informational; you cannot change its value.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "groups": {
+ "description": "A list of job groups.\nA job can belong to no groups or many.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "job_id": {
+ "description": "Identifier for the anomaly detection job.\nThis identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.\nIt must start and end with alphanumeric characters.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "job_type": {
+ "description": "Reserved for future use, currently set to `anomaly_detector`.",
+ "type": "string"
+ },
+ "job_version": {
+ "description": "The machine learning configuration version number at which the the job was created.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ },
+ "model_plot_config": {
+ "description": "This advanced configuration option stores model information along with the results.\nIt provides a more detailed view into anomaly detection.\nModel plot provides a simplified and indicative view of the model and its bounds.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.ModelPlotConfig"
+ }
+ ]
+ },
+ "model_snapshot_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "model_snapshot_retention_days": {
+ "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job.\nIt specifies the maximum period of time (in days) that snapshots are retained.\nThis period is relative to the timestamp of the most recent snapshot for this job.\nBy default, snapshots ten days older than the newest snapshot are deleted.",
+ "type": "number"
+ },
+ "renormalization_window_days": {
+ "description": "Advanced configuration option.\nThe period over which adjustments to the score are applied, as new data is seen.\nThe default value is the longer of 30 days or 100 `bucket_spans`.",
+ "type": "number"
+ },
+ "results_index_name": {
+ "description": "A text string that affects the name of the machine learning results index.\nThe default value is `shared`, which generates an index named `.ml-anomalies-shared`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "results_retention_days": {
+ "description": "Advanced configuration option.\nThe period of time (in days) that results are retained.\nAge is calculated relative to the timestamp of the latest bucket result.\nIf this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch.\nThe default value is null, which means all results are retained.\nAnnotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results.\nAnnotations added by users are retained forever.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "allow_lazy_open",
+ "analysis_config",
+ "data_description",
+ "job_id",
+ "model_snapshot_retention_days",
+ "results_index_name"
+ ]
+ },
+ "ml._types.AnalysisLimits": {
+ "type": "object",
+ "properties": {
+ "categorization_examples_limit": {
+ "description": "The maximum number of examples stored per category in memory and in the results data store. If you increase this value, more examples are available, however it requires that you have more storage available. If you set this value to 0, no examples are stored. NOTE: The `categorization_examples_limit` applies only to analysis that uses categorization.",
+ "default": 4.0,
+ "type": "number"
+ },
+ "model_memory_limit": {
+ "description": "The approximate maximum amount of memory resources that are required for analytical processing. Once this limit is approached, data pruning becomes more aggressive. Upon exceeding this limit, new entities are not modeled. If the `xpack.ml.max_model_memory_limit` setting has a value greater than 0 and less than 1024mb, that value is used instead of the default. The default value is relatively small to ensure that high resource usage is a conscious decision. If you have jobs that are expected to analyze high cardinality fields, you will likely need to use a higher value. If you specify a number instead of a string, the units are assumed to be MiB. Specifying a string is recommended for clarity. If you specify a byte size unit of `b` or `kb` and the number does not equate to a discrete number of megabytes, it is rounded down to the closest MiB. The minimum valid value is 1 MiB. If you specify a value less than 1 MiB, an error occurs. If you specify a value for the `xpack.ml.max_model_memory_limit` setting, an error occurs when you try to create jobs that have `model_memory_limit` values greater than that setting value.",
+ "default": "1024mb",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ }
+ }
+ },
+ "ml._types.JobBlocked": {
+ "type": "object",
+ "properties": {
+ "reason": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.JobBlockedReason"
+ }
+ ]
+ },
+ "task_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.TaskId"
+ }
+ ]
+ }
+ },
+ "required": [
+ "reason"
+ ]
+ },
+ "ml._types.JobBlockedReason": {
+ "type": "string",
+ "enum": [
+ "delete",
+ "reset",
+ "revert"
+ ]
+ },
+ "ml._types.CustomSettings": {
+ "description": "Custom metadata about the job",
+ "type": "object"
+ },
+ "ml._types.DataDescription": {
+ "type": "object",
+ "properties": {
+ "format": {
+ "description": "Only JSON format is supported at this time.",
+ "type": "string"
+ },
+ "time_field": {
+ "description": "The name of the field that contains the timestamp.",
+ "default": "time",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "time_format": {
+ "description": "The time format, which can be `epoch`, `epoch_ms`, or a custom pattern. The value `epoch` refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The value `epoch_ms` indicates that time is measured in milliseconds since the epoch. The `epoch` and `epoch_ms` time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: `yyyy-MM-dd'T'HH:mm:ssX`. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails.",
+ "default": "epoch",
+ "type": "string"
+ },
+ "field_delimiter": {
+ "type": "string"
+ }
+ }
+ },
+ "ml._types.ModelPlotConfig": {
+ "type": "object",
+ "properties": {
+ "annotations_enabled": {
+ "description": "If true, enables calculation and storage of the model change annotations for each entity that is being analyzed.",
+ "default": true,
+ "x-state": "Generally available",
+ "type": "boolean"
+ },
+ "enabled": {
+ "description": "If true, enables calculation and storage of the model bounds for each entity that is being analyzed.",
+ "default": false,
+ "type": "boolean"
+ },
+ "terms": {
+ "description": "Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ }
+ },
+ "ml._types.OverallBucket": {
+ "type": "object",
+ "properties": {
+ "bucket_span": {
+ "description": "The length of the bucket in seconds. Matches the job with the longest bucket_span value.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitSeconds"
+ }
+ ]
+ },
+ "is_interim": {
+ "description": "If true, this is an interim result. In other words, the results are calculated based on partial input data.",
+ "type": "boolean"
+ },
+ "jobs": {
+ "description": "An array of objects that contain the max_anomaly_score per job_id.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.OverallBucketJob"
+ }
+ },
+ "overall_score": {
+ "description": "The top_n average of the maximum bucket anomaly_score per job.",
+ "type": "number"
+ },
+ "result_type": {
+ "description": "Internal. This is always set to overall_bucket.",
+ "type": "string"
+ },
+ "timestamp": {
+ "description": "The start time of the bucket for which these results were calculated.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "timestamp_string": {
+ "description": "The start time of the bucket for which these results were calculated.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ }
+ },
+ "required": [
+ "bucket_span",
+ "is_interim",
+ "jobs",
+ "overall_score",
+ "result_type",
+ "timestamp"
+ ]
+ },
+ "_types.DurationValueUnitSeconds": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.UnitSeconds"
+ }
+ ]
+ },
+ "ml._types.OverallBucketJob": {
+ "type": "object",
+ "properties": {
+ "job_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "max_anomaly_score": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "job_id",
+ "max_anomaly_score"
+ ]
+ },
+ "ml._types.Include": {
+ "type": "string",
+ "enum": [
+ "definition",
+ "feature_importance_baseline",
+ "hyperparameters",
+ "total_feature_importance",
+ "definition_status"
+ ]
+ },
+ "ml._types.TrainedModelConfig": {
+ "type": "object",
+ "properties": {
+ "model_id": {
+ "description": "Identifier for the trained model.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "model_type": {
+ "description": "The model type\n\nSupported values include:\n - `tree_ensemble`: The model definition is an ensemble model of decision trees.\n - `lang_ident`: A special type reserved for language identification models.\n - `pytorch`: The stored definition is a PyTorch (specifically a TorchScript) model.\nCurrently only NLP models are supported.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TrainedModelType"
+ }
+ ]
+ },
+ "tags": {
+ "description": "A comma delimited string of tags. A trained model can have many tags, or none.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "version": {
+ "description": "The Elasticsearch version number in which the trained model was created.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ },
+ "compressed_definition": {
+ "type": "string"
+ },
+ "created_by": {
+ "description": "Information on the creator of the trained model.",
+ "type": "string"
+ },
+ "create_time": {
+ "description": "The time when the trained model was created.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "default_field_map": {
+ "description": "Any field map described in the inference configuration takes precedence.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "description": "The free-text description of the trained model.",
+ "type": "string"
+ },
+ "estimated_heap_memory_usage_bytes": {
+ "description": "The estimated heap usage in bytes to keep the trained model in memory.",
+ "type": "number"
+ },
+ "estimated_operations": {
+ "description": "The estimated number of operations to use the trained model.",
+ "type": "number"
+ },
+ "fully_defined": {
+ "description": "True if the full model definition is present.",
+ "type": "boolean"
+ },
+ "inference_config": {
+ "description": "The default configuration for inference. This can be either a regression, classification, or one of the many NLP focused configurations. It must match the underlying definition.trained_model's target_type. For pre-packaged models such as ELSER the config is not required.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.InferenceConfigCreateContainer"
+ }
+ ]
+ },
+ "input": {
+ "description": "The input field names for the model definition.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TrainedModelConfigInput"
+ }
+ ]
+ },
+ "license_level": {
+ "description": "The license level of the trained model.",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "An object containing metadata about the trained model. For example, models created by data frame analytics contain analysis_config and input objects.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TrainedModelConfigMetadata"
+ }
+ ]
+ },
+ "model_size_bytes": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "model_package": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.ModelPackageConfig"
+ }
+ ]
+ },
+ "location": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TrainedModelLocation"
+ }
+ ]
+ },
+ "platform_architecture": {
+ "type": "string"
+ },
+ "prefix_strings": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TrainedModelPrefixStrings"
+ }
+ ]
+ }
+ },
+ "required": [
+ "model_id",
+ "tags",
+ "input"
+ ]
+ },
+ "ml._types.TrainedModelType": {
+ "type": "string",
+ "enum": [
+ "tree_ensemble",
+ "lang_ident",
+ "pytorch"
+ ]
+ },
+ "ml._types.InferenceConfigCreateContainer": {
+ "description": "Inference configuration provided when storing the model config",
+ "type": "object",
+ "properties": {
+ "regression": {
+ "description": "Regression configuration for inference.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.RegressionInferenceOptions"
+ }
+ ]
+ },
+ "classification": {
+ "description": "Classification configuration for inference.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.ClassificationInferenceOptions"
+ }
+ ]
+ },
+ "text_classification": {
+ "description": "Text classification configuration for inference.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TextClassificationInferenceOptions"
+ }
+ ]
+ },
+ "zero_shot_classification": {
+ "description": "Zeroshot classification configuration for inference.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.ZeroShotClassificationInferenceOptions"
+ }
+ ]
+ },
+ "fill_mask": {
+ "description": "Fill mask configuration for inference.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.FillMaskInferenceOptions"
+ }
+ ]
+ },
+ "learning_to_rank": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.LearningToRankConfig"
+ }
+ ]
+ },
+ "ner": {
+ "description": "Named entity recognition configuration for inference.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.NerInferenceOptions"
+ }
+ ]
+ },
+ "pass_through": {
+ "description": "Pass through configuration for inference.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.PassThroughInferenceOptions"
+ }
+ ]
+ },
+ "text_embedding": {
+ "description": "Text embedding configuration for inference.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TextEmbeddingInferenceOptions"
+ }
+ ]
+ },
+ "text_expansion": {
+ "description": "Text expansion configuration for inference.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TextExpansionInferenceOptions"
+ }
+ ]
+ },
+ "question_answering": {
+ "description": "Question answering configuration for inference.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.QuestionAnsweringInferenceOptions"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "ml._types.TextClassificationInferenceOptions": {
+ "description": "Text classification configuration options",
+ "type": "object",
+ "properties": {
+ "num_top_classes": {
+ "description": "Specifies the number of top class predictions to return. Defaults to 0.",
+ "type": "number"
+ },
+ "tokenization": {
+ "description": "The tokenization options",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer"
+ }
+ ]
+ },
+ "results_field": {
+ "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
+ "type": "string"
+ },
+ "classification_labels": {
+ "description": "Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "vocabulary": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.Vocabulary"
+ }
+ ]
+ }
+ }
+ },
+ "ml._types.TokenizationConfigContainer": {
+ "description": "Tokenization options stored in inference configuration",
+ "type": "object",
+ "properties": {
+ "bert": {
+ "description": "Indicates BERT tokenization and its options",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.NlpBertTokenizationConfig"
+ }
+ ]
+ },
+ "bert_ja": {
+ "description": "Indicates BERT Japanese tokenization and its options",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.NlpBertTokenizationConfig"
+ }
+ ]
+ },
+ "mpnet": {
+ "description": "Indicates MPNET tokenization and its options",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.NlpBertTokenizationConfig"
+ }
+ ]
+ },
+ "roberta": {
+ "description": "Indicates RoBERTa tokenization and its options",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.NlpRobertaTokenizationConfig"
+ }
+ ]
+ },
+ "xlm_roberta": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.XlmRobertaTokenizationConfig"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "ml._types.NlpBertTokenizationConfig": {
+ "description": "BERT and MPNet tokenization configuration options",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.CommonTokenizationConfig"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "ml._types.CommonTokenizationConfig": {
+ "type": "object",
+ "properties": {
+ "do_lower_case": {
+ "description": "Should the tokenizer lower case the text",
+ "default": false,
+ "type": "boolean"
+ },
+ "max_sequence_length": {
+ "description": "Maximum input sequence length for the model",
+ "default": 512.0,
+ "type": "number"
+ },
+ "span": {
+ "description": "Tokenization spanning options. Special value of -1 indicates no spanning takes place",
+ "default": -1.0,
+ "type": "number"
+ },
+ "truncate": {
+ "description": "Should tokenization input be automatically truncated before sending to the model for inference",
+ "default": "first",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TokenizationTruncate"
+ }
+ ]
+ },
+ "with_special_tokens": {
+ "description": "Is tokenization completed with special tokens",
+ "default": true,
+ "type": "boolean"
+ }
+ }
+ },
+ "ml._types.TokenizationTruncate": {
+ "type": "string",
+ "enum": [
+ "first",
+ "second",
+ "none"
+ ]
+ },
+ "ml._types.NlpRobertaTokenizationConfig": {
+ "description": "RoBERTa tokenization configuration options",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.CommonTokenizationConfig"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "add_prefix_space": {
+ "description": "Should the tokenizer prefix input with a space character",
+ "default": false,
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "ml._types.XlmRobertaTokenizationConfig": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.CommonTokenizationConfig"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "ml._types.Vocabulary": {
+ "type": "object",
+ "properties": {
+ "index": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ }
+ },
+ "required": [
+ "index"
+ ]
+ },
+ "ml._types.ZeroShotClassificationInferenceOptions": {
+ "description": "Zero shot classification configuration options",
+ "type": "object",
+ "properties": {
+ "tokenization": {
+ "description": "The tokenization options to update when inferring",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer"
+ }
+ ]
+ },
+ "hypothesis_template": {
+ "description": "Hypothesis template used when tokenizing labels for prediction",
+ "default": "\"This example is {}.\"",
+ "type": "string"
+ },
+ "classification_labels": {
+ "description": "The zero shot classification labels indicating entailment, neutral, and contradiction\nMust contain exactly and only entailment, neutral, and contradiction",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "results_field": {
+ "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
+ "type": "string"
+ },
+ "multi_label": {
+ "description": "Indicates if more than one true label exists.",
+ "default": false,
+ "type": "boolean"
+ },
+ "labels": {
+ "description": "The labels to predict.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "classification_labels"
+ ]
+ },
+ "ml._types.FillMaskInferenceOptions": {
+ "description": "Fill mask inference options",
+ "type": "object",
+ "properties": {
+ "mask_token": {
+ "description": "The string/token which will be removed from incoming documents and replaced with the inference prediction(s).\nIn a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer\nhas a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests.\nHowever, if this field is present in a request, its value must match the predefined value for that model/tokenizer,\notherwise the request will fail.",
+ "type": "string"
+ },
+ "num_top_classes": {
+ "description": "Specifies the number of top class predictions to return. Defaults to 0.",
+ "type": "number"
+ },
+ "tokenization": {
+ "description": "The tokenization options to update when inferring",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer"
+ }
+ ]
+ },
+ "results_field": {
+ "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
+ "type": "string"
+ },
+ "vocabulary": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.Vocabulary"
+ }
+ ]
+ }
+ },
+ "required": [
+ "vocabulary"
+ ]
+ },
+ "ml._types.LearningToRankConfig": {
+ "type": "object",
+ "properties": {
+ "default_params": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "feature_extractors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/ml._types.FeatureExtractor"
+ }
+ }
+ },
+ "num_top_feature_importance_values": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "num_top_feature_importance_values"
+ ]
+ },
+ "ml._types.FeatureExtractor": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.QueryFeatureExtractor"
+ }
+ ]
+ },
+ "ml._types.QueryFeatureExtractor": {
+ "type": "object",
+ "properties": {
+ "default_score": {
+ "type": "number"
+ },
+ "feature_name": {
+ "type": "string"
+ },
+ "query": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ }
+ },
+ "required": [
+ "feature_name",
+ "query"
+ ]
+ },
+ "ml._types.NerInferenceOptions": {
+ "description": "Named entity recognition options",
+ "type": "object",
+ "properties": {
+ "tokenization": {
+ "description": "The tokenization options",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer"
+ }
+ ]
+ },
+ "results_field": {
+ "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
+ "type": "string"
+ },
+ "classification_labels": {
+ "description": "The token classification labels. Must be IOB formatted tags",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "vocabulary": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.Vocabulary"
+ }
+ ]
+ }
+ }
+ },
+ "ml._types.PassThroughInferenceOptions": {
+ "description": "Pass through configuration options",
+ "type": "object",
+ "properties": {
+ "tokenization": {
+ "description": "The tokenization options",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer"
+ }
+ ]
+ },
+ "results_field": {
+ "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
+ "type": "string"
+ },
+ "vocabulary": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.Vocabulary"
+ }
+ ]
+ }
+ }
+ },
+ "ml._types.TextEmbeddingInferenceOptions": {
+ "description": "Text embedding inference options",
+ "type": "object",
+ "properties": {
+ "embedding_size": {
+ "description": "The number of dimensions in the embedding output",
+ "type": "number"
+ },
+ "tokenization": {
+ "description": "The tokenization options",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer"
+ }
+ ]
+ },
+ "results_field": {
+ "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
+ "type": "string"
+ },
+ "vocabulary": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.Vocabulary"
+ }
+ ]
+ }
+ },
+ "required": [
+ "vocabulary"
+ ]
+ },
+ "ml._types.TextExpansionInferenceOptions": {
+ "description": "Text expansion inference options",
+ "type": "object",
+ "properties": {
+ "tokenization": {
+ "description": "The tokenization options",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer"
+ }
+ ]
+ },
+ "results_field": {
+ "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
+ "type": "string"
+ },
+ "vocabulary": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.Vocabulary"
+ }
+ ]
+ }
+ },
+ "required": [
+ "vocabulary"
+ ]
+ },
+ "ml._types.QuestionAnsweringInferenceOptions": {
+ "description": "Question answering inference options",
+ "type": "object",
+ "properties": {
+ "num_top_classes": {
+ "description": "Specifies the number of top class predictions to return. Defaults to 0.",
+ "type": "number"
+ },
+ "tokenization": {
+ "description": "The tokenization options to update when inferring",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TokenizationConfigContainer"
+ }
+ ]
+ },
+ "results_field": {
+ "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
+ "type": "string"
+ },
+ "max_answer_length": {
+ "description": "The maximum answer length to consider",
+ "type": "number"
+ }
+ }
+ },
+ "ml._types.TrainedModelConfigInput": {
+ "type": "object",
+ "properties": {
+ "field_names": {
+ "description": "An array of input field names for the model.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ }
+ },
+ "required": [
+ "field_names"
+ ]
+ },
+ "ml._types.TrainedModelConfigMetadata": {
+ "type": "object",
+ "properties": {
+ "model_aliases": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "feature_importance_baseline": {
+ "description": "An object that contains the baseline for feature importance values. For regression analysis, it is a single value. For classification analysis, there is a value for each class.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "hyperparameters": {
+ "description": "List of the available hyperparameters optimized during the fine_parameter_tuning phase as well as specified by the user.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.Hyperparameter"
+ }
+ },
+ "total_feature_importance": {
+ "description": "An array of the total feature importance for each feature used from the training data set. This array of objects is returned if data frame analytics trained the model and the request includes total_feature_importance in the include request parameter.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.TotalFeatureImportance"
+ }
+ }
+ }
+ },
+ "ml._types.Hyperparameter": {
+ "type": "object",
+ "properties": {
+ "absolute_importance": {
+ "description": "A positive number showing how much the parameter influences the variation of the loss function. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization.",
+ "type": "number"
+ },
+ "name": {
+ "description": "Name of the hyperparameter.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "relative_importance": {
+ "description": "A number between 0 and 1 showing the proportion of influence on the variation of the loss function among all tuned hyperparameters. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization.",
+ "type": "number"
+ },
+ "supplied": {
+ "description": "Indicates if the hyperparameter is specified by the user (true) or optimized (false).",
+ "type": "boolean"
+ },
+ "value": {
+ "description": "The value of the hyperparameter, either optimized or specified by the user.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "name",
+ "supplied",
+ "value"
+ ]
+ },
+ "ml._types.TotalFeatureImportance": {
+ "type": "object",
+ "properties": {
+ "feature_name": {
+ "description": "The feature for which this importance was calculated.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "importance": {
+ "description": "A collection of feature importance statistics related to the training data set for this particular feature.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.TotalFeatureImportanceStatistics"
+ }
+ },
+ "classes": {
+ "description": "If the trained model is a classification model, feature importance statistics are gathered per target class value.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.TotalFeatureImportanceClass"
+ }
+ }
+ },
+ "required": [
+ "feature_name",
+ "importance",
+ "classes"
+ ]
+ },
+ "ml._types.TotalFeatureImportanceStatistics": {
+ "type": "object",
+ "properties": {
+ "mean_magnitude": {
+ "description": "The average magnitude of this feature across all the training data. This value is the average of the absolute values of the importance for this feature.",
+ "type": "number"
+ },
+ "max": {
+ "description": "The maximum importance value across all the training data for this feature.",
+ "type": "number"
+ },
+ "min": {
+ "description": "The minimum importance value across all the training data for this feature.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "mean_magnitude",
+ "max",
+ "min"
+ ]
+ },
+ "ml._types.TotalFeatureImportanceClass": {
+ "type": "object",
+ "properties": {
+ "class_name": {
+ "description": "The target class value. Could be a string, boolean, or number.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "importance": {
+ "description": "A collection of feature importance statistics related to the training data set for this particular feature.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.TotalFeatureImportanceStatistics"
+ }
+ }
+ },
+ "required": [
+ "class_name",
+ "importance"
+ ]
+ },
+ "ml._types.ModelPackageConfig": {
+ "type": "object",
+ "properties": {
+ "create_time": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "description": {
+ "type": "string"
+ },
+ "inference_config": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "metadata": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ },
+ "minimum_version": {
+ "type": "string"
+ },
+ "model_repository": {
+ "type": "string"
+ },
+ "model_type": {
+ "type": "string"
+ },
+ "packaged_model_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "platform_architecture": {
+ "type": "string"
+ },
+ "prefix_strings": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TrainedModelPrefixStrings"
+ }
+ ]
+ },
+ "size": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "sha256": {
+ "type": "string"
+ },
+ "tags": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "vocabulary_file": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "packaged_model_id"
+ ]
+ },
+ "ml._types.TrainedModelPrefixStrings": {
+ "type": "object",
+ "properties": {
+ "ingest": {
+ "description": "String prepended to input at ingest",
+ "type": "string"
+ },
+ "search": {
+ "description": "String prepended to input at search",
+ "type": "string"
+ }
+ }
+ },
+ "ml._types.TrainedModelLocation": {
+ "type": "object",
+ "properties": {
+ "index": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TrainedModelLocationIndex"
+ }
+ ]
+ }
+ },
+ "required": [
+ "index"
+ ]
+ },
+ "ml._types.TrainedModelLocationIndex": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "ml._types.TrainedModelStats": {
+ "type": "object",
+ "properties": {
+ "deployment_stats": {
+ "description": "A collection of deployment stats, which is present when the models are deployed.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TrainedModelDeploymentStats"
+ }
+ ]
+ },
+ "inference_stats": {
+ "description": "A collection of inference stats fields.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TrainedModelInferenceStats"
+ }
+ ]
+ },
+ "ingest": {
+ "description": "A collection of ingest stats for the model across all nodes.\nThe values are summations of the individual node statistics.\nThe format matches the ingest section in the nodes stats API.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "model_id": {
+ "description": "The unique identifier of the trained model.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "model_size_stats": {
+ "description": "A collection of model size stats.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TrainedModelSizeStats"
+ }
+ ]
+ },
+ "pipeline_count": {
+ "description": "The number of ingest pipelines that currently refer to the model.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "model_id",
+ "model_size_stats",
+ "pipeline_count"
+ ]
+ },
+ "ml._types.TrainedModelDeploymentStats": {
+ "type": "object",
+ "properties": {
+ "adaptive_allocations": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.AdaptiveAllocationsSettings"
+ }
+ ]
+ },
+ "allocation_status": {
+ "description": "The detailed allocation status for the deployment.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TrainedModelDeploymentAllocationStatus"
+ }
+ ]
+ },
+ "cache_size": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "deployment_id": {
+ "description": "The unique identifier for the trained model deployment.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "error_count": {
+ "description": "The sum of `error_count` for all nodes in the deployment.",
+ "type": "number"
+ },
+ "inference_count": {
+ "description": "The sum of `inference_count` for all nodes in the deployment.",
+ "type": "number"
+ },
+ "model_id": {
+ "description": "The unique identifier for the trained model.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "nodes": {
+ "description": "The deployment stats for each node that currently has the model allocated.\nIn serverless, stats are reported for a single unnamed virtual node.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.TrainedModelDeploymentNodesStats"
+ }
+ },
+ "number_of_allocations": {
+ "description": "The number of allocations requested.",
+ "type": "number"
+ },
+ "peak_throughput_per_minute": {
+ "type": "number"
+ },
+ "priority": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TrainingPriority"
+ }
+ ]
+ },
+ "queue_capacity": {
+ "description": "The number of inference requests that can be queued before new requests are rejected.",
+ "type": "number"
+ },
+ "rejected_execution_count": {
+ "description": "The sum of `rejected_execution_count` for all nodes in the deployment.\nIndividual nodes reject an inference request if the inference queue is full.\nThe queue size is controlled by the `queue_capacity` setting in the start\ntrained model deployment API.",
+ "type": "number"
+ },
+ "reason": {
+ "description": "The reason for the current deployment state. Usually only populated when\nthe model is not deployed to a node.",
+ "type": "string"
+ },
+ "start_time": {
+ "description": "The epoch timestamp when the deployment started.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "state": {
+ "description": "The overall state of the deployment.\n\nSupported values include:\n - `started`: The deployment is usable; at least one node has the model allocated.\n - `starting`: The deployment has recently started but is not yet usable; the model is not allocated on any nodes.\n - `stopping`: The deployment is preparing to stop and deallocate the model from the relevant nodes.\n - `failed`: The deployment is on a failed state and must be re-deployed.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DeploymentAssignmentState"
+ }
+ ]
+ },
+ "threads_per_allocation": {
+ "description": "The number of threads used be each allocation during inference.",
+ "type": "number"
+ },
+ "timeout_count": {
+ "description": "The sum of `timeout_count` for all nodes in the deployment.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "deployment_id",
+ "model_id",
+ "nodes",
+ "peak_throughput_per_minute",
+ "priority",
+ "start_time"
+ ]
+ },
+ "ml._types.AdaptiveAllocationsSettings": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "description": "If true, adaptive_allocations is enabled",
+ "type": "boolean"
+ },
+ "min_number_of_allocations": {
+ "description": "Specifies the minimum number of allocations to scale to.\nIf set, it must be greater than or equal to 0.\nIf not defined, the deployment scales to 0.",
+ "type": "number"
+ },
+ "max_number_of_allocations": {
+ "description": "Specifies the maximum number of allocations to scale to.\nIf set, it must be greater than or equal to min_number_of_allocations.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "enabled"
+ ]
+ },
+ "ml._types.TrainedModelDeploymentAllocationStatus": {
+ "type": "object",
+ "properties": {
+ "allocation_count": {
+ "description": "The current number of nodes where the model is allocated.",
+ "type": "number"
+ },
+ "state": {
+ "description": "The detailed allocation state related to the nodes.\n\nSupported values include:\n - `started`: The trained model is started on at least one node.\n - `starting`: Trained model deployment is starting but it is not yet deployed on any nodes.\n - `fully_allocated`: Trained model deployment has started on all valid nodes.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DeploymentAllocationState"
+ }
+ ]
+ },
+ "target_allocation_count": {
+ "description": "The desired number of nodes for model allocation.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "allocation_count",
+ "state",
+ "target_allocation_count"
+ ]
+ },
+ "ml._types.DeploymentAllocationState": {
+ "type": "string",
+ "enum": [
+ "started",
+ "starting",
+ "fully_allocated"
+ ]
+ },
+ "ml._types.TrainedModelDeploymentNodesStats": {
+ "type": "object",
+ "properties": {
+ "average_inference_time_ms": {
+ "description": "The average time for each inference call to complete on this node.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
+ }
+ ]
+ },
+ "average_inference_time_ms_last_minute": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
+ }
+ ]
+ },
+ "average_inference_time_ms_excluding_cache_hits": {
+ "description": "The average time for each inference call to complete on this node, excluding cache",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
+ }
+ ]
+ },
+ "error_count": {
+ "description": "The number of errors when evaluating the trained model.",
+ "type": "number"
+ },
+ "inference_count": {
+ "description": "The total number of inference calls made against this node for this model.",
+ "type": "number"
+ },
+ "inference_cache_hit_count": {
+ "type": "number"
+ },
+ "inference_cache_hit_count_last_minute": {
+ "type": "number"
+ },
+ "last_access": {
+ "description": "The epoch time stamp of the last inference call for the model on this node.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "number_of_allocations": {
+ "description": "The number of allocations assigned to this node.",
+ "type": "number"
+ },
+ "number_of_pending_requests": {
+ "description": "The number of inference requests queued to be processed.",
+ "type": "number"
+ },
+ "peak_throughput_per_minute": {
+ "type": "number"
+ },
+ "rejected_execution_count": {
+ "description": "The number of inference requests that were not processed because the queue was full.",
+ "type": "number"
+ },
+ "routing_state": {
+ "description": "The current routing state and reason for the current routing state for this allocation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TrainedModelAssignmentRoutingStateAndReason"
+ }
+ ]
+ },
+ "start_time": {
+ "description": "The epoch timestamp when the allocation started.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "threads_per_allocation": {
+ "description": "The number of threads used by each allocation during inference.",
+ "type": "number"
+ },
+ "throughput_last_minute": {
+ "type": "number"
+ },
+ "timeout_count": {
+ "description": "The number of inference requests that timed out before being processed.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "peak_throughput_per_minute",
+ "routing_state",
+ "throughput_last_minute"
+ ]
+ },
+ "ml._types.TrainedModelAssignmentRoutingStateAndReason": {
+ "type": "object",
+ "properties": {
+ "reason": {
+ "description": "The reason for the current state. It is usually populated only when the\n`routing_state` is `failed`.",
+ "type": "string"
+ },
+ "routing_state": {
+ "description": "The current routing state.\n\nSupported values include:\n - `failed`: The allocation attempt failed.\n - `started`: The trained model is allocated and ready to accept inference requests.\n - `starting`: The trained model is attempting to allocate on this node; inference requests are not yet accepted.\n - `stopped`: The trained model is fully deallocated from this node.\n - `stopping`: The trained model is being deallocated from this node.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.RoutingState"
+ }
+ ]
+ }
+ },
+ "required": [
+ "routing_state"
+ ]
+ },
+ "ml._types.RoutingState": {
+ "type": "string",
+ "enum": [
+ "failed",
+ "started",
+ "starting",
+ "stopped",
+ "stopping"
+ ]
+ },
+ "ml._types.TrainingPriority": {
+ "type": "string",
+ "enum": [
+ "normal",
+ "low"
+ ]
+ },
+ "ml._types.DeploymentAssignmentState": {
+ "type": "string",
+ "enum": [
+ "started",
+ "starting",
+ "stopping",
+ "failed"
+ ]
+ },
+ "ml._types.TrainedModelInferenceStats": {
+ "type": "object",
+ "properties": {
+ "cache_miss_count": {
+ "description": "The number of times the model was loaded for inference and was not retrieved from the cache.\nIf this number is close to the `inference_count`, the cache is not being appropriately used.\nThis can be solved by increasing the cache size or its time-to-live (TTL).\nRefer to general machine learning settings for the appropriate settings.",
+ "type": "number"
+ },
+ "failure_count": {
+ "description": "The number of failures when using the model for inference.",
+ "type": "number"
+ },
+ "inference_count": {
+ "description": "The total number of times the model has been called for inference.\nThis is across all inference contexts, including all pipelines.",
+ "type": "number"
+ },
+ "missing_all_fields_count": {
+ "description": "The number of inference calls where all the training features for the model were missing.",
+ "type": "number"
+ },
+ "timestamp": {
+ "description": "The time when the statistics were last updated.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ }
+ },
+ "required": [
+ "cache_miss_count",
+ "failure_count",
+ "inference_count",
+ "missing_all_fields_count",
+ "timestamp"
+ ]
+ },
+ "ml._types.TrainedModelSizeStats": {
+ "type": "object",
+ "properties": {
+ "model_size_bytes": {
+ "description": "The size of the model in bytes.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "required_native_memory_bytes": {
+ "description": "The amount of memory required to load the model in bytes.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ }
+ },
+ "required": [
+ "model_size_bytes",
+ "required_native_memory_bytes"
+ ]
+ },
+ "ml._types.InferenceConfigUpdateContainer": {
+ "type": "object",
+ "properties": {
+ "regression": {
+ "description": "Regression configuration for inference.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.RegressionInferenceOptions"
+ }
+ ]
+ },
+ "classification": {
+ "description": "Classification configuration for inference.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.ClassificationInferenceOptions"
+ }
+ ]
+ },
+ "text_classification": {
+ "description": "Text classification configuration for inference.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TextClassificationInferenceUpdateOptions"
+ }
+ ]
+ },
+ "zero_shot_classification": {
+ "description": "Zeroshot classification configuration for inference.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.ZeroShotClassificationInferenceUpdateOptions"
+ }
+ ]
+ },
+ "fill_mask": {
+ "description": "Fill mask configuration for inference.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.FillMaskInferenceUpdateOptions"
+ }
+ ]
+ },
+ "ner": {
+ "description": "Named entity recognition configuration for inference.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.NerInferenceUpdateOptions"
+ }
+ ]
+ },
+ "pass_through": {
+ "description": "Pass through configuration for inference.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.PassThroughInferenceUpdateOptions"
+ }
+ ]
+ },
+ "text_embedding": {
+ "description": "Text embedding configuration for inference.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TextEmbeddingInferenceUpdateOptions"
+ }
+ ]
+ },
+ "text_expansion": {
+ "description": "Text expansion configuration for inference.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TextExpansionInferenceUpdateOptions"
+ }
+ ]
+ },
+ "question_answering": {
+ "description": "Question answering configuration for inference",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.QuestionAnsweringInferenceUpdateOptions"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "ml._types.TextClassificationInferenceUpdateOptions": {
+ "type": "object",
+ "properties": {
+ "num_top_classes": {
+ "description": "Specifies the number of top class predictions to return. Defaults to 0.",
+ "type": "number"
+ },
+ "tokenization": {
+ "description": "The tokenization options to update when inferring",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions"
+ }
+ ]
+ },
+ "results_field": {
+ "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
+ "type": "string"
+ },
+ "classification_labels": {
+ "description": "Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "ml._types.NlpTokenizationUpdateOptions": {
+ "type": "object",
+ "properties": {
+ "truncate": {
+ "description": "Truncate options to apply",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TokenizationTruncate"
+ }
+ ]
+ },
+ "span": {
+ "description": "Span options to apply",
+ "type": "number"
+ }
+ }
+ },
+ "ml._types.ZeroShotClassificationInferenceUpdateOptions": {
+ "type": "object",
+ "properties": {
+ "tokenization": {
+ "description": "The tokenization options to update when inferring",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions"
+ }
+ ]
+ },
+ "results_field": {
+ "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
+ "type": "string"
+ },
+ "multi_label": {
+ "description": "Update the configured multi label option. Indicates if more than one true label exists. Defaults to the configured value.",
+ "type": "boolean"
+ },
+ "labels": {
+ "description": "The labels to predict.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "labels"
+ ]
+ },
+ "ml._types.FillMaskInferenceUpdateOptions": {
+ "type": "object",
+ "properties": {
+ "num_top_classes": {
+ "description": "Specifies the number of top class predictions to return. Defaults to 0.",
+ "type": "number"
+ },
+ "tokenization": {
+ "description": "The tokenization options to update when inferring",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions"
+ }
+ ]
+ },
+ "results_field": {
+ "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
+ "type": "string"
+ }
+ }
+ },
+ "ml._types.NerInferenceUpdateOptions": {
+ "type": "object",
+ "properties": {
+ "tokenization": {
+ "description": "The tokenization options to update when inferring",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions"
+ }
+ ]
+ },
+ "results_field": {
+ "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
+ "type": "string"
+ }
+ }
+ },
+ "ml._types.PassThroughInferenceUpdateOptions": {
+ "type": "object",
+ "properties": {
+ "tokenization": {
+ "description": "The tokenization options to update when inferring",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions"
+ }
+ ]
+ },
+ "results_field": {
+ "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
+ "type": "string"
+ }
+ }
+ },
+ "ml._types.TextEmbeddingInferenceUpdateOptions": {
+ "type": "object",
+ "properties": {
+ "tokenization": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions"
+ }
+ ]
+ },
+ "results_field": {
+ "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
+ "type": "string"
+ }
+ }
+ },
+ "ml._types.TextExpansionInferenceUpdateOptions": {
+ "type": "object",
+ "properties": {
+ "tokenization": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions"
+ }
+ ]
+ },
+ "results_field": {
+ "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
+ "type": "string"
+ }
+ }
+ },
+ "ml._types.QuestionAnsweringInferenceUpdateOptions": {
+ "type": "object",
+ "properties": {
+ "question": {
+ "description": "The question to answer given the inference context",
+ "type": "string"
+ },
+ "num_top_classes": {
+ "description": "Specifies the number of top class predictions to return. Defaults to 0.",
+ "type": "number"
+ },
+ "tokenization": {
+ "description": "The tokenization options to update when inferring",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.NlpTokenizationUpdateOptions"
+ }
+ ]
+ },
+ "results_field": {
+ "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.",
+ "type": "string"
+ },
+ "max_answer_length": {
+ "description": "The maximum answer length to consider for extraction",
+ "type": "number"
+ }
+ },
+ "required": [
+ "question"
+ ]
+ },
+ "ml._types.InferenceResponseResult": {
+ "type": "object",
+ "properties": {
+ "entities": {
+ "description": "If the model is trained for named entity recognition (NER) tasks, the response contains the recognized entities.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.TrainedModelEntities"
+ }
+ },
+ "is_truncated": {
+ "description": "Indicates whether the input text was truncated to meet the model's maximum sequence length limit. This property\nis present only when it is true.",
+ "type": "boolean"
+ },
+ "predicted_value": {
+ "description": "If the model is trained for a text classification or zero shot classification task, the response is the\npredicted class.\nFor named entity recognition (NER) tasks, it contains the annotated text output.\nFor fill mask tasks, it contains the top prediction for replacing the mask token.\nFor text embedding tasks, it contains the raw numerical text embedding values.\nFor regression models, its a numerical value\nFor classification models, it may be an integer, double, boolean or string depending on prediction type",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.PredictedValue"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.PredictedValue"
+ }
+ }
+ ]
+ },
+ "predicted_value_sequence": {
+ "description": "For fill mask tasks, the response contains the input text sequence with the mask token replaced by the predicted\nvalue.\nAdditionally",
+ "type": "string"
+ },
+ "prediction_probability": {
+ "description": "Specifies a probability for the predicted value.",
+ "type": "number"
+ },
+ "prediction_score": {
+ "description": "Specifies a confidence score for the predicted value.",
+ "type": "number"
+ },
+ "top_classes": {
+ "description": "For fill mask, text classification, and zero shot classification tasks, the response contains a list of top\nclass entries.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.TopClassEntry"
+ }
+ },
+ "warning": {
+ "description": "If the request failed, the response contains the reason for the failure.",
+ "type": "string"
+ },
+ "feature_importance": {
+ "description": "The feature importance for the inference results. Relevant only for classification or regression models",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.TrainedModelInferenceFeatureImportance"
+ }
+ }
+ }
+ },
+ "ml._types.TrainedModelEntities": {
+ "type": "object",
+ "properties": {
+ "class_name": {
+ "type": "string"
+ },
+ "class_probability": {
+ "type": "number"
+ },
+ "entity": {
+ "type": "string"
+ },
+ "start_pos": {
+ "type": "number"
+ },
+ "end_pos": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "class_name",
+ "class_probability",
+ "entity",
+ "start_pos",
+ "end_pos"
+ ]
+ },
+ "ml._types.PredictedValue": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScalarValue"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.ScalarValue"
+ }
+ }
+ ]
+ },
+ "ml._types.TopClassEntry": {
+ "type": "object",
+ "properties": {
+ "class_name": {
+ "type": "string"
+ },
+ "class_probability": {
+ "type": "number"
+ },
+ "class_score": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "class_name",
+ "class_probability",
+ "class_score"
+ ]
+ },
+ "ml._types.TrainedModelInferenceFeatureImportance": {
+ "type": "object",
+ "properties": {
+ "feature_name": {
+ "type": "string"
+ },
+ "importance": {
+ "type": "number"
+ },
+ "classes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.TrainedModelInferenceClassImportance"
+ }
+ }
+ },
+ "required": [
+ "feature_name"
+ ]
+ },
+ "ml._types.TrainedModelInferenceClassImportance": {
+ "type": "object",
+ "properties": {
+ "class_name": {
+ "type": "string"
+ },
+ "importance": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "class_name",
+ "importance"
+ ]
+ },
+ "ml.preview_data_frame_analytics.DataframePreviewConfig": {
+ "type": "object",
+ "properties": {
+ "source": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSource"
+ }
+ ]
+ },
+ "analysis": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalysisContainer"
+ }
+ ]
+ },
+ "model_memory_limit": {
+ "type": "string"
+ },
+ "max_num_threads": {
+ "type": "number"
+ },
+ "analyzed_fields": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalysisAnalyzedFields"
+ }
+ ]
+ }
+ },
+ "required": [
+ "source",
+ "analysis"
+ ]
+ },
+ "ml._types.DatafeedConfig": {
+ "type": "object",
+ "properties": {
+ "aggregations": {
+ "description": "If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.AggregationContainer"
+ }
+ },
+ "chunking_config": {
+ "description": "Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated and is an advanced configuration option.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.ChunkingConfig"
+ }
+ ]
+ },
+ "datafeed_id": {
+ "description": "A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. The default value is the job identifier.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "delayed_data_check_config": {
+ "description": "Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the `query_delay` option is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DelayedDataCheckConfig"
+ }
+ ]
+ },
+ "frequency": {
+ "description": "The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: `150s`. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "indices": {
+ "description": "An array of index names. Wildcards are supported. If any indices are in remote clusters, the machine learning nodes must have the `remote_cluster_client` role.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Indices"
+ }
+ ]
+ },
+ "indices_options": {
+ "description": "Specifies index expansion options that are used during search.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndicesOptions"
+ }
+ ]
+ },
+ "job_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "max_empty_searches": {
+ "description": "If a real-time datafeed has never seen any data (including during any initial training period) then it will automatically stop itself and close its associated job after this many real-time searches that return no documents. In other words, it will stop after `frequency` times `max_empty_searches` of real-time operation. If not set then a datafeed with no end time that sees no data will remain started until it is explicitly stopped.",
+ "type": "number"
+ },
+ "query": {
+ "description": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "query_delay": {
+ "description": "The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between `60s` and `120s`. This randomness improves the query performance when there are multiple jobs running on the same node.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "runtime_mappings": {
+ "description": "Specifies runtime fields for the datafeed search.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RuntimeFields"
+ }
+ ]
+ },
+ "script_fields": {
+ "description": "Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.ScriptField"
+ }
+ },
+ "scroll_size": {
+ "description": "The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of `index.max_result_window`, which is 10,000 by default.",
+ "default": 1000.0,
+ "type": "number"
+ }
+ }
+ },
+ "ml._types.JobConfig": {
+ "type": "object",
+ "properties": {
+ "allow_lazy_open": {
+ "description": "Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node.",
+ "default": false,
+ "type": "boolean"
+ },
+ "analysis_config": {
+ "description": "The analysis configuration, which specifies how to analyze the data.\nAfter you create a job, you cannot change the analysis configuration; all the properties are informational.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.AnalysisConfig"
+ }
+ ]
+ },
+ "analysis_limits": {
+ "description": "Limits can be applied for the resources required to hold the mathematical models in memory.\nThese limits are approximate and can be set per job.\nThey do not control the memory used by other processes, for example the Elasticsearch Java processes.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.AnalysisLimits"
+ }
+ ]
+ },
+ "background_persist_interval": {
+ "description": "Advanced configuration option.\nThe time between each periodic persistence of the model.\nThe default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time.\nThe smallest allowed value is 1 hour.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "custom_settings": {
+ "description": "Advanced configuration option.\nContains custom metadata about the job.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.CustomSettings"
+ }
+ ]
+ },
+ "daily_model_snapshot_retention_after_days": {
+ "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job.\nIt specifies a period of time (in days) after which only the first snapshot per day is retained.\nThis period is relative to the timestamp of the most recent snapshot for this job.",
+ "default": 1.0,
+ "type": "number"
+ },
+ "data_description": {
+ "description": "The data description defines the format of the input data when you send data to the job by using the post data API.\nNote that when configure a datafeed, these properties are automatically set.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DataDescription"
+ }
+ ]
+ },
+ "datafeed_config": {
+ "description": "The datafeed, which retrieves data from Elasticsearch for analysis by the job.\nYou can associate only one datafeed with each anomaly detection job.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DatafeedConfig"
+ }
+ ]
+ },
+ "description": {
+ "description": "A description of the job.",
+ "type": "string"
+ },
+ "groups": {
+ "description": "A list of job groups. A job can belong to no groups or many.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "job_id": {
+ "description": "Identifier for the anomaly detection job.\nThis identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.\nIt must start and end with alphanumeric characters.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "job_type": {
+ "description": "Reserved for future use, currently set to `anomaly_detector`.",
+ "type": "string"
+ },
+ "model_plot_config": {
+ "description": "This advanced configuration option stores model information along with the results.\nIt provides a more detailed view into anomaly detection.\nModel plot provides a simplified and indicative view of the model and its bounds.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.ModelPlotConfig"
+ }
+ ]
+ },
+ "model_snapshot_retention_days": {
+ "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job.\nIt specifies the maximum period of time (in days) that snapshots are retained.\nThis period is relative to the timestamp of the most recent snapshot for this job.\nThe default value is `10`, which means snapshots ten days older than the newest snapshot are deleted.",
+ "default": 10.0,
+ "type": "number"
+ },
+ "renormalization_window_days": {
+ "description": "Advanced configuration option.\nThe period over which adjustments to the score are applied, as new data is seen.\nThe default value is the longer of 30 days or 100 `bucket_spans`.",
+ "type": "number"
+ },
+ "results_index_name": {
+ "description": "A text string that affects the name of the machine learning results index.\nThe default value is `shared`, which generates an index named `.ml-anomalies-shared`.",
+ "default": "shared",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "results_retention_days": {
+ "description": "Advanced configuration option.\nThe period of time (in days) that results are retained.\nAge is calculated relative to the timestamp of the latest bucket result.\nIf this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch.\nThe default value is null, which means all results are retained.\nAnnotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results.\nAnnotations added by users are retained forever.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "analysis_config",
+ "data_description"
+ ]
+ },
+ "_types.HttpHeaders": {
+ "type": "object",
+ "additionalProperties": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "ml._types.AnalysisConfigRead": {
+ "type": "object",
+ "properties": {
+ "bucket_span": {
+ "description": "The size of the interval that the analysis is aggregated into, typically between `5m` and `1h`.",
+ "default": "5m",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "categorization_analyzer": {
+ "description": "If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field.\nThis property cannot be used at the same time as `categorization_filters`.\nThe categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.CategorizationAnalyzer"
+ }
+ ]
+ },
+ "categorization_field_name": {
+ "description": "If this property is specified, the values of the specified field will be categorized.\nThe resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "categorization_filters": {
+ "description": "If `categorization_field_name` is specified, you can also define optional filters.\nThis property expects an array of regular expressions.\nThe expressions are used to filter out matching sequences from the categorization field values.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "detectors": {
+ "description": "An array of detector configuration objects.\nDetector configuration objects specify which data fields a job analyzes.\nThey also specify which analytical functions are used.\nYou can specify multiple detectors for a job.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.DetectorRead"
+ }
+ },
+ "influencers": {
+ "description": "A comma separated list of influencer field names.\nTypically these can be the by, over, or partition fields that are used in the detector configuration.\nYou might also want to use a field name that is not specifically named in a detector, but is available as part of the input data.\nWhen you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ },
+ "model_prune_window": {
+ "description": "Advanced configuration option.\nAffects the pruning of models that have not been updated for the given time duration.\nThe value must be set to a multiple of the `bucket_span`.\nIf set too low, important information may be removed from the model.\nTypically, set to `30d` or longer.\nIf not set, model pruning only occurs if the model memory status reaches the soft limit or the hard limit.\nFor jobs created in 8.1 and later, the default value is the greater of `30d` or 20 times `bucket_span`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "latency": {
+ "description": "The size of the window in which to expect data that is out of time order.\nDefaults to no latency.\nIf you specify a non-zero value, it must be greater than or equal to one second.",
+ "default": "0",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "multivariate_by_fields": {
+ "description": "This functionality is reserved for internal use.\nIt is not supported for use in customer environments and is not subject to the support SLA of official GA features.\nIf set to `true`, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold.",
+ "type": "boolean"
+ },
+ "per_partition_categorization": {
+ "description": "Settings related to how categorization interacts with partition fields.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.PerPartitionCategorization"
+ }
+ ]
+ },
+ "summary_count_field_name": {
+ "description": "If this property is specified, the data that is fed to the job is expected to be pre-summarized.\nThis property value is the name of the field that contains the count of raw data points that have been summarized.\nThe same `summary_count_field_name` applies to all detectors in the job.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "bucket_span",
+ "detectors",
+ "influencers"
+ ]
+ },
+ "ml._types.DetectorRead": {
+ "type": "object",
+ "properties": {
+ "by_field_name": {
+ "description": "The field used to split the data.\nIn particular, this property is used for analyzing the splits with respect to their own history.\nIt is used for finding unusual values in the context of the split.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "custom_rules": {
+ "description": "An array of custom rule objects, which enable you to customize the way detectors operate.\nFor example, a rule may dictate to the detector conditions under which results should be skipped.\nKibana refers to custom rules as job rules.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.DetectionRule"
+ }
+ },
+ "detector_description": {
+ "description": "A description of the detector.",
+ "type": "string"
+ },
+ "detector_index": {
+ "description": "A unique identifier for the detector.\nThis identifier is based on the order of the detectors in the `analysis_config`, starting at zero.",
+ "type": "number"
+ },
+ "exclude_frequent": {
+ "description": "Contains one of the following values: `all`, `none`, `by`, or `over`.\nIf set, frequent entities are excluded from influencing the anomaly results.\nEntities can be considered frequent over time or frequent in a population.\nIf you are working with both over and by fields, then you can set `exclude_frequent` to all for both fields, or to `by` or `over` for those specific fields.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.ExcludeFrequent"
+ }
+ ]
+ },
+ "field_name": {
+ "description": "The field that the detector uses in the function.\nIf you use an event rate function such as `count` or `rare`, do not specify this field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "function": {
+ "description": "The analysis function that is used.\nFor example, `count`, `rare`, `mean`, `min`, `max`, and `sum`.",
+ "type": "string"
+ },
+ "over_field_name": {
+ "description": "The field used to split the data.\nIn particular, this property is used for analyzing the splits with respect to the history of all splits.\nIt is used for finding unusual values in the population of all splits.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "partition_field_name": {
+ "description": "The field used to segment the analysis.\nWhen you use this property, you have completely independent baselines for each value of this field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "use_null": {
+ "description": "Defines whether a new series is used as the null series when there is no value for the by or partition fields.",
+ "default": false,
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "function"
+ ]
+ },
+ "ml.put_trained_model.Definition": {
+ "type": "object",
+ "properties": {
+ "preprocessors": {
+ "description": "Collection of preprocessors",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml.put_trained_model.Preprocessor"
+ }
+ },
+ "trained_model": {
+ "description": "The definition of the trained model.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.put_trained_model.TrainedModel"
+ }
+ ]
+ }
+ },
+ "required": [
+ "trained_model"
+ ]
+ },
+ "ml.put_trained_model.Preprocessor": {
+ "type": "object",
+ "properties": {
+ "frequency_encoding": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.put_trained_model.FrequencyEncodingPreprocessor"
+ }
+ ]
+ },
+ "one_hot_encoding": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.put_trained_model.OneHotEncodingPreprocessor"
+ }
+ ]
+ },
+ "target_mean_encoding": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.put_trained_model.TargetMeanEncodingPreprocessor"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "ml.put_trained_model.FrequencyEncodingPreprocessor": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "type": "string"
+ },
+ "feature_name": {
+ "type": "string"
+ },
+ "frequency_map": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "number"
+ }
+ }
+ },
+ "required": [
+ "field",
+ "feature_name",
+ "frequency_map"
+ ]
+ },
+ "ml.put_trained_model.OneHotEncodingPreprocessor": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "type": "string"
+ },
+ "hot_map": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "field",
+ "hot_map"
+ ]
+ },
+ "ml.put_trained_model.TargetMeanEncodingPreprocessor": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "type": "string"
+ },
+ "feature_name": {
+ "type": "string"
+ },
+ "target_map": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "number"
+ }
+ },
+ "default_value": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "field",
+ "feature_name",
+ "target_map",
+ "default_value"
+ ]
+ },
+ "ml.put_trained_model.TrainedModel": {
+ "type": "object",
+ "properties": {
+ "tree": {
+ "description": "The definition for a binary decision tree.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.put_trained_model.TrainedModelTree"
+ }
+ ]
+ },
+ "tree_node": {
+ "description": "The definition of a node in a tree.\nThere are two major types of nodes: leaf nodes and not-leaf nodes.\n- Leaf nodes only need node_index and leaf_value defined.\n- All other nodes need split_feature, left_child, right_child, threshold, decision_type, and default_left defined.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.put_trained_model.TrainedModelTreeNode"
+ }
+ ]
+ },
+ "ensemble": {
+ "description": "The definition for an ensemble model",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.put_trained_model.Ensemble"
+ }
+ ]
+ }
+ }
+ },
+ "ml.put_trained_model.TrainedModelTree": {
+ "type": "object",
+ "properties": {
+ "classification_labels": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "feature_names": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "target_type": {
+ "type": "string"
+ },
+ "tree_structure": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml.put_trained_model.TrainedModelTreeNode"
+ }
+ }
+ },
+ "required": [
+ "feature_names",
+ "tree_structure"
+ ]
+ },
+ "ml.put_trained_model.TrainedModelTreeNode": {
+ "type": "object",
+ "properties": {
+ "decision_type": {
+ "type": "string"
+ },
+ "default_left": {
+ "type": "boolean"
+ },
+ "leaf_value": {
+ "type": "number"
+ },
+ "left_child": {
+ "type": "number"
+ },
+ "node_index": {
+ "type": "number"
+ },
+ "right_child": {
+ "type": "number"
+ },
+ "split_feature": {
+ "type": "number"
+ },
+ "split_gain": {
+ "type": "number"
+ },
+ "threshold": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "node_index"
+ ]
+ },
+ "ml.put_trained_model.Ensemble": {
+ "type": "object",
+ "properties": {
+ "aggregate_output": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.put_trained_model.AggregateOutput"
+ }
+ ]
+ },
+ "classification_labels": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "feature_names": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "target_type": {
+ "type": "string"
+ },
+ "trained_models": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml.put_trained_model.TrainedModel"
+ }
+ }
+ },
+ "required": [
+ "trained_models"
+ ]
+ },
+ "ml.put_trained_model.AggregateOutput": {
+ "type": "object",
+ "properties": {
+ "logistic_regression": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.put_trained_model.Weights"
+ }
+ ]
+ },
+ "weighted_sum": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.put_trained_model.Weights"
+ }
+ ]
+ },
+ "weighted_mode": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.put_trained_model.Weights"
+ }
+ ]
+ },
+ "exponent": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.put_trained_model.Weights"
+ }
+ ]
+ }
+ }
+ },
+ "ml.put_trained_model.Weights": {
+ "type": "object",
+ "properties": {
+ "weights": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "weights"
+ ]
+ },
+ "ml.put_trained_model.Input": {
+ "type": "object",
+ "properties": {
+ "field_names": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Names"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field_names"
+ ]
+ },
+ "_types.NodeIds": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.NodeId"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.NodeId"
+ }
+ }
+ ]
+ },
+ "ml._types.TrainedModelAssignment": {
+ "type": "object",
+ "properties": {
+ "adaptive_allocations": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.AdaptiveAllocationsSettings"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ },
+ "assignment_state": {
+ "description": "The overall assignment state.\n\nSupported values include:\n - `started`: The deployment is usable; at least one node has the model allocated.\n - `starting`: The deployment has recently started but is not yet usable; the model is not allocated on any nodes.\n - `stopping`: The deployment is preparing to stop and deallocate the model from the relevant nodes.\n - `failed`: The deployment is on a failed state and must be re-deployed.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DeploymentAssignmentState"
+ }
+ ]
+ },
+ "max_assigned_allocations": {
+ "type": "number"
+ },
+ "reason": {
+ "type": "string"
+ },
+ "routing_table": {
+ "description": "The allocation state for each node.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/ml._types.TrainedModelAssignmentRoutingTable"
+ }
+ },
+ "start_time": {
+ "description": "The timestamp when the deployment started.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "task_parameters": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TrainedModelAssignmentTaskParameters"
+ }
+ ]
+ }
+ },
+ "required": [
+ "assignment_state",
+ "routing_table",
+ "start_time",
+ "task_parameters"
+ ]
+ },
+ "ml._types.TrainedModelAssignmentRoutingTable": {
+ "type": "object",
+ "properties": {
+ "reason": {
+ "description": "The reason for the current state. It is usually populated only when the\n`routing_state` is `failed`.",
+ "type": "string"
+ },
+ "routing_state": {
+ "description": "The current routing state.\n\nSupported values include:\n - `failed`: The allocation attempt failed.\n - `started`: The trained model is allocated and ready to accept inference requests.\n - `starting`: The trained model is attempting to allocate on this node; inference requests are not yet accepted.\n - `stopped`: The trained model is fully deallocated from this node.\n - `stopping`: The trained model is being deallocated from this node.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.RoutingState"
+ }
+ ]
+ },
+ "current_allocations": {
+ "description": "Current number of allocations.",
+ "type": "number"
+ },
+ "target_allocations": {
+ "description": "Target number of allocations.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "routing_state",
+ "current_allocations",
+ "target_allocations"
+ ]
+ },
+ "ml._types.TrainedModelAssignmentTaskParameters": {
+ "type": "object",
+ "properties": {
+ "model_bytes": {
+ "description": "The size of the trained model in bytes.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "model_id": {
+ "description": "The unique identifier for the trained model.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "deployment_id": {
+ "description": "The unique identifier for the trained model deployment.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "cache_size": {
+ "description": "The size of the trained model cache.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "number_of_allocations": {
+ "description": "The total number of allocations this model is assigned across ML nodes.",
+ "type": "number"
+ },
+ "priority": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TrainingPriority"
+ }
+ ]
+ },
+ "per_deployment_memory_bytes": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "per_allocation_memory_bytes": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ByteSize"
+ }
+ ]
+ },
+ "queue_capacity": {
+ "description": "Number of inference requests are allowed in the queue at a time.",
+ "type": "number"
+ },
+ "threads_per_allocation": {
+ "description": "Number of threads per allocation.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "model_bytes",
+ "model_id",
+ "deployment_id",
+ "number_of_allocations",
+ "priority",
+ "per_deployment_memory_bytes",
+ "per_allocation_memory_bytes",
+ "queue_capacity",
+ "threads_per_allocation"
+ ]
+ },
+ "ml._types.AnalysisMemoryLimit": {
+ "type": "object",
+ "properties": {
+ "model_memory_limit": {
+ "description": "Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "model_memory_limit"
+ ]
+ },
+ "ml._types.DetectorUpdate": {
+ "type": "object",
+ "properties": {
+ "detector_index": {
+ "description": "A unique identifier for the detector.\nThis identifier is based on the order of the detectors in the `analysis_config`, starting at zero.",
+ "type": "number"
+ },
+ "description": {
+ "description": "A description of the detector.",
+ "type": "string"
+ },
+ "custom_rules": {
+ "description": "An array of custom rule objects, which enable you to customize the way detectors operate.\nFor example, a rule may dictate to the detector conditions under which results should be skipped.\nKibana refers to custom rules as job rules.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.DetectionRule"
+ }
+ }
+ },
+ "required": [
+ "detector_index"
+ ]
+ },
+ "_global.msearch.RequestItem": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_global.msearch.MultisearchHeader"
+ },
+ {
+ "$ref": "#/components/schemas/_global.search._types.SearchRequestBody"
+ }
+ ]
+ },
+ "_global.msearch.MultisearchHeader": {
+ "description": "Contains parameters used to limit or change the subsequent search body request.",
+ "type": "object",
+ "properties": {
+ "allow_no_indices": {
+ "type": "boolean"
+ },
+ "expand_wildcards": {
+ "description": "\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ExpandWildcards"
+ }
+ ]
+ },
+ "ignore_unavailable": {
+ "type": "boolean"
+ },
+ "index": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Indices"
+ }
+ ]
+ },
+ "preference": {
+ "type": "string"
+ },
+ "request_cache": {
+ "type": "boolean"
+ },
+ "routing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Routing"
+ }
+ ]
+ },
+ "search_type": {
+ "description": "\n\nSupported values include:\n - `query_then_fetch`: Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.\n - `dfs_query_then_fetch`: Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SearchType"
+ }
+ ]
+ },
+ "ccs_minimize_roundtrips": {
+ "type": "boolean"
+ },
+ "allow_partial_search_results": {
+ "type": "boolean"
+ },
+ "ignore_throttled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "_global.msearch.MultiSearchResult": {
+ "type": "object",
+ "properties": {
+ "took": {
+ "type": "number"
+ },
+ "responses": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.msearch.ResponseItem"
+ }
+ }
+ },
+ "required": [
+ "took",
+ "responses"
+ ]
+ },
+ "_global.msearch.ResponseItem": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_global.msearch.MultiSearchItem"
+ },
+ {
+ "$ref": "#/components/schemas/_types.ErrorResponseBase"
+ }
+ ]
+ },
+ "_global.msearch.MultiSearchItem": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search.ResponseBody"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "_global.search.ResponseBody": {
+ "type": "object",
+ "properties": {
+ "took": {
+ "description": "The number of milliseconds it took Elasticsearch to run the request.\nThis value is calculated by measuring the time elapsed between receipt of a request on the coordinating node and the time at which the coordinating node is ready to send the response.\nIt includes:\n\n* Communication time between the coordinating node and data nodes\n* Time the request spends in the search thread pool, queued for execution\n* Actual run time\n\nIt does not include:\n\n* Time needed to send the request to Elasticsearch\n* Time needed to serialize the JSON response\n* Time needed to send the response to a client",
+ "type": "number"
+ },
+ "timed_out": {
+ "description": "If `true`, the request timed out before completion; returned results may be partial or empty.",
+ "type": "boolean"
+ },
+ "_shards": {
+ "description": "A count of shards used for the request.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ShardStatistics"
+ }
+ ]
+ },
+ "hits": {
+ "description": "The returned documents and metadata.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.HitsMetadata"
+ }
+ ]
+ },
+ "aggregations": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.Aggregate"
+ }
+ },
+ "_clusters": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ClusterStatistics"
+ }
+ ]
+ },
+ "fields": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "max_score": {
+ "type": "number"
+ },
+ "num_reduce_phases": {
+ "type": "number"
+ },
+ "profile": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.Profile"
+ }
+ ]
+ },
+ "pit_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "_scroll_id": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results"
+ },
+ "description": "The identifier for the search and its search context.\nYou can use this scroll ID with the scroll API to retrieve the next batch of search results for the request.\nThis property is returned only if the `scroll` query parameter is specified in the request.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScrollId"
+ }
+ ]
+ },
+ "suggest": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.Suggest"
+ }
+ }
+ },
+ "terminated_early": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "took",
+ "timed_out",
+ "_shards",
+ "hits"
+ ]
+ },
+ "_types.ErrorResponseBase": {
+ "description": "The response returned by Elasticsearch when request execution did not succeed.",
+ "type": "object",
+ "properties": {
+ "error": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ErrorCause"
+ }
+ ]
+ },
+ "status": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "error",
+ "status"
+ ]
+ },
+ "_global.msearch_template.RequestItem": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_global.msearch.MultisearchHeader"
+ },
+ {
+ "$ref": "#/components/schemas/_global.msearch_template.TemplateConfig"
+ }
+ ]
+ },
+ "_global.msearch_template.TemplateConfig": {
+ "type": "object",
+ "properties": {
+ "explain": {
+ "description": "If `true`, returns detailed information about score calculation as part of each hit.",
+ "default": false,
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The ID of the search template to use. If no `source` is specified,\nthis parameter is required.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "params": {
+ "description": "Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "profile": {
+ "description": "If `true`, the query execution is profiled.",
+ "default": false,
+ "type": "boolean"
+ },
+ "source": {
+ "description": "An inline search template. Supports the same parameters as the search API's\nrequest body. It also supports Mustache variables. If no `id` is specified, this\nparameter is required.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScriptSource"
+ }
+ ]
+ }
+ }
+ },
+ "_global.mtermvectors.Operation": {
+ "type": "object",
+ "properties": {
+ "_id": {
+ "description": "The ID of the document.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "_index": {
+ "description": "The index of the document.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "doc": {
+ "description": "An artificial document (a document not present in the index) for which you want to retrieve term vectors.",
+ "type": "object"
+ },
+ "fields": {
+ "description": "Comma-separated list or wildcard expressions of fields to include in the statistics.\nUsed as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ },
+ "field_statistics": {
+ "description": "If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies.",
+ "default": true,
+ "type": "boolean"
+ },
+ "filter": {
+ "description": "Filter terms based on their tf-idf scores.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.termvectors.Filter"
+ }
+ ]
+ },
+ "offsets": {
+ "description": "If `true`, the response includes term offsets.",
+ "default": true,
+ "type": "boolean"
+ },
+ "payloads": {
+ "description": "If `true`, the response includes term payloads.",
+ "default": true,
+ "type": "boolean"
+ },
+ "positions": {
+ "description": "If `true`, the response includes term positions.",
+ "default": true,
+ "type": "boolean"
+ },
+ "routing": {
+ "description": "Custom value used to route operations to a specific shard.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Routing"
+ }
+ ]
+ },
+ "term_statistics": {
+ "description": "If true, the response includes term frequency and document frequency.",
+ "default": false,
+ "type": "boolean"
+ },
+ "version": {
+ "description": "If `true`, returns the document version as part of a hit.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ }
+ ]
+ },
+ "version_type": {
+ "description": "Specific version type.\n\nSupported values include:\n - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n - `force`: This option is deprecated because it can cause primary and replica shards to diverge.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionType"
+ }
+ ]
+ }
+ }
+ },
+ "_global.termvectors.Filter": {
+ "type": "object",
+ "properties": {
+ "max_doc_freq": {
+ "description": "Ignore words which occur in more than this many docs.\nDefaults to unbounded.",
+ "type": "number"
+ },
+ "max_num_terms": {
+ "description": "The maximum number of terms that must be returned per field.",
+ "default": 25.0,
+ "type": "number"
+ },
+ "max_term_freq": {
+ "description": "Ignore words with more than this frequency in the source doc.\nIt defaults to unbounded.",
+ "type": "number"
+ },
+ "max_word_length": {
+ "description": "The maximum word length above which words will be ignored.\nDefaults to unbounded.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "min_doc_freq": {
+ "description": "Ignore terms which do not occur in at least this many docs.",
+ "default": 1.0,
+ "type": "number"
+ },
+ "min_term_freq": {
+ "description": "Ignore words with less than this frequency in the source doc.",
+ "default": 1.0,
+ "type": "number"
+ },
+ "min_word_length": {
+ "description": "The minimum word length below which words will be ignored.",
+ "default": 0.0,
+ "type": "number"
+ }
+ }
+ },
+ "_global.mtermvectors.TermVectorsResult": {
+ "type": "object",
+ "properties": {
+ "_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "_index": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "_version": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ }
+ ]
+ },
+ "took": {
+ "type": "number"
+ },
+ "found": {
+ "type": "boolean"
+ },
+ "term_vectors": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_global.termvectors.TermVector"
+ }
+ },
+ "error": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ErrorCause"
+ }
+ ]
+ }
+ },
+ "required": [
+ "_index"
+ ]
+ },
+ "_global.termvectors.TermVector": {
+ "type": "object",
+ "properties": {
+ "field_statistics": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.termvectors.FieldStatistics"
+ }
+ ]
+ },
+ "terms": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_global.termvectors.Term"
+ }
+ }
+ },
+ "required": [
+ "terms"
+ ]
+ },
+ "_global.termvectors.FieldStatistics": {
+ "type": "object",
+ "properties": {
+ "doc_count": {
+ "type": "number"
+ },
+ "sum_doc_freq": {
+ "type": "number"
+ },
+ "sum_ttf": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "doc_count",
+ "sum_doc_freq",
+ "sum_ttf"
+ ]
+ },
+ "_global.termvectors.Term": {
+ "type": "object",
+ "properties": {
+ "doc_freq": {
+ "type": "number"
+ },
+ "score": {
+ "type": "number"
+ },
+ "term_freq": {
+ "type": "number"
+ },
+ "tokens": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.termvectors.Token"
+ }
+ },
+ "ttf": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "term_freq"
+ ]
+ },
+ "_global.termvectors.Token": {
+ "type": "object",
+ "properties": {
+ "end_offset": {
+ "type": "number"
+ },
+ "payload": {
+ "type": "string"
+ },
+ "position": {
+ "type": "number"
+ },
+ "start_offset": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "position"
+ ]
+ },
+ "query_rules._types.QueryRule": {
+ "type": "object",
+ "properties": {
+ "rule_id": {
+ "description": "A unique identifier for the rule.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "type": {
+ "description": "The type of rule.\n`pinned` will identify and pin specific documents to the top of search results.\n`exclude` will exclude specific documents from search results.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/query_rules._types.QueryRuleType"
+ }
+ ]
+ },
+ "criteria": {
+ "description": "The criteria that must be met for the rule to be applied.\nIf multiple criteria are specified for a rule, all criteria must be met for the rule to be applied.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/query_rules._types.QueryRuleCriteria"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/query_rules._types.QueryRuleCriteria"
+ }
+ }
+ ]
+ },
+ "actions": {
+ "description": "The actions to take when the rule is matched.\nThe format of this action depends on the rule type.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/query_rules._types.QueryRuleActions"
+ }
+ ]
+ },
+ "priority": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "rule_id",
+ "type",
+ "criteria",
+ "actions"
+ ]
+ },
+ "query_rules._types.QueryRuleType": {
+ "type": "string",
+ "enum": [
+ "pinned",
+ "exclude"
+ ]
+ },
+ "query_rules._types.QueryRuleCriteria": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The type of criteria. The following criteria types are supported:\n\n* `always`: Matches all queries, regardless of input.\n* `contains`: Matches that contain this value anywhere in the field meet the criteria defined by the rule. Only applicable for string values.\n* `exact`: Only exact matches meet the criteria defined by the rule. Applicable for string or numerical values.\n* `fuzzy`: Exact matches or matches within the allowed Levenshtein Edit Distance meet the criteria defined by the rule. Only applicable for string values.\n* `gt`: Matches with a value greater than this value meet the criteria defined by the rule. Only applicable for numerical values.\n* `gte`: Matches with a value greater than or equal to this value meet the criteria defined by the rule. Only applicable for numerical values.\n* `lt`: Matches with a value less than this value meet the criteria defined by the rule. Only applicable for numerical values.\n* `lte`: Matches with a value less than or equal to this value meet the criteria defined by the rule. Only applicable for numerical values.\n* `prefix`: Matches that start with this value meet the criteria defined by the rule. Only applicable for string values.\n* `suffix`: Matches that end with this value meet the criteria defined by the rule. Only applicable for string values.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/query_rules._types.QueryRuleCriteriaType"
+ }
+ ]
+ },
+ "metadata": {
+ "description": "The metadata field to match against.\nThis metadata will be used to match against `match_criteria` sent in the rule.\nIt is required for all criteria types except `always`.",
+ "type": "string"
+ },
+ "values": {
+ "description": "The values to match against the `metadata` field.\nOnly one value must match for the criteria to be met.\nIt is required for all criteria types except `always`.",
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "query_rules._types.QueryRuleCriteriaType": {
+ "type": "string",
+ "enum": [
+ "global",
+ "exact",
+ "exact_fuzzy",
+ "fuzzy",
+ "prefix",
+ "suffix",
+ "contains",
+ "lt",
+ "lte",
+ "gt",
+ "gte",
+ "always"
+ ]
+ },
+ "query_rules._types.QueryRuleActions": {
+ "type": "object",
+ "properties": {
+ "ids": {
+ "description": "The unique document IDs of the documents to apply the rule to.\nOnly one of `ids` or `docs` may be specified and at least one must be specified.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ },
+ "docs": {
+ "description": "The documents to apply the rule to.\nOnly one of `ids` or `docs` may be specified and at least one must be specified.\nThere is a maximum value of 100 documents in a rule.\nYou can specify the following attributes for each document:\n\n* `_index`: The index of the document to pin.\n* `_id`: The unique document ID.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.PinnedDoc"
+ }
+ }
+ }
+ },
+ "query_rules._types.QueryRuleset": {
+ "type": "object",
+ "properties": {
+ "ruleset_id": {
+ "description": "A unique identifier for the ruleset.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "rules": {
+ "description": "Rules associated with the query ruleset.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/query_rules._types.QueryRule"
+ }
+ }
+ },
+ "required": [
+ "ruleset_id",
+ "rules"
+ ]
+ },
+ "query_rules.list_rulesets.QueryRulesetListItem": {
+ "type": "object",
+ "properties": {
+ "ruleset_id": {
+ "description": "A unique identifier for the ruleset.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "rule_total_count": {
+ "description": "The number of rules associated with the ruleset.",
+ "type": "number"
+ },
+ "rule_criteria_types_counts": {
+ "description": "A map of criteria type (for example, `exact`) to the number of rules of that type.\n\nNOTE: The counts in `rule_criteria_types_counts` may be larger than the value of `rule_total_count` because a rule may have multiple criteria.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "number"
+ }
+ },
+ "rule_type_counts": {
+ "description": "A map of rule type (for example, `pinned`) to the number of rules of that type.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "number"
+ }
+ }
+ },
+ "required": [
+ "ruleset_id",
+ "rule_total_count",
+ "rule_criteria_types_counts",
+ "rule_type_counts"
+ ]
+ },
+ "query_rules.test.QueryRulesetMatchedRule": {
+ "type": "object",
+ "properties": {
+ "ruleset_id": {
+ "description": "Ruleset unique identifier",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "rule_id": {
+ "description": "Rule unique identifier within that ruleset",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ruleset_id",
+ "rule_id"
+ ]
+ },
+ "_global.rank_eval.RankEvalRequestItem": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The search request’s ID, used to group result details later.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "request": {
+ "description": "The query being evaluated.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.rank_eval.RankEvalQuery"
+ }
+ ]
+ },
+ "ratings": {
+ "description": "List of document ratings",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.rank_eval.DocumentRating"
+ }
+ },
+ "template_id": {
+ "description": "The search template Id",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "params": {
+ "description": "The search template parameters.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "required": [
+ "id",
+ "ratings"
+ ]
+ },
+ "_global.rank_eval.RankEvalQuery": {
+ "type": "object",
+ "properties": {
+ "query": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "size": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "query"
+ ]
+ },
+ "_global.rank_eval.DocumentRating": {
+ "type": "object",
+ "properties": {
+ "_id": {
+ "description": "The document ID.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "_index": {
+ "description": "The document’s index. For data streams, this should be the document’s backing index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "rating": {
+ "description": "The document’s relevance with regard to this search request.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "_id",
+ "_index",
+ "rating"
+ ]
+ },
+ "_global.rank_eval.RankEvalMetric": {
+ "type": "object",
+ "properties": {
+ "precision": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricPrecision"
+ }
+ ]
+ },
+ "recall": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricRecall"
+ }
+ ]
+ },
+ "mean_reciprocal_rank": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricMeanReciprocalRank"
+ }
+ ]
+ },
+ "dcg": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricDiscountedCumulativeGain"
+ }
+ ]
+ },
+ "expected_reciprocal_rank": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricExpectedReciprocalRank"
+ }
+ ]
+ }
+ }
+ },
+ "_global.rank_eval.RankEvalMetricPrecision": {
+ "description": "Precision at K (P@k)",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricRatingTreshold"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "ignore_unlabeled": {
+ "description": "Controls how unlabeled documents in the search results are counted. If set to true, unlabeled documents are ignored and neither count as relevant or irrelevant. Set to false (the default), they are treated as irrelevant.",
+ "default": false,
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "_global.rank_eval.RankEvalMetricRatingTreshold": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "relevant_rating_threshold": {
+ "description": "Sets the rating threshold above which documents are considered to be \"relevant\".",
+ "default": 1.0,
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "_global.rank_eval.RankEvalMetricBase": {
+ "type": "object",
+ "properties": {
+ "k": {
+ "description": "Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query.",
+ "default": 10.0,
+ "type": "number"
+ }
+ }
+ },
+ "_global.rank_eval.RankEvalMetricRecall": {
+ "description": "Recall at K (R@k)",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricRatingTreshold"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_global.rank_eval.RankEvalMetricMeanReciprocalRank": {
+ "description": "Mean Reciprocal Rank",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricRatingTreshold"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "_global.rank_eval.RankEvalMetricDiscountedCumulativeGain": {
+ "description": "Discounted cumulative gain (DCG)",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "normalize": {
+ "description": "If set to true, this metric will calculate the Normalized DCG.",
+ "default": false,
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "_global.rank_eval.RankEvalMetricExpectedReciprocalRank": {
+ "description": "Expected Reciprocal Rank (ERR)",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "maximum_relevance": {
+ "description": "The highest relevance grade used in the user-supplied relevance judgments.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "maximum_relevance"
+ ]
+ }
+ ]
+ },
+ "_global.rank_eval.RankEvalMetricDetail": {
+ "type": "object",
+ "properties": {
+ "metric_score": {
+ "description": "The metric_score in the details section shows the contribution of this query to the global quality metric score",
+ "type": "number"
+ },
+ "unrated_docs": {
+ "description": "The unrated_docs section contains an _index and _id entry for each document in the search result for this query that didn’t have a ratings value. This can be used to ask the user to supply ratings for these documents",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.rank_eval.UnratedDocument"
+ }
+ },
+ "hits": {
+ "description": "The hits section shows a grouping of the search results with their supplied ratings",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.rank_eval.RankEvalHitItem"
+ }
+ },
+ "metric_details": {
+ "description": "The metric_details give additional information about the calculated quality metric (e.g. how many of the retrieved documents were relevant). The content varies for each metric but allows for better interpretation of the results",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "required": [
+ "metric_score",
+ "unrated_docs",
+ "hits",
+ "metric_details"
+ ]
+ },
+ "_global.rank_eval.UnratedDocument": {
+ "type": "object",
+ "properties": {
+ "_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "_index": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ }
+ },
+ "required": [
+ "_id",
+ "_index"
+ ]
+ },
+ "_global.rank_eval.RankEvalHitItem": {
+ "type": "object",
+ "properties": {
+ "hit": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.rank_eval.RankEvalHit"
+ }
+ ]
+ },
+ "rating": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "nullable": true,
+ "type": "string"
+ }
+ ]
+ }
+ },
+ "required": [
+ "hit"
+ ]
+ },
+ "_global.rank_eval.RankEvalHit": {
+ "type": "object",
+ "properties": {
+ "_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "_index": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "_score": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "_id",
+ "_index",
+ "_score"
+ ]
+ },
+ "_global.reindex.Destination": {
+ "type": "object",
+ "properties": {
+ "index": {
+ "description": "The name of the data stream, index, or index alias you are copying to.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "op_type": {
+ "description": "If it is `create`, the operation will only index documents that do not already exist (also known as \"put if absent\").\n\nIMPORTANT: To reindex to a data stream destination, this argument must be `create`.\n\nSupported values include:\n - `index`: Overwrite any documents that already exist.\n - `create`: Only index documents that do not already exist.\n\n",
+ "default": "index",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.OpType"
+ }
+ ]
+ },
+ "pipeline": {
+ "description": "The name of the pipeline to use.",
+ "type": "string"
+ },
+ "routing": {
+ "description": "By default, a document's routing is preserved unless it's changed by the script.\nIf it is `keep`, the routing on the bulk request sent for each match is set to the routing on the match.\nIf it is `discard`, the routing on the bulk request sent for each match is set to `null`.\nIf it is `=value`, the routing on the bulk request sent for each match is set to all value specified after the equals sign (`=`).",
+ "default": "keep",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Routing"
+ }
+ ]
+ },
+ "version_type": {
+ "description": "The versioning to use for the indexing operation.\n\nSupported values include:\n - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n - `force`: This option is deprecated because it can cause primary and replica shards to diverge.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionType"
+ }
+ ]
+ }
+ },
+ "required": [
+ "index"
+ ]
+ },
+ "_global.reindex.Source": {
+ "type": "object",
+ "properties": {
+ "index": {
+ "description": "The name of the data stream, index, or alias you are copying from.\nIt accepts a comma-separated list to reindex from multiple sources.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Indices"
+ }
+ ]
+ },
+ "query": {
+ "description": "The documents to reindex, which is defined with Query DSL.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "remote": {
+ "description": "A remote instance of Elasticsearch that you want to index from.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.reindex.RemoteSource"
+ }
+ ]
+ },
+ "size": {
+ "description": "The number of documents to index per batch.\nUse it when you are indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB.",
+ "default": 1000.0,
+ "type": "number"
+ },
+ "slice": {
+ "description": "Slice the reindex request manually using the provided slice ID and total number of slices.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SlicedScroll"
+ }
+ ]
+ },
+ "sort": {
+ "deprecated": true,
+ "description": "A comma-separated list of `:` pairs to sort by before indexing.\nUse it in conjunction with `max_docs` to control what documents are reindexed.\n\nWARNING: Sort in reindex is deprecated.\nSorting in reindex was never guaranteed to index documents in order and prevents further development of reindex such as resilience and performance improvements.\nIf used in combination with `max_docs`, consider using a query filter instead.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Sort"
+ }
+ ]
+ },
+ "_source": {
+ "description": "If `true`, reindex all source fields.\nSet it to a list to reindex select fields.",
+ "default": "true",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ },
+ "runtime_mappings": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RuntimeFields"
+ }
+ ]
+ }
+ },
+ "required": [
+ "index"
+ ]
+ },
+ "_global.reindex.RemoteSource": {
+ "type": "object",
+ "properties": {
+ "connect_timeout": {
+ "description": "The remote connection timeout.",
+ "default": "30s",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "headers": {
+ "description": "An object containing the headers of the request.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "host": {
+ "description": "The URL for the remote instance of Elasticsearch that you want to index from.\nThis information is required when you're indexing from remote.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Host"
+ }
+ ]
+ },
+ "username": {
+ "description": "The username to use for authentication with the remote host.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Username"
+ }
+ ]
+ },
+ "password": {
+ "description": "The password to use for authentication with the remote host.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Password"
+ }
+ ]
+ },
+ "socket_timeout": {
+ "description": "The remote socket read timeout.",
+ "default": "30s",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ }
+ },
+ "required": [
+ "host"
+ ]
+ },
+ "_types.Host": {
+ "type": "string"
+ },
+ "_types.Username": {
+ "type": "string"
+ },
+ "_types.Password": {
+ "type": "string"
+ },
+ "_global.scripts_painless_execute.PainlessContext": {
+ "type": "string",
+ "enum": [
+ "painless_test",
+ "filter",
+ "score",
+ "boolean_field",
+ "date_field",
+ "double_field",
+ "geo_point_field",
+ "ip_field",
+ "keyword_field",
+ "long_field",
+ "composite_field"
+ ]
+ },
+ "_global.scripts_painless_execute.PainlessContextSetup": {
+ "type": "object",
+ "properties": {
+ "document": {
+ "description": "Document that's temporarily indexed in-memory and accessible from the script.",
+ "type": "object"
+ },
+ "index": {
+ "description": "Index containing a mapping that's compatible with the indexed document.\nYou may specify a remote index by prefixing the index with the remote cluster alias.\nFor example, `remote1:my_index` indicates that you want to run the painless script against the \"my_index\" index on the \"remote1\" cluster.\nThis request will be forwarded to the \"remote1\" cluster if you have configured a connection to that remote cluster.\n\nNOTE: Wildcards are not accepted in the index expression for this endpoint.\nThe expression `*:myindex` will return the error \"No such remote cluster\" and the expression `logs*` or `remote1:logs*` will return the error \"index not found\".",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "query": {
+ "description": "Use this parameter to specify a query for computing a score.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ }
+ },
+ "required": [
+ "document",
+ "index"
+ ]
+ },
+ "search_application._types.SearchApplication": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/search_application._types.SearchApplicationParameters"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Search Application name",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "updated_at_millis": {
+ "description": "Last time the Search Application was updated.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ }
+ },
+ "required": [
+ "name",
+ "updated_at_millis"
+ ]
+ }
+ ]
+ },
+ "search_application._types.SearchApplicationParameters": {
+ "type": "object",
+ "properties": {
+ "indices": {
+ "description": "Indices that are part of the Search Application.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ },
+ "analytics_collection_name": {
+ "description": "Analytics collection associated to the Search Application.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "template": {
+ "description": "Search template to use on search operations.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/search_application._types.SearchApplicationTemplate"
+ }
+ ]
+ }
+ },
+ "required": [
+ "indices"
+ ]
+ },
+ "search_application._types.SearchApplicationTemplate": {
+ "type": "object",
+ "properties": {
+ "script": {
+ "description": "The associated mustache template.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ }
+ },
+ "required": [
+ "script"
+ ]
+ },
+ "search_application._types.AnalyticsCollection": {
+ "type": "object",
+ "properties": {
+ "event_data_stream": {
+ "description": "Data stream for the collection.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/search_application._types.EventDataStream"
+ }
+ ]
+ }
+ },
+ "required": [
+ "event_data_stream"
+ ]
+ },
+ "search_application._types.EventDataStream": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "search_application.put_behavioral_analytics.AnalyticsAcknowledgeResponseBase": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the analytics collection created or updated",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ }
+ },
+ "required": [
+ "name"
+ ]
+ }
+ ]
+ },
+ "_global.search_mvt._types.ZoomLevel": {
+ "type": "number"
+ },
+ "_global.search_mvt._types.Coordinate": {
+ "type": "number"
+ },
+ "_global.search_mvt._types.GridAggregationType": {
+ "type": "string",
+ "enum": [
+ "geotile",
+ "geohex"
+ ]
+ },
+ "_global.search_mvt._types.GridType": {
+ "type": "string",
+ "enum": [
+ "grid",
+ "point",
+ "centroid"
+ ]
+ },
+ "_types.MapboxVectorTiles": {
+ "type": "object"
+ },
+ "security.authenticate.AuthenticateApiKey": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "security._types.RealmInfo": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "type"
+ ]
+ },
+ "security.authenticate.Token": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "type": {
+ "x-state": "Generally available",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "security._types.RoleDescriptor": {
+ "type": "object",
+ "properties": {
+ "cluster": {
+ "description": "A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/security._types.ClusterPrivilege"
+ }
+ },
+ "indices": {
+ "description": "A list of indices permissions entries.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/security._types.IndicesPrivileges"
+ }
+ },
+ "applications": {
+ "description": "A list of application privilege entries",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/security._types.ApplicationPrivileges"
+ }
+ },
+ "metadata": {
+ "description": "Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ },
+ "run_as": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/submitting-requests-on-behalf-of-other-users"
+ },
+ "description": "A list of users that the API keys can impersonate.\nNOTE: In Elastic Cloud Serverless, the run-as feature is disabled.\nFor API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "description": "Optional description of the role descriptor",
+ "type": "string"
+ },
+ "restriction": {
+ "description": "Restriction for when the role descriptor is allowed to be effective.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/security._types.Restriction"
+ }
+ ]
+ },
+ "transient_metadata": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "security._types.ClusterPrivilege": {
+ "anyOf": [
+ {
+ "type": "string",
+ "enum": [
+ "all",
+ "cancel_task",
+ "manage",
+ "manage_api_key",
+ "manage_behavioral_analytics",
+ "manage_enrich",
+ "manage_esql",
+ "manage_index_templates",
+ "manage_inference",
+ "manage_ingest_pipelines",
+ "manage_logstash_pipelines",
+ "manage_ml",
+ "manage_own_api_key",
+ "manage_pipeline",
+ "manage_search_application",
+ "manage_search_query_rules",
+ "manage_search_synonyms",
+ "manage_security",
+ "manage_transform",
+ "monitor",
+ "monitor_enrich",
+ "monitor_esql",
+ "monitor_inference",
+ "monitor_ml",
+ "monitor_transform",
+ "none",
+ "post_behavioral_analytics_event",
+ "read_pipeline",
+ "read_security"
+ ]
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "security._types.IndicesPrivileges": {
+ "type": "object",
+ "properties": {
+ "field_security": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level"
+ },
+ "description": "The document fields that the owners of the role have read access to.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/security._types.FieldSecurity"
+ }
+ ]
+ },
+ "names": {
+ "description": "A list of indices (or index name patterns) to which the permissions in this entry apply.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ }
+ ]
+ },
+ "privileges": {
+ "description": "The index level privileges that owners of the role have on the specified indices.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/security._types.IndexPrivilege"
+ }
+ },
+ "query": {
+ "description": "A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/security._types.IndicesPrivilegesQuery"
+ }
+ ]
+ }
+ },
+ "required": [
+ "names",
+ "privileges"
+ ]
+ },
+ "security._types.FieldSecurity": {
+ "type": "object",
+ "properties": {
+ "except": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ },
+ "grant": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ }
+ }
+ },
+ "security._types.IndexPrivilege": {
+ "anyOf": [
+ {
+ "type": "string",
+ "enum": [
+ "all",
+ "auto_configure",
+ "create",
+ "create_doc",
+ "create_index",
+ "delete",
+ "delete_index",
+ "index",
+ "maintenance",
+ "manage",
+ "manage_data_stream_lifecycle",
+ "monitor",
+ "none",
+ "read",
+ "view_index_metadata",
+ "write"
+ ]
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "security._types.IndicesPrivilegesQuery": {
+ "description": "While creating or updating a role you can provide either a JSON structure or a string to the API.\nHowever, the response provided by Elasticsearch will only be string with a json-as-text content.\n\nSince this is embedded in `IndicesPrivileges`, the same structure is used for clarity in both contexts.",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ },
+ {
+ "$ref": "#/components/schemas/security._types.RoleTemplateQuery"
+ }
+ ]
+ },
+ "security._types.RoleTemplateQuery": {
+ "type": "object",
+ "properties": {
+ "template": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level#templating-role-query"
+ },
+ "description": "When you create a role, you can specify a query that defines the document level security permissions. You can optionally\nuse Mustache templates in the role query to insert the username of the current authenticated user into the role.\nLike other places in Elasticsearch that support templating or scripting, you can specify inline, stored, or file-based\ntemplates and define custom parameters. You access the details for the current authenticated user through the _user parameter.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/security._types.RoleTemplateScript"
+ }
+ ]
+ }
+ }
+ },
+ "security._types.RoleTemplateScript": {
+ "type": "object",
+ "properties": {
+ "source": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/security._types.RoleTemplateInlineQuery"
+ }
+ ]
+ },
+ "id": {
+ "description": "The `id` for a stored script.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "params": {
+ "description": "Specifies any named parameters that are passed into the script as variables.\nUse parameters instead of hard-coded values to decrease compile time.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "lang": {
+ "description": "Specifies the language the script is written in.\n\nSupported values include:\n - `painless`: Painless scripting language, purpose-built for Elasticsearch.\n - `expression`: Lucene’s expressions language, compiles a JavaScript expression to bytecode.\n - `mustache`: Mustache templated, used for templates.\n - `java`: Expert Java API\n\n",
+ "default": "painless",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScriptLanguage"
+ }
+ ]
+ },
+ "options": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "security._types.RoleTemplateInlineQuery": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "security._types.ApplicationPrivileges": {
+ "type": "object",
+ "properties": {
+ "application": {
+ "description": "The name of the application to which this entry applies.",
+ "type": "string"
+ },
+ "privileges": {
+ "description": "A list of strings, where each element is the name of an application privilege or action.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "resources": {
+ "description": "A list resources to which the privileges are applied.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "application",
+ "privileges",
+ "resources"
+ ]
+ },
+ "security._types.Restriction": {
+ "type": "object",
+ "properties": {
+ "workflows": {
+ "description": "A list of workflows to which the API key is restricted.\nNOTE: In order to use a role restriction, an API key must be created with a single role descriptor.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/security._types.RestrictionWorkflow"
+ }
+ }
+ },
+ "required": [
+ "workflows"
+ ]
+ },
+ "security._types.RestrictionWorkflow": {
+ "anyOf": [
+ {
+ "type": "string",
+ "enum": [
+ "search_application_query"
+ ]
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "security._types.ApiKey": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Id for the API key",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "name": {
+ "description": "Name of the API key.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "type": {
+ "description": "The type of the API key (e.g. `rest` or `cross_cluster`).",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/security._types.ApiKeyType"
+ }
+ ]
+ },
+ "creation": {
+ "description": "Creation time for the API key in milliseconds.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "expiration": {
+ "description": "Expiration time for the API key in milliseconds.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "invalidated": {
+ "description": "Invalidation status for the API key.\nIf the key has been invalidated, it has a value of `true`. Otherwise, it is `false`.",
+ "type": "boolean"
+ },
+ "invalidation": {
+ "description": "If the key has been invalidated, invalidation time in milliseconds.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "username": {
+ "description": "Principal for which this API key was created",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Username"
+ }
+ ]
+ },
+ "realm": {
+ "description": "Realm name of the principal for which this API key was created.",
+ "type": "string"
+ },
+ "realm_type": {
+ "description": "Realm type of the principal for which this API key was created",
+ "x-state": "Generally available",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "Metadata of the API key",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ },
+ "role_descriptors": {
+ "description": "The role descriptors assigned to this API key when it was created or last updated.\nAn empty role descriptor means the API key inherits the owner user’s permissions.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/security._types.RoleDescriptor"
+ }
+ },
+ "limited_by": {
+ "description": "The owner user’s permissions associated with the API key.\nIt is a point-in-time snapshot captured at creation and subsequent updates.\nAn API key’s effective permissions are an intersection of its assigned privileges and the owner user’s permissions.",
+ "x-state": "Generally available",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/security._types.RoleDescriptor"
+ }
+ }
+ },
+ "access": {
+ "description": "The access granted to cross-cluster API keys.\nThe access is composed of permissions for cross cluster search and cross cluster replication.\nAt least one of them must be specified.\nWhen specified, the new access assignment fully replaces the previously assigned access.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/security._types.Access"
+ }
+ ]
+ },
+ "profile_uid": {
+ "description": "The profile uid for the API key owner principal, if requested and if it exists",
+ "x-state": "Generally available",
+ "type": "string"
+ },
+ "_sort": {
+ "description": "Sorting values when using the `sort` parameter with the `security.query_api_keys` API.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SortResults"
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "type",
+ "creation",
+ "invalidated",
+ "username",
+ "realm",
+ "metadata"
+ ]
+ },
+ "security._types.ApiKeyType": {
+ "type": "string",
+ "enum": [
+ "rest",
+ "cross_cluster"
+ ]
+ },
+ "security._types.Access": {
+ "type": "object",
+ "properties": {
+ "replication": {
+ "description": "A list of indices permission entries for cross-cluster replication.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/security._types.ReplicationAccess"
+ }
+ },
+ "search": {
+ "description": "A list of indices permission entries for cross-cluster search.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/security._types.SearchAccess"
+ }
+ }
+ }
+ },
+ "security._types.ReplicationAccess": {
+ "type": "object",
+ "properties": {
+ "names": {
+ "description": "A list of indices (or index name patterns) to which the permissions in this entry apply.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ }
+ ]
+ },
+ "allow_restricted_indices": {
+ "description": "This needs to be set to true if the patterns in the names field should cover system indices.",
+ "default": false,
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "names"
+ ]
+ },
+ "security._types.SearchAccess": {
+ "type": "object",
+ "properties": {
+ "field_security": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level"
+ },
+ "description": "The document fields that the owners of the role have read access to.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/security._types.FieldSecurity"
+ }
+ ]
+ },
+ "names": {
+ "description": "A list of indices (or index name patterns) to which the permissions in this entry apply.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ }
+ ]
+ },
+ "query": {
+ "description": "A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/security._types.IndicesPrivilegesQuery"
+ }
+ ]
+ }
+ },
+ "required": [
+ "names"
+ ]
+ },
+ "security.get_role.Role": {
+ "type": "object",
+ "properties": {
+ "cluster": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/security._types.ClusterPrivilege"
+ }
+ },
+ "indices": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/security._types.IndicesPrivileges"
+ }
+ },
+ "metadata": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ },
+ "description": {
+ "type": "string"
+ },
+ "run_as": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "transient_metadata": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "applications": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/security._types.ApplicationPrivileges"
+ }
+ },
+ "role_templates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/security._types.RoleTemplate"
+ }
+ },
+ "global": {
+ "x-state": "Generally available",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "required": [
+ "cluster",
+ "indices",
+ "metadata",
+ "applications"
+ ]
+ },
+ "security._types.RoleTemplate": {
+ "type": "object",
+ "properties": {
+ "format": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/security._types.TemplateFormat"
+ }
+ ]
+ },
+ "template": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ }
+ },
+ "required": [
+ "template"
+ ]
+ },
+ "security._types.TemplateFormat": {
+ "type": "string",
+ "enum": [
+ "string",
+ "json"
+ ]
+ },
+ "security.has_privileges.ApplicationPrivilegesCheck": {
+ "type": "object",
+ "properties": {
+ "application": {
+ "description": "The name of the application.",
+ "type": "string"
+ },
+ "privileges": {
+ "description": "A list of the privileges that you want to check for the specified resources.\nIt may be either application privilege names or the names of actions that are granted by those privileges",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "resources": {
+ "description": "A list of resource names against which the privileges should be checked.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "application",
+ "privileges",
+ "resources"
+ ]
+ },
+ "security.has_privileges.IndexPrivilegesCheck": {
+ "type": "object",
+ "properties": {
+ "names": {
+ "description": "A list of indices.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Indices"
+ }
+ ]
+ },
+ "privileges": {
+ "description": "A list of the privileges that you want to check for the specified indices.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/security._types.IndexPrivilege"
+ }
+ },
+ "allow_restricted_indices": {
+ "description": "This needs to be set to `true` (default is `false`) if using wildcards or regexps for patterns that cover restricted indices.\nImplicitly, restricted indices do not match index patterns because restricted indices usually have limited privileges and including them in pattern tests would render most such tests false.\nIf restricted indices are explicitly included in the names list, privileges will be checked against them regardless of the value of `allow_restricted_indices`.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "names",
+ "privileges"
+ ]
+ },
+ "security.has_privileges.ApplicationsPrivileges": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/security.has_privileges.ResourcePrivileges"
+ }
+ },
+ "security.has_privileges.ResourcePrivileges": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/security.has_privileges.Privileges"
+ }
+ },
+ "security.has_privileges.Privileges": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "boolean"
+ }
+ },
+ "security._types.CreatedStatus": {
+ "type": "object",
+ "properties": {
+ "created": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "created"
+ ]
+ },
+ "security.query_api_keys.ApiKeyAggregationContainer": {
+ "allOf": [
+ {
+ "type": "object",
+ "properties": {
+ "aggregations": {
+ "description": "Sub-aggregations for this aggregation.\nOnly applies to bucket aggregations.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/security.query_api_keys.ApiKeyAggregationContainer"
+ }
+ },
+ "meta": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ }
+ }
+ },
+ {
+ "type": "object",
+ "properties": {
+ "cardinality": {
+ "description": "A single-value metrics aggregation that calculates an approximate count of distinct values.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CardinalityAggregation"
+ }
+ ]
+ },
+ "composite": {
+ "description": "A multi-bucket aggregation that creates composite buckets from different sources.\nUnlike the other multi-bucket aggregations, you can use the `composite` aggregation to paginate *all* buckets from a multi-level aggregation efficiently.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CompositeAggregation"
+ }
+ ]
+ },
+ "date_range": {
+ "description": "A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.DateRangeAggregation"
+ }
+ ]
+ },
+ "filter": {
+ "description": "A single bucket aggregation that narrows the set of documents to those that match a query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/security.query_api_keys.ApiKeyQueryContainer"
+ }
+ ]
+ },
+ "filters": {
+ "description": "A multi-bucket aggregation where each bucket contains the documents that match a query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/security.query_api_keys.ApiKeyFiltersAggregation"
+ }
+ ]
+ },
+ "missing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MissingAggregation"
+ }
+ ]
+ },
+ "range": {
+ "description": "A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.RangeAggregation"
+ }
+ ]
+ },
+ "terms": {
+ "description": "A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsAggregation"
+ }
+ ]
+ },
+ "value_count": {
+ "description": "A single-value metrics aggregation that counts the number of values that are extracted from the aggregated documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ValueCountAggregation"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ }
+ ]
+ },
+ "security.query_api_keys.ApiKeyQueryContainer": {
+ "type": "object",
+ "properties": {
+ "bool": {
+ "description": "Matches documents matching boolean combinations of other queries.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.BoolQuery"
+ }
+ ]
+ },
+ "exists": {
+ "description": "Returns documents that contain an indexed value for a field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.ExistsQuery"
+ }
+ ]
+ },
+ "ids": {
+ "description": "Returns documents based on their IDs.\nThis query uses document IDs stored in the `_id` field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IdsQuery"
+ }
+ ]
+ },
+ "match": {
+ "description": "Returns documents that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.MatchQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "match_all": {
+ "description": "Matches all documents, giving them all a `_score` of 1.0.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.MatchAllQuery"
+ }
+ ]
+ },
+ "prefix": {
+ "description": "Returns documents that contain a specific prefix in a provided field.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.PrefixQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "range": {
+ "description": "Returns documents that contain terms within a provided range.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.RangeQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "simple_query_string": {
+ "description": "Returns documents based on a provided query string, using a parser with a limited but fault-tolerant syntax.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringQuery"
+ }
+ ]
+ },
+ "term": {
+ "description": "Returns documents that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.TermQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "terms": {
+ "description": "Returns documents that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.TermsQuery"
+ }
+ ]
+ },
+ "wildcard": {
+ "description": "Returns documents that contain terms matching a wildcard pattern.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.WildcardQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "security.query_api_keys.ApiKeyFiltersAggregation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketAggregationBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "filters": {
+ "description": "Collection of queries from which to build buckets.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.BucketsApiKeyQueryContainer"
+ }
+ ]
+ },
+ "other_bucket": {
+ "description": "Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters.",
+ "type": "boolean"
+ },
+ "other_bucket_key": {
+ "description": "The key with which the other bucket is returned.",
+ "default": "_other_",
+ "type": "string"
+ },
+ "keyed": {
+ "description": "By default, the named filters aggregation returns the buckets as an object.\nSet to `false` to return the buckets as an array of objects.",
+ "default": true,
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "_types.aggregations.BucketsApiKeyQueryContainer": {
+ "description": "Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for\nthe different buckets, the result is a dictionary.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/security.query_api_keys.ApiKeyQueryContainer"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/security.query_api_keys.ApiKeyQueryContainer"
+ }
+ }
+ ]
+ },
+ "security.query_api_keys.ApiKeyAggregate": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CardinalityAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.ValueCountAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.StringTermsAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.LongTermsAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.DoubleTermsAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.UnmappedTermsAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MultiTermsAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.MissingAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.FilterAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.FiltersAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.RangeAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.DateRangeAggregate"
+ },
+ {
+ "$ref": "#/components/schemas/_types.aggregations.CompositeAggregate"
+ }
+ ]
+ },
+ "security.query_role.RoleQueryContainer": {
+ "type": "object",
+ "properties": {
+ "bool": {
+ "description": "matches roles matching boolean combinations of other queries.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.BoolQuery"
+ }
+ ]
+ },
+ "exists": {
+ "description": "Returns roles that contain an indexed value for a field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.ExistsQuery"
+ }
+ ]
+ },
+ "ids": {
+ "description": "Returns roles based on their IDs.\nThis query uses role document IDs stored in the `_id` field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.IdsQuery"
+ }
+ ]
+ },
+ "match": {
+ "description": "Returns roles that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.MatchQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "match_all": {
+ "description": "Matches all roles, giving them all a `_score` of 1.0.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.MatchAllQuery"
+ }
+ ]
+ },
+ "prefix": {
+ "description": "Returns roles that contain a specific prefix in a provided field.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.PrefixQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "range": {
+ "description": "Returns roles that contain terms within a provided range.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.RangeQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "simple_query_string": {
+ "description": "Returns roles based on a provided query string, using a parser with a limited but fault-tolerant syntax.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.SimpleQueryStringQuery"
+ }
+ ]
+ },
+ "term": {
+ "description": "Returns roles that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.TermQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "terms": {
+ "description": "Returns roles that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.TermsQuery"
+ }
+ ]
+ },
+ "wildcard": {
+ "description": "Returns roles that contain terms matching a wildcard pattern.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.query_dsl.WildcardQuery"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "security.query_role.QueryRole": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/security._types.RoleDescriptor"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "_sort": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SortResults"
+ }
+ ]
+ },
+ "name": {
+ "description": "Name of the role.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name"
+ ]
+ }
+ ]
+ },
+ "sql._types.Column": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "type"
+ ]
+ },
+ "sql._types.Row": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ },
+ "sql.query.SqlFormat": {
+ "type": "string",
+ "enum": [
+ "csv",
+ "json",
+ "tsv",
+ "txt",
+ "yaml",
+ "cbor",
+ "smile"
+ ]
+ },
+ "synonyms._types.SynonymsUpdateResult": {
+ "type": "object",
+ "properties": {
+ "result": {
+ "description": "The update operation result.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Result"
+ }
+ ]
+ },
+ "reload_analyzers_details": {
+ "description": "Updating synonyms in a synonym set can reload the associated analyzers in case refresh is set to true.\nThis information is the analyzers reloading result.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices.reload_search_analyzers.ReloadResult"
+ }
+ ]
+ }
+ },
+ "required": [
+ "result"
+ ]
+ },
+ "indices.reload_search_analyzers.ReloadResult": {
+ "type": "object",
+ "properties": {
+ "reload_details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/indices.reload_search_analyzers.ReloadDetails"
+ }
+ },
+ "_shards": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ShardStatistics"
+ }
+ ]
+ }
+ },
+ "required": [
+ "reload_details",
+ "_shards"
+ ]
+ },
+ "indices.reload_search_analyzers.ReloadDetails": {
+ "type": "object",
+ "properties": {
+ "index": {
+ "type": "string"
+ },
+ "reloaded_analyzers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "reloaded_node_ids": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "index",
+ "reloaded_analyzers",
+ "reloaded_node_ids"
+ ]
+ },
+ "synonyms._types.SynonymRuleRead": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Synonym Rule identifier",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "synonyms": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/text-analysis/analysis-synonym-graph-tokenfilter#_solr_format_2"
+ },
+ "description": "Synonyms, in Solr format, that conform the synonym rule.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/synonyms._types.SynonymString"
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "synonyms"
+ ]
+ },
+ "synonyms._types.SynonymString": {
+ "type": "string"
+ },
+ "synonyms.get_synonyms_sets.SynonymsSetItem": {
+ "type": "object",
+ "properties": {
+ "synonyms_set": {
+ "description": "Synonyms set identifier",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "count": {
+ "description": "Number of synonym rules that the synonym set contains",
+ "type": "number"
+ }
+ },
+ "required": [
+ "synonyms_set",
+ "count"
+ ]
+ },
+ "synonyms._types.SynonymRule": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The identifier for the synonym rule.\nIf you do not specify a synonym rule ID when you create a rule, an identifier is created automatically by Elasticsearch.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "synonyms": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/text-analysis/analysis-synonym-graph-tokenfilter#analysis-synonym-graph-define-synonyms"
+ },
+ "description": "The synonyms that conform the synonym rule in Solr format.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/synonyms._types.SynonymString"
+ }
+ ]
+ }
+ },
+ "required": [
+ "synonyms"
+ ]
+ },
+ "tasks._types.TaskInfo": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string"
+ },
+ "cancelled": {
+ "type": "boolean"
+ },
+ "cancellable": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Human readable text that identifies the particular request that the task is performing.\nFor example, it might identify the search request being performed by a search task.\nOther kinds of tasks have different descriptions, like `_reindex` which has the source and the destination, or `_bulk` which just has the number of requests and the destination indices.\nMany requests will have only an empty description because more detailed information about the request is not easily available or particularly helpful in identifying the request.",
+ "type": "string"
+ },
+ "headers": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "id": {
+ "type": "number"
+ },
+ "node": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.NodeId"
+ }
+ ]
+ },
+ "running_time": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "running_time_in_nanos": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitNanos"
+ }
+ ]
+ },
+ "start_time_in_millis": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "status": {
+ "description": "The internal status of the task, which varies from task to task.\nThe format also varies.\nWhile the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes.\nFields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases.",
+ "type": "object"
+ },
+ "type": {
+ "type": "string"
+ },
+ "parent_task_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.TaskId"
+ }
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "cancellable",
+ "headers",
+ "id",
+ "node",
+ "running_time_in_nanos",
+ "start_time_in_millis",
+ "type"
+ ]
+ },
+ "transform.get_transform.TransformSummary": {
+ "type": "object",
+ "properties": {
+ "authorization": {
+ "description": "The security privileges that the transform uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the transform, this property is omitted.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.TransformAuthorization"
+ }
+ ]
+ },
+ "create_time": {
+ "description": "The time the transform was created.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "create_time_string": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "description": {
+ "description": "Free text description of the transform.",
+ "type": "string"
+ },
+ "dest": {
+ "description": "The destination for the transform.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.reindex.Destination"
+ }
+ ]
+ },
+ "frequency": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "latest": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.Latest"
+ }
+ ]
+ },
+ "pivot": {
+ "description": "The pivot method transforms the data by aggregating and grouping it.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.Pivot"
+ }
+ ]
+ },
+ "retention_policy": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.RetentionPolicyContainer"
+ }
+ ]
+ },
+ "settings": {
+ "description": "Defines optional transform settings.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.Settings"
+ }
+ ]
+ },
+ "source": {
+ "description": "The source of the data for the transform.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.Source"
+ }
+ ]
+ },
+ "sync": {
+ "description": "Defines the properties transforms require to run continuously.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.SyncContainer"
+ }
+ ]
+ },
+ "version": {
+ "description": "The version of Elasticsearch that existed on the node when the transform was created.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionString"
+ }
+ ]
+ },
+ "_meta": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ }
+ },
+ "required": [
+ "dest",
+ "id",
+ "source"
+ ]
+ },
+ "ml._types.TransformAuthorization": {
+ "type": "object",
+ "properties": {
+ "api_key": {
+ "description": "If an API key was used for the most recent update to the transform, its name and identifier are listed in the response.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.ApiKeyAuthorization"
+ }
+ ]
+ },
+ "roles": {
+ "description": "If a user ID was used for the most recent update to the transform, its roles at the time of the update are listed in the response.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "service_account": {
+ "description": "If a service account was used for the most recent update to the transform, the account name is listed in the response.",
+ "type": "string"
+ }
+ }
+ },
+ "transform._types.Latest": {
+ "type": "object",
+ "properties": {
+ "sort": {
+ "description": "Specifies the date field that is used to identify the latest documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "unique_key": {
+ "description": "Specifies an array of one or more fields that are used to group the data.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ }
+ },
+ "required": [
+ "sort",
+ "unique_key"
+ ]
+ },
+ "transform._types.Pivot": {
+ "type": "object",
+ "properties": {
+ "aggregations": {
+ "description": "Defines how to aggregate the grouped data. The following aggregations are currently supported: average, bucket\nscript, bucket selector, cardinality, filter, geo bounds, geo centroid, geo line, max, median absolute deviation,\nmin, missing, percentiles, rare terms, scripted metric, stats, sum, terms, top metrics, value count, weighted\naverage.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.AggregationContainer"
+ }
+ },
+ "group_by": {
+ "description": "Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are\ncurrently supported: date histogram, geotile grid, histogram, terms.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/transform._types.PivotGroupByContainer"
+ }
+ }
+ }
+ },
+ "transform._types.PivotGroupByContainer": {
+ "type": "object",
+ "properties": {
+ "date_histogram": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.DateHistogramAggregation"
+ }
+ ]
+ },
+ "geotile_grid": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.GeoTileGridAggregation"
+ }
+ ]
+ },
+ "histogram": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.HistogramAggregation"
+ }
+ ]
+ },
+ "terms": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.aggregations.TermsAggregation"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "transform._types.RetentionPolicyContainer": {
+ "type": "object",
+ "properties": {
+ "time": {
+ "description": "Specifies that the transform uses a time field to set the retention policy.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.RetentionPolicy"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "transform._types.RetentionPolicy": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The date field that is used to calculate the age of the document.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "max_age": {
+ "description": "Specifies the maximum age of a document in the destination index. Documents that are older than the configured\nvalue are removed from the destination index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field",
+ "max_age"
+ ]
+ },
+ "transform._types.Settings": {
+ "description": "The source of the data for the transform.",
+ "type": "object",
+ "properties": {
+ "align_checkpoints": {
+ "description": "Specifies whether the transform checkpoint ranges should be optimized for performance. Such optimization can align\ncheckpoint ranges with the date histogram interval when date histogram is specified as a group source in the\ntransform config. As a result, less document updates in the destination index will be performed thus improving\noverall performance.",
+ "default": true,
+ "type": "boolean"
+ },
+ "dates_as_epoch_millis": {
+ "description": "Defines if dates in the ouput should be written as ISO formatted string or as millis since epoch. epoch_millis was\nthe default for transforms created before version 7.11. For compatible output set this value to `true`.",
+ "default": false,
+ "type": "boolean"
+ },
+ "deduce_mappings": {
+ "description": "Specifies whether the transform should deduce the destination index mappings from the transform configuration.",
+ "default": true,
+ "type": "boolean"
+ },
+ "docs_per_second": {
+ "description": "Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a\nwait time between search requests. The default value is null, which disables throttling.",
+ "type": "number"
+ },
+ "max_page_search_size": {
+ "description": "Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker\nexceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is `10` and the\nmaximum is `65,536`.",
+ "default": 500.0,
+ "type": "number"
+ },
+ "unattended": {
+ "description": "If `true`, the transform runs in unattended mode. In unattended mode, the transform retries indefinitely in case\nof an error which means the transform never fails. Setting the number of retries other than infinite fails in\nvalidation.",
+ "default": false,
+ "x-state": "Generally available",
+ "type": "boolean"
+ }
+ }
+ },
+ "transform._types.Source": {
+ "type": "object",
+ "properties": {
+ "index": {
+ "description": "The source indices for the transform. It can be a single index, an index pattern (for example, `\"my-index-*\"\"`), an\narray of indices (for example, `[\"my-index-000001\", \"my-index-000002\"]`), or an array of index patterns (for\nexample, `[\"my-index-*\", \"my-other-index-*\"]`. For remote indices use the syntax `\"remote_name:index_name\"`. If\nany indices are in remote clusters then the master node and at least one transform node must have the `remote_cluster_client` node role.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Indices"
+ }
+ ]
+ },
+ "query": {
+ "description": "A query clause that retrieves a subset of data from the source index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "runtime_mappings": {
+ "description": "Definitions of search-time runtime fields that can be used by the transform. For search runtime fields all data\nnodes, including remote nodes, must be 7.12 or later.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RuntimeFields"
+ }
+ ]
+ }
+ },
+ "required": [
+ "index"
+ ]
+ },
+ "transform._types.SyncContainer": {
+ "type": "object",
+ "properties": {
+ "time": {
+ "description": "Specifies that the transform uses a time field to synchronize the source and destination indices.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.TimeSync"
+ }
+ ]
+ }
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ },
+ "transform._types.TimeSync": {
+ "type": "object",
+ "properties": {
+ "delay": {
+ "description": "The time delay between the current time and the latest input data time.",
+ "default": "60s",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "field": {
+ "description": "The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field\nthat contains the ingest timestamp. If you use a different field, you might need to set the delay such that it\naccounts for data transmission delays.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ }
+ },
+ "required": [
+ "field"
+ ]
+ },
+ "transform.get_transform_stats.TransformStats": {
+ "type": "object",
+ "properties": {
+ "checkpointing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform.get_transform_stats.Checkpointing"
+ }
+ ]
+ },
+ "health": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform.get_transform_stats.TransformStatsHealth"
+ }
+ ]
+ },
+ "id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "reason": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "stats": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform.get_transform_stats.TransformIndexerStats"
+ }
+ ]
+ }
+ },
+ "required": [
+ "checkpointing",
+ "id",
+ "state",
+ "stats"
+ ]
+ },
+ "transform.get_transform_stats.Checkpointing": {
+ "type": "object",
+ "properties": {
+ "changes_last_detected_at": {
+ "type": "number"
+ },
+ "changes_last_detected_at_string": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "last": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform.get_transform_stats.CheckpointStats"
+ }
+ ]
+ },
+ "next": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform.get_transform_stats.CheckpointStats"
+ }
+ ]
+ },
+ "operations_behind": {
+ "type": "number"
+ },
+ "last_search_time": {
+ "type": "number"
+ },
+ "last_search_time_string": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ }
+ },
+ "required": [
+ "last"
+ ]
+ },
+ "transform.get_transform_stats.CheckpointStats": {
+ "type": "object",
+ "properties": {
+ "checkpoint": {
+ "type": "number"
+ },
+ "checkpoint_progress": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform.get_transform_stats.TransformProgress"
+ }
+ ]
+ },
+ "timestamp": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "timestamp_millis": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "time_upper_bound": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "time_upper_bound_millis": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ }
+ },
+ "required": [
+ "checkpoint"
+ ]
+ },
+ "transform.get_transform_stats.TransformProgress": {
+ "type": "object",
+ "properties": {
+ "docs_indexed": {
+ "type": "number"
+ },
+ "docs_processed": {
+ "type": "number"
+ },
+ "docs_remaining": {
+ "type": "number"
+ },
+ "percent_complete": {
+ "type": "number"
+ },
+ "total_docs": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "docs_indexed",
+ "docs_processed"
+ ]
+ },
+ "transform.get_transform_stats.TransformStatsHealth": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "\n\nSupported values include:\n - `green` (or `GREEN`): All shards are assigned.\n - `yellow` (or `YELLOW`): All primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data could be unavailable until that node is repaired.\n - `red` (or `RED`): One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned.\n - `unknown`\n - `unavailable`\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.HealthStatus"
+ }
+ ]
+ },
+ "issues": {
+ "description": "If a non-healthy status is returned, contains a list of issues of the transform.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/transform.get_transform_stats.TransformHealthIssue"
+ }
+ }
+ },
+ "required": [
+ "status"
+ ]
+ },
+ "transform.get_transform_stats.TransformHealthIssue": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The type of the issue",
+ "type": "string"
+ },
+ "issue": {
+ "description": "A description of the issue",
+ "type": "string"
+ },
+ "details": {
+ "description": "Details about the issue",
+ "type": "string"
+ },
+ "count": {
+ "description": "Number of times this issue has occurred since it started",
+ "type": "number"
+ },
+ "first_occurrence": {
+ "description": "The timestamp this issue occurred for for the first time",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "first_occurence_string": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "issue",
+ "count"
+ ]
+ },
+ "transform.get_transform_stats.TransformIndexerStats": {
+ "type": "object",
+ "properties": {
+ "delete_time_in_ms": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.EpochTimeUnitMillis"
+ }
+ ]
+ },
+ "documents_indexed": {
+ "type": "number"
+ },
+ "documents_deleted": {
+ "type": "number"
+ },
+ "documents_processed": {
+ "type": "number"
+ },
+ "exponential_avg_checkpoint_duration_ms": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitFloatMillis"
+ }
+ ]
+ },
+ "exponential_avg_documents_indexed": {
+ "type": "number"
+ },
+ "exponential_avg_documents_processed": {
+ "type": "number"
+ },
+ "index_failures": {
+ "type": "number"
+ },
+ "index_time_in_ms": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitMillis"
+ }
+ ]
+ },
+ "index_total": {
+ "type": "number"
+ },
+ "pages_processed": {
+ "type": "number"
+ },
+ "processing_time_in_ms": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitMillis"
+ }
+ ]
+ },
+ "processing_total": {
+ "type": "number"
+ },
+ "search_failures": {
+ "type": "number"
+ },
+ "search_time_in_ms": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DurationValueUnitMillis"
+ }
+ ]
+ },
+ "search_total": {
+ "type": "number"
+ },
+ "trigger_count": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "documents_indexed",
+ "documents_processed",
+ "exponential_avg_checkpoint_duration_ms",
+ "exponential_avg_documents_indexed",
+ "exponential_avg_documents_processed",
+ "index_failures",
+ "index_time_in_ms",
+ "index_total",
+ "pages_processed",
+ "processing_time_in_ms",
+ "processing_total",
+ "search_failures",
+ "search_time_in_ms",
+ "search_total",
+ "trigger_count"
+ ]
+ },
+ "transform._types.Destination": {
+ "type": "object",
+ "properties": {
+ "index": {
+ "description": "The destination index for the transform. The mappings of the destination index are deduced based on the source\nfields when possible. If alternate mappings are required, use the create index API prior to starting the\ntransform.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "pipeline": {
+ "description": "The unique identifier for an ingest pipeline.",
+ "type": "string"
+ }
+ }
+ },
+ "_global.update.UpdateWriteResponseBase": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.WriteResponseBase"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "get": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.InlineGet"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ }
+ },
+ "responses": {
+ "async_search.submit-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/async_search._types.AsyncSearchDocumentResponseBase"
+ },
+ "examples": {
+ "AsyncSearchSubmitResponseExample1": {
+ "description": "A successful response when performing search asynchronously.",
+ "value": "{\n \"id\" : \"FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=\",\n \"is_partial\" : true,\n \"is_running\" : true,\n \"start_time_in_millis\" : 1583945890986,\n \"expiration_time_in_millis\" : 1584377890986,\n \"response\" : {\n \"took\" : 1122,\n \"timed_out\" : false,\n \"num_reduce_phases\" : 0,\n \"_shards\" : {\n \"total\" : 562,\n \"successful\" : 3,\n \"skipped\" : 0,\n \"failed\" : 0\n },\n \"hits\" : {\n \"total\" : {\n \"value\" : 157483,\n \"relation\" : \"gte\"\n },\n \"max_score\" : null,\n \"hits\" : [ ]\n }\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "bulk-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "errors": {
+ "description": "If `true`, one or more of the operations in the bulk request did not complete successfully.",
+ "type": "boolean"
+ },
+ "items": {
+ "description": "The result of each operation in the bulk request, in the order they were submitted.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_global.bulk.ResponseItem"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ }
+ },
+ "took": {
+ "description": "The length of time, in milliseconds, it took to process the bulk request.",
+ "type": "number"
+ },
+ "ingest_took": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "errors",
+ "items",
+ "took"
+ ]
+ },
+ "examples": {
+ "BulkResponseExample1": {
+ "summary": "Multiple successful operations",
+ "value": "{\n \"took\": 30,\n \"errors\": false,\n \"items\": [\n {\n \"index\": {\n \"_index\": \"test\",\n \"_id\": \"1\",\n \"_version\": 1,\n \"result\": \"created\",\n \"_shards\": {\n \"total\": 2,\n \"successful\": 1,\n \"failed\": 0\n },\n \"status\": 201,\n \"_seq_no\" : 0,\n \"_primary_term\": 1\n }\n },\n {\n \"delete\": {\n \"_index\": \"test\",\n \"_id\": \"2\",\n \"_version\": 1,\n \"result\": \"not_found\",\n \"_shards\": {\n \"total\": 2,\n \"successful\": 1,\n \"failed\": 0\n },\n \"status\": 404,\n \"_seq_no\" : 1,\n \"_primary_term\" : 2\n }\n },\n {\n \"create\": {\n \"_index\": \"test\",\n \"_id\": \"3\",\n \"_version\": 1,\n \"result\": \"created\",\n \"_shards\": {\n \"total\": 2,\n \"successful\": 1,\n \"failed\": 0\n },\n \"status\": 201,\n \"_seq_no\" : 2,\n \"_primary_term\" : 3\n }\n },\n {\n \"update\": {\n \"_index\": \"test\",\n \"_id\": \"1\",\n \"_version\": 2,\n \"result\": \"updated\",\n \"_shards\": {\n \"total\": 2,\n \"successful\": 1,\n \"failed\": 0\n },\n \"status\": 200,\n \"_seq_no\" : 3,\n \"_primary_term\" : 4\n }\n }\n ]\n}"
+ },
+ "BulkResponseExample2": {
+ "summary": "Failed actions",
+ "description": "If you run `POST /_bulk` with operations that update non-existent documents, the operations cannot complete successfully. The API returns a response with an `errors` property value `true`. The response also includes an error object for any failed operations. The error object contains additional information about the failure, such as the error type and reason.\n",
+ "value": "{\n \"took\": 486,\n \"errors\": true,\n \"items\": [\n {\n \"update\": {\n \"_index\": \"index1\",\n \"_id\": \"5\",\n \"status\": 404,\n \"error\": {\n \"type\": \"document_missing_exception\",\n \"reason\": \"[5]: document missing\",\n \"index_uuid\": \"aAsFqTI0Tc2W0LCWgPNrOA\",\n \"shard\": \"0\",\n \"index\": \"index1\"\n }\n }\n },\n {\n \"update\": {\n \"_index\": \"index1\",\n \"_id\": \"6\",\n \"status\": 404,\n \"error\": {\n \"type\": \"document_missing_exception\",\n \"reason\": \"[6]: document missing\",\n \"index_uuid\": \"aAsFqTI0Tc2W0LCWgPNrOA\",\n \"shard\": \"0\",\n \"index\": \"index1\"\n }\n }\n },\n {\n \"create\": {\n \"_index\": \"index1\",\n \"_id\": \"7\",\n \"_version\": 1,\n \"result\": \"created\",\n \"_shards\": {\n \"total\": 2,\n \"successful\": 1,\n \"failed\": 0\n },\n \"_seq_no\": 0,\n \"_primary_term\": 1,\n \"status\": 201\n }\n }\n ]\n}"
+ },
+ "BulkResponseExample3": {
+ "summary": "Filter for failed operations",
+ "description": "An example response from `POST /_bulk?filter_path=items.*.error`, which returns only information about failed operations.\n",
+ "value": "{\n \"items\": [\n {\n \"update\": {\n \"error\": {\n \"type\": \"document_missing_exception\",\n \"reason\": \"[5]: document missing\",\n \"index_uuid\": \"aAsFqTI0Tc2W0LCWgPNrOA\",\n \"shard\": \"0\",\n \"index\": \"index1\"\n }\n }\n },\n {\n \"update\": {\n \"error\": {\n \"type\": \"document_missing_exception\",\n \"reason\": \"[6]: document missing\",\n \"index_uuid\": \"aAsFqTI0Tc2W0LCWgPNrOA\",\n \"shard\": \"0\",\n \"index\": \"index1\"\n }\n }\n }\n ]\n}"
+ }
+ }
+ }
+ }
+ },
+ "cat.aliases-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/cat.aliases.AliasesRecord"
+ }
+ },
+ "examples": {
+ "CatAliasesResponseExample1": {
+ "description": "A successful response from `GET _cat/aliases?format=json&v=true`. This response shows that `alias2` has configured a filter and `alias3` and `alias4` have routing configurations.\n",
+ "value": "[\n {\n \"alias\": \"alias1\",\n \"index\": \"test1\",\n \"filter\": \"-\",\n \"routing.index\": \"-\",\n \"routing.search\": \"-\",\n \"is_write_index\": \"true\"\n },\n {\n \"alias\": \"alias1\",\n \"index\": \"test1\",\n \"filter\": \"*\",\n \"routing.index\": \"-\",\n \"routing.search\": \"-\",\n \"is_write_index\": \"true\"\n },\n {\n \"alias\": \"alias3\",\n \"index\": \"test1\",\n \"filter\": \"-\",\n \"routing.index\": \"1\",\n \"routing.search\": \"1\",\n \"is_write_index\": \"true\"\n },\n {\n \"alias\": \"alias4\",\n \"index\": \"test1\",\n \"filter\": \"-\",\n \"routing.index\": \"2\",\n \"routing.search\": \"1,2\",\n \"is_write_index\": \"true\"\n }\n]"
+ }
+ }
+ }
+ }
+ },
+ "cat.component_templates-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/cat.component_templates.ComponentTemplate"
+ }
+ },
+ "examples": {
+ "CatComponentTemplatesResponseExample1": {
+ "description": "A successful response from `GET _cat/component_templates/my-template-*?v=true&s=name&format=json`.\n",
+ "value": "[\n {\n \"name\": \"my-template-1\",\n \"version\": \"null\",\n \"alias_count\": \"0\",\n \"mapping_count\": \"0\",\n \"settings_count\": \"1\",\n \"metadata_count\": \"0\",\n \"included_in\": \"[my-index-template]\"\n },\n {\n \"name\": \"my-template-2\",\n \"version\": null,\n \"alias_count\": \"0\",\n \"mapping_count\": \"3\",\n \"settings_count\": \"0\",\n \"metadata_count\": \"0\",\n \"included_in\": \"[my-index-template]\"\n }\n]"
+ }
+ }
+ }
+ }
+ },
+ "cat.count-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/cat.count.CountRecord"
+ }
+ },
+ "examples": {
+ "CatCountResponseExample1": {
+ "summary": "Single data stream or index count",
+ "description": "A successful response from `GET /_cat/count/my-index-000001?v=true&format=json`. It retrieves the document count for the `my-index-000001` data stream or index.\n",
+ "value": "[\n {\n \"epoch\": \"1475868259\",\n \"timestamp\": \"15:24:20\",\n \"count\": \"120\"\n }\n]"
+ },
+ "CatCountResponseExample2": {
+ "summary": "All data streams and indices count",
+ "description": "A successful response from `GET /_cat/count?v=true&format=json`. It retrieves the document count for all data streams and indices in the cluster.\n",
+ "value": "[\n {\n \"epoch\": \"1475868259\",\n \"timestamp\": \"15:24:20\",\n \"count\": \"121\"\n }\n]"
+ }
+ }
+ }
+ }
+ },
+ "cat.indices-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/cat.indices.IndicesRecord"
+ }
+ },
+ "examples": {
+ "CatIndicesResponseExample1": {
+ "description": "A successful response from `GET /_cat/indices/my-index-*?v=true&s=index&format=json`.\n",
+ "value": "[\n {\n \"health\": \"yellow\",\n \"status\": \"open\",\n \"index\": \"my-index-000001\",\n \"uuid\": \"u8FNjxh8Rfy_awN11oDKYQ\",\n \"pri\": \"1\",\n \"rep\": \"1\",\n \"docs.count\": \"1200\",\n \"docs.deleted\": \"0\",\n \"store.size\": \"88.1kb\",\n \"pri.store.size\": \"88.1kb\",\n \"dataset.size\": \"88.1kb\"\n },\n {\n \"health\": \"green\",\n \"status\": \"open\",\n \"index\": \"my-index-000002\",\n \"uuid\": \"nYFWZEO7TUiOjLQXBaYJpA \",\n \"pri\": \"1\",\n \"rep\": \"0\",\n \"docs.count\": \"0\",\n \"docs.deleted\": \"0\",\n \"store.size\": \"260b\",\n \"pri.store.size\": \"260b\",\n \"dataset.size\": \"260b\"\n }\n]"
+ }
+ }
+ }
+ }
+ },
+ "cat.ml_data_frame_analytics-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/cat.ml_data_frame_analytics.DataFrameAnalyticsRecord"
+ }
+ },
+ "examples": {
+ "CatDataframeanalyticsResponseExample1": {
+ "description": "A successful response from `GET _cat/ml/data_frame/analytics?v=true&format=json`.",
+ "value": "[\n {\n \"id\": \"classifier_job_1\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:09.594Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_2\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:14.479Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_3\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:16.928Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_4\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:19.127Z\",\n \"state\": \"stopped\"\n },\n {\n \"id\": \"classifier_job_5\",\n \"type\": \"classification\",\n \"create_time\": \"2020-02-12T11:49:21.349Z\",\n \"state\": \"stopped\"\n }\n]"
+ }
+ }
+ }
+ }
+ },
+ "cat.ml_datafeeds-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/cat.ml_datafeeds.DatafeedsRecord"
+ }
+ },
+ "examples": {
+ "CatDatafeedsResponseExample1": {
+ "description": "A successful response from `GET _cat/ml/datafeeds?v=true&format=json`.",
+ "value": "[\n {\n \"id\": \"datafeed-high_sum_total_sales\",\n \"state\": \"stopped\",\n \"buckets.count\": \"743\",\n \"search.count\": \"7\"\n },\n {\n \"id\": \"datafeed-low_request_rate\",\n \"state\": \"stopped\",\n \"buckets.count\": \"1457\",\n \"search.count\": \"3\"\n },\n {\n \"id\": \"datafeed-response_code_rates\",\n \"state\": \"stopped\",\n \"buckets.count\": \"1460\",\n \"search.count\": \"18\"\n },\n {\n \"id\": \"datafeed-url_scanning\",\n \"state\": \"stopped\",\n \"buckets.count\": \"1460\",\n \"search.count\": \"18\"\n }\n]"
+ }
+ }
+ }
+ }
+ },
+ "cat.ml_jobs-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/cat.ml_jobs.JobsRecord"
+ }
+ },
+ "examples": {
+ "CatJobsResponseExample1": {
+ "description": "A successful response from `GET _cat/ml/anomaly_detectors?h=id,s,dpr,mb&v=true&format=json`.",
+ "value": "[\n {\n \"id\": \"high_sum_total_sales\",\n \"s\": \"closed\",\n \"dpr\": \"14022\",\n \"mb\": \"1.5mb\"\n },\n {\n \"id\": \"low_request_rate\",\n \"s\": \"closed\",\n \"dpr\": \"1216\",\n \"mb\": \"40.5kb\"\n },\n {\n \"id\": \"response_code_rates\",\n \"s\": \"closed\",\n \"dpr\": \"28146\",\n \"mb\": \"132.7kb\"\n },\n {\n \"id\": \"url_scanning\",\n \"s\": \"closed\",\n \"dpr\": \"28146\",\n \"mb\": \"501.6kb\"\n }\n]"
+ }
+ }
+ }
+ }
+ },
+ "cat.ml_trained_models-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/cat.ml_trained_models.TrainedModelsRecord"
+ }
+ },
+ "examples": {
+ "CatTrainedModelsResponseExample1": {
+ "description": "A successful response from `GET _cat/ml/trained_models?v=true&format=json`.",
+ "value": "[\n {\n \"id\": \"ddddd-1580216177138\",\n \"heap_size\": \"0b\",\n \"operations\": \"196\",\n \"create_time\": \"2025-03-25T00:01:38.662Z\",\n \"type\": \"pytorch\",\n \"ingest.pipelines\": \"0\",\n \"data_frame.id\": \"__none__\"\n },\n {\n \"id\": \"lang_ident_model_1\",\n \"heap_size\": \"1mb\",\n \"operations\": \"39629\",\n \"create_time\": \"2019-12-05T12:28:34.594Z\",\n \"type\": \"lang_ident\",\n \"ingest.pipelines\": \"0\",\n \"data_frame.id\": \"__none__\"\n }\n]"
+ }
+ }
+ }
+ }
+ },
+ "cat.transforms-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/cat.transforms.TransformsRecord"
+ }
+ },
+ "examples": {
+ "CatTransformsResponseExample1": {
+ "description": "A successful response from `GET /_cat/transforms?v=true&format=json`.",
+ "value": "[\n {\n \"id\" : \"ecommerce_transform\",\n \"state\" : \"started\",\n \"checkpoint\" : \"1\",\n \"documents_processed\" : \"705\",\n \"checkpoint_progress\" : \"100.00\",\n \"changes_last_detection_time\" : null\n }\n]"
+ }
+ }
+ }
+ }
+ },
+ "clear_scroll-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "succeeded": {
+ "description": "If `true`, the request succeeded.\nThis does not indicate whether any scrolling search requests were cleared.",
+ "type": "boolean"
+ },
+ "num_freed": {
+ "description": "The number of scrolling search requests cleared.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "succeeded",
+ "num_freed"
+ ]
+ }
+ }
+ }
+ },
+ "cluster.get_component_template-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "component_templates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/cluster._types.ComponentTemplate"
+ }
+ }
+ },
+ "required": [
+ "component_templates"
+ ]
+ },
+ "examples": {
+ "GetComponentTemplateResponseExample1": {
+ "description": "A successful response for retrieving information about a component template.",
+ "value": "{\n \"component_templates\" : [\n {\n \"name\" : \"my-component-template\",\n \"component_template\" : {\n \"version\" : 1,\n \"_meta\" : {\n \"description\" : \"my custom component template\"\n },\n \"template\" : {\n \"settings\" : {\n \"index\" : {\n \"number_of_shards\" : \"1\"\n }\n },\n \"mappings\" : {\n \"properties\" : {\n \"@timestamp\" : {\n \"type\" : \"date\"\n },\n \"message\" : {\n \"type\" : \"text\"\n }\n }\n }\n },\n \"created_date\" : \"2024-01-01T12:00:00.000Z\",\n \"created_date_millis\" : 1704110400000,\n \"modified_date\" : \"2025-01-01T12:00:00.000Z\",\n \"modified_date_millis\" : 1735732800000\n }\n }\n ]\n}"
+ }
+ }
+ }
+ }
+ },
+ "cluster.put_component_template-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
+ }
+ }
+ }
+ },
+ "connector.put-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "result": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Result"
+ }
+ ]
+ },
+ "id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ }
+ },
+ "required": [
+ "result",
+ "id"
+ ]
+ },
+ "examples": {
+ "ConnectorPutResponseExample1": {
+ "value": "{\n \"result\": \"created\",\n \"id\": \"my-connector\"\n}"
+ }
+ }
+ }
+ }
+ },
+ "count-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number"
+ },
+ "_shards": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ShardStatistics"
+ }
+ ]
+ }
+ },
+ "required": [
+ "count",
+ "_shards"
+ ]
+ },
+ "examples": {
+ "CountResponseExample1": {
+ "description": "A successful response from `GET /my-index-000001/_count?q=user:kimchy`.",
+ "value": "{\n \"count\": 1,\n \"_shards\": {\n \"total\": 1,\n \"successful\": 1,\n \"skipped\": 0,\n \"failed\": 0\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "create-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.WriteResponseBase"
+ },
+ "examples": {
+ "CreateResponseExample1": {
+ "description": "A successful response from `PUT my-index-000001/_create/1` which indexes a document.",
+ "value": "{\n \"_index\": \"my-index-000001\",\n \"_id\": \"1\",\n \"_version\": 1,\n \"result\": \"created\",\n \"_shards\": {\n \"total\": 1,\n \"successful\": 1,\n \"failed\": 0\n },\n \"_seq_no\": 0,\n \"_primary_term\": 1\n}"
+ }
+ }
+ }
+ }
+ },
+ "enrich.get_policy-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "policies": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/enrich._types.Summary"
+ }
+ }
+ },
+ "required": [
+ "policies"
+ ]
+ }
+ }
+ }
+ },
+ "eql.search-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/eql._types.EqlSearchResponseBase"
+ },
+ "examples": {
+ "EqlSearchResponseExample2": {
+ "summary": "A successful response for performing search with an EQL query.",
+ "description": "",
+ "value": "{\n \"is_partial\": false,\n \"is_running\": false,\n \"took\": 6,\n \"timed_out\": false,\n \"hits\": {\n \"total\": {\n \"value\": 1,\n \"relation\": \"eq\"\n },\n \"sequences\": [\n {\n \"join_keys\": [\n 2012\n ],\n \"events\": [\n {\n \"_index\": \".ds-my-data-stream-2099.12.07-000001\",\n \"_id\": \"AtOJ4UjUBAAx3XR5kcCM\",\n \"_source\": {\n \"@timestamp\": \"2099-12-06T11:04:07.000Z\",\n \"event\": {\n \"category\": \"file\",\n \"id\": \"dGCHwoeS\",\n \"sequence\": 2\n },\n \"file\": {\n \"accessed\": \"2099-12-07T11:07:08.000Z\",\n \"name\": \"cmd.exe\",\n \"path\": \"C:\\\\Windows\\\\System32\\\\cmd.exe\",\n \"type\": \"file\",\n \"size\": 16384\n },\n \"process\": {\n \"pid\": 2012,\n \"name\": \"cmd.exe\",\n \"executable\": \"C:\\\\Windows\\\\System32\\\\cmd.exe\"\n }\n }\n },\n {\n \"_index\": \".ds-my-data-stream-2099.12.07-000001\",\n \"_id\": \"OQmfCaduce8zoHT93o4H\",\n \"_source\": {\n \"@timestamp\": \"2099-12-07T11:07:09.000Z\",\n \"event\": {\n \"category\": \"process\",\n \"id\": \"aR3NWVOs\",\n \"sequence\": 4\n },\n \"process\": {\n \"pid\": 2012,\n \"name\": \"regsvr32.exe\",\n \"command_line\": \"regsvr32.exe /s /u /i:https://...RegSvr32.sct scrobj.dll\",\n \"executable\": \"C:\\\\Windows\\\\System32\\\\regsvr32.exe\"\n }\n }\n }\n ]\n }\n ]\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "explain-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "_index": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "matched": {
+ "type": "boolean"
+ },
+ "explanation": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.explain.ExplanationDetail"
+ }
+ ]
+ },
+ "get": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.InlineGet"
+ }
+ ]
+ }
+ },
+ "required": [
+ "_index",
+ "_id",
+ "matched"
+ ]
+ },
+ "examples": {
+ "ExplainResponseExample1": {
+ "description": "A successful response from `GET /my-index-000001/_explain/0`.",
+ "value": "{\n \"_index\":\"my-index-000001\",\n \"_id\":\"0\",\n \"matched\":true,\n \"explanation\":{\n \"value\":1.6943598,\n \"description\":\"weight(message:elasticsearch in 0) [PerFieldSimilarity], result of:\",\n \"details\":[\n {\n \"value\":1.6943598,\n \"description\":\"score(freq=1.0), computed as boost * idf * tf from:\",\n \"details\":[\n {\n \"value\":2.2,\n \"description\":\"boost\",\n \"details\":[]\n },\n {\n \"value\":1.3862944,\n \"description\":\"idf, computed as log(1 + (N - n + 0.5) / (n + 0.5)) from:\",\n \"details\":[\n {\n \"value\":1,\n \"description\":\"n, number of documents containing term\",\n \"details\":[]\n },\n {\n \"value\":5,\n \"description\":\"N, total number of documents with field\",\n \"details\":[]\n }\n ]\n },\n {\n \"value\":0.5555556,\n \"description\":\"tf, computed as freq / (freq + k1 * (1 - b + b * dl / avgdl)) from:\",\n \"details\":[\n {\n \"value\":1.0,\n \"description\":\"freq, occurrences of term within document\",\n \"details\":[]\n },\n {\n \"value\":1.2,\n \"description\":\"k1, term saturation parameter\",\n \"details\":[]\n },\n {\n \"value\":0.75,\n \"description\":\"b, length normalization parameter\",\n \"details\":[]\n },\n {\n \"value\":3.0,\n \"description\":\"dl, length of field\",\n \"details\":[]\n },\n {\n \"value\":5.4,\n \"description\":\"avgdl, average length of field\",\n \"details\":[]\n }\n ]\n }\n ]\n }\n ]\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "field_caps-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "indices": {
+ "description": "The list of indices where this field has the same type family, or null if all indices have the same type family for the field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Indices"
+ }
+ ]
+ },
+ "fields": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_global.field_caps.FieldCapability"
+ }
+ }
+ }
+ },
+ "required": [
+ "indices",
+ "fields"
+ ]
+ },
+ "examples": {
+ "FieldCapabilitiesResponseExample1": {
+ "summary": "Get two fields",
+ "description": "A successful response from `GET _field_caps?fields=rating,title`. The field `rating` is defined as a long in `index1` and `index2` and as a `keyword` in `index3` and `index4`. The field `rating` is not aggregatable in `index1`. The field `rating` is not searchable in `index4`. The field `title` is defined as text in all indices.\n",
+ "value": "{\n \"indices\": [ \"index1\", \"index2\", \"index3\", \"index4\", \"index5\" ],\n \"fields\": {\n \"rating\": { \n \"long\": {\n \"metadata_field\": false,\n \"searchable\": true,\n \"aggregatable\": false,\n \"indices\": [ \"index1\", \"index2\" ],\n \"non_aggregatable_indices\": [ \"index1\" ] \n },\n \"keyword\": {\n \"metadata_field\": false,\n \"searchable\": false,\n \"aggregatable\": true,\n \"indices\": [ \"index3\", \"index4\" ],\n \"non_searchable_indices\": [ \"index4\" ] \n }\n },\n \"title\": { \n \"text\": {\n \"metadata_field\": false,\n \"searchable\": true,\n \"aggregatable\": false\n }\n }\n }\n}"
+ },
+ "FieldCapabilitiesResponseExample2": {
+ "summary": "Get unmapped fields",
+ "description": "A successful response from `GET _field_caps?fields=rating,title&include_unmapped`. The response contains an entry for each field that is present in some indices but not all. For example, the `rating` and `title` fields are unmapped in `index5`.\n",
+ "value": "{\n \"indices\": [ \"index1\", \"index2\", \"index3\", \"index4\", \"index5\" ],\n \"fields\": {\n \"rating\": { \n \"long\": {\n \"metadata_field\": false,\n \"searchable\": true,\n \"aggregatable\": false,\n \"indices\": [ \"index1\", \"index2\" ],\n \"non_aggregatable_indices\": [ \"index1\" ] \n },\n \"keyword\": {\n \"metadata_field\": false,\n \"searchable\": false,\n \"aggregatable\": true,\n \"indices\": [ \"index3\", \"index4\" ],\n \"non_searchable_indices\": [ \"index4\" ] \n }\n },\n \"title\": { \n \"text\": {\n \"metadata_field\": false,\n \"searchable\": true,\n \"aggregatable\": false\n }\n }\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "graph.explore-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "connections": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/graph._types.Connection"
+ }
+ },
+ "failures": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.ShardFailure"
+ }
+ },
+ "timed_out": {
+ "type": "boolean"
+ },
+ "took": {
+ "type": "number"
+ },
+ "vertices": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/graph._types.Vertex"
+ }
+ }
+ },
+ "required": [
+ "connections",
+ "failures",
+ "timed_out",
+ "took",
+ "vertices"
+ ]
+ }
+ }
+ }
+ },
+ "index-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.WriteResponseBase"
+ },
+ "examples": {
+ "IndexResponseExample1": {
+ "summary": "Automate document IDs",
+ "description": "A successful response from `POST my-index-000001/_doc/`, which contains an automated document ID.",
+ "value": "{\n \"_shards\": {\n \"total\": 2,\n \"failed\": 0,\n \"successful\": 2\n },\n \"_index\": \"my-index-000001\",\n \"_id\": \"W0tpsmIBdwcYyG50zbta\",\n \"_version\": 1,\n \"_seq_no\": 0,\n \"_primary_term\": 1,\n \"result\": \"created\"\n}"
+ },
+ "IndexResponseExample2": {
+ "summary": "Define document IDs",
+ "description": "A successful response from `PUT my-index-000001/_doc/1`.",
+ "value": "{\n \"_shards\": {\n \"total\": 2,\n \"failed\": 0,\n \"successful\": 2\n },\n \"_index\": \"my-index-000001\",\n \"_id\": \"1\",\n \"_version\": 1,\n \"_seq_no\": 0,\n \"_primary_term\": 1,\n \"result\": \"created\"\n}"
+ }
+ }
+ }
+ }
+ },
+ "indices.analyze-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "detail": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices.analyze.AnalyzeDetail"
+ }
+ ]
+ },
+ "tokens": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/indices.analyze.AnalyzeToken"
+ }
+ }
+ }
+ },
+ "examples": {
+ "indicesAnalyzeResponseExample7": {
+ "description": "A successful response for an analysis with `explain` set to `true`.",
+ "value": "{\n \"detail\": {\n \"custom_analyzer\": true,\n \"charfilters\": [],\n \"tokenizer\": {\n \"name\": \"standard\",\n \"tokens\": [\n {\n \"token\": \"detailed\",\n \"start_offset\": 0,\n \"end_offset\": 8,\n \"type\": \"\",\n \"position\": 0\n },\n {\n \"token\": \"output\",\n \"start_offset\": 9,\n \"end_offset\": 15,\n \"type\": \"\",\n \"position\": 1\n }\n ]\n },\n \"tokenfilters\": [\n {\n \"name\": \"snowball\",\n \"tokens\": [\n {\n \"token\": \"detail\",\n \"start_offset\": 0,\n \"end_offset\": 8,\n \"type\": \"\",\n \"position\": 0,\n \"keyword\": false\n },\n {\n \"token\": \"output\",\n \"start_offset\": 9,\n \"end_offset\": 15,\n \"type\": \"\",\n \"position\": 1,\n \"keyword\": false\n }\n ]\n }\n ]\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "indices.delete_alias-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/indices.delete_alias.IndicesAliasesResponseBody"
+ }
+ }
+ }
+ },
+ "indices.exists_alias-200": {
+ "description": "",
+ "content": {
+ "application/json": {}
+ }
+ },
+ "indices.get_alias-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/indices.get_alias._types.IndexAliases"
+ }
+ }
+ }
+ }
+ },
+ "indices.get_data_stream-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data_streams": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/indices._types.DataStream"
+ }
+ }
+ },
+ "required": [
+ "data_streams"
+ ]
+ },
+ "examples": {
+ "indicesGetDataStreamResponseExample1": {
+ "description": "A successful response for retrieving information about a data stream.",
+ "value": "{\n \"data_streams\": [\n {\n \"name\": \"my-data-stream\",\n \"timestamp_field\": {\n \"name\": \"@timestamp\"\n },\n \"indices\": [\n {\n \"index_name\": \".ds-my-data-stream-2099.03.07-000001\",\n \"index_uuid\": \"xCEhwsp8Tey0-FLNFYVwSg\",\n \"prefer_ilm\": true,\n \"ilm_policy\": \"my-lifecycle-policy\",\n \"managed_by\": \"Index Lifecycle Management\"\n },\n {\n \"index_name\": \".ds-my-data-stream-2099.03.08-000002\",\n \"index_uuid\": \"PA_JquKGSiKcAKBA8DJ5gw\",\n \"prefer_ilm\": true,\n \"ilm_policy\": \"my-lifecycle-policy\",\n \"managed_by\": \"Index Lifecycle Management\"\n }\n ],\n \"generation\": 2,\n \"_meta\": {\n \"my-meta-field\": \"foo\"\n },\n \"status\": \"GREEN\",\n \"next_generation_managed_by\": \"Index Lifecycle Management\",\n \"prefer_ilm\": true,\n \"template\": \"my-index-template\",\n \"ilm_policy\": \"my-lifecycle-policy\",\n \"hidden\": false,\n \"system\": false,\n \"allow_custom_routing\": false,\n \"replicated\": false,\n \"rollover_on_write\": false\n },\n {\n \"name\": \"my-data-stream-two\",\n \"timestamp_field\": {\n \"name\": \"@timestamp\"\n },\n \"indices\": [\n {\n \"index_name\": \".ds-my-data-stream-two-2099.03.08-000001\",\n \"index_uuid\": \"3liBu2SYS5axasRt6fUIpA\",\n \"prefer_ilm\": true,\n \"ilm_policy\": \"my-lifecycle-policy\",\n \"managed_by\": \"Index Lifecycle Management\"\n }\n ],\n \"generation\": 1,\n \"_meta\": {\n \"my-meta-field\": \"foo\"\n },\n \"status\": \"YELLOW\",\n \"next_generation_managed_by\": \"Index Lifecycle Management\",\n \"prefer_ilm\": true,\n \"template\": \"my-index-template\",\n \"ilm_policy\": \"my-lifecycle-policy\",\n \"hidden\": false,\n \"system\": false,\n \"allow_custom_routing\": false,\n \"replicated\": false,\n \"rollover_on_write\": false\n }\n ]\n}"
+ }
+ }
+ }
+ }
+ },
+ "indices.get_index_template-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "index_templates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/indices.get_index_template.IndexTemplateItem"
+ }
+ }
+ },
+ "required": [
+ "index_templates"
+ ]
+ },
+ "examples": {
+ "GetIndexTemplateResponseExample1": {
+ "description": "A successful response for retrieving information about an index template.",
+ "value": "{\n \"index_templates\" : [\n {\n \"name\" : \"my-index-template\",\n \"index_template\" : {\n \"index_patterns\" : [ \"logs-*\" ],\n \"template\" : {\n \"settings\" : {\n \"index\" : {\n \"number_of_shards\" : \"1\",\n \"number_of_replicas\" : \"1\"\n }\n },\n \"mappings\" : {\n \"properties\" : {\n \"@timestamp\" : {\n \"type\" : \"date\"\n },\n \"message\" : {\n \"type\" : \"text\"\n }\n }\n }\n },\n \"composed_of\" : [ \"my-component-template\" ],\n \"priority\" : 200,\n \"version\" : 1,\n \"_meta\" : {\n \"description\" : \"my custom index template\"\n },\n \"created_date\" : \"2024-01-01T12:00:00.000Z\",\n \"created_date_millis\" : 1704110400000,\n \"modified_date\" : \"2025-01-01T12:00:00.000Z\",\n \"modified_date_millis\" : 1735732800000\n }\n }\n ]\n}"
+ }
+ }
+ }
+ }
+ },
+ "indices.get_mapping-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/indices.get_mapping.IndexMappingRecord"
+ }
+ }
+ }
+ }
+ },
+ "indices.get_settings-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/indices._types.IndexState"
+ }
+ }
+ }
+ }
+ },
+ "indices.put_alias-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
+ }
+ }
+ }
+ },
+ "indices.put_index_template-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
+ }
+ }
+ }
+ },
+ "indices.put_mapping-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.IndicesResponseBase"
+ }
+ }
+ }
+ },
+ "indices.put_settings-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
+ }
+ }
+ }
+ },
+ "indices.refresh-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.ShardsOperationResponseBase"
+ }
+ }
+ }
+ },
+ "indices.rollover-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "acknowledged": {
+ "type": "boolean"
+ },
+ "conditions": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "boolean"
+ }
+ },
+ "dry_run": {
+ "type": "boolean"
+ },
+ "new_index": {
+ "type": "string"
+ },
+ "old_index": {
+ "type": "string"
+ },
+ "rolled_over": {
+ "type": "boolean"
+ },
+ "shards_acknowledged": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "acknowledged",
+ "conditions",
+ "dry_run",
+ "new_index",
+ "old_index",
+ "rolled_over",
+ "shards_acknowledged"
+ ]
+ },
+ "examples": {
+ "indicesRolloverResponseExample1": {
+ "description": "An abbreviated response from `GET /_segments`.\n",
+ "value": "{\n \"_shards\": {},\n \"indices\": {\n \"test\": {\n \"shards\": {\n \"0\": [\n {\n \"routing\": {\n \"state\": \"STARTED\",\n \"primary\": true,\n \"node\": \"zDC_RorJQCao9xf9pg3Fvw\"\n },\n \"num_committed_segments\": 0,\n \"num_search_segments\": 1,\n \"segments\": {\n \"_0\": {\n \"generation\": 0,\n \"num_docs\": 1,\n \"deleted_docs\": 0,\n \"size_in_bytes\": 3800,\n \"committed\": false,\n \"search\": true,\n \"version\": \"7.0.0\",\n \"compound\": true,\n \"attributes\": {}\n }\n }\n }\n ]\n }\n }\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "indices.simulate_template-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "overlapping": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/indices.simulate_template.Overlapping"
+ }
+ },
+ "template": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices.simulate_template.Template"
+ }
+ ]
+ }
+ },
+ "required": [
+ "template"
+ ]
+ },
+ "examples": {
+ "indicesSimulateTemplateResponseExample2": {
+ "description": "A successful response from `POST /_index_template/_simulate` with a template configuration in the request body. The response shows any overlapping templates with a lower priority.\n",
+ "value": "{\n \"template\" : {\n \"settings\" : {\n \"index\" : {\n \"number_of_replicas\" : \"1\",\n \"routing\" : {\n \"allocation\" : {\n \"include\" : {\n \"_tier_preference\" : \"data_content\"\n }\n }\n }\n }\n },\n \"mappings\" : {\n \"properties\" : {\n \"@timestamp\" : {\n \"type\" : \"date\"\n }\n }\n },\n \"aliases\" : { }\n },\n \"overlapping\" : [\n {\n \"name\" : \"final-template\",\n \"index_patterns\" : [\n \"my-index-*\"\n ]\n }\n ]\n}"
+ }
+ }
+ }
+ }
+ },
+ "indices.validate_query-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "explanations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/indices.validate_query.IndicesValidationExplanation"
+ }
+ },
+ "_shards": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ShardStatistics"
+ }
+ ]
+ },
+ "valid": {
+ "type": "boolean"
+ },
+ "error": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "valid"
+ ]
+ }
+ }
+ }
+ },
+ "inference.delete-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/inference._types.DeleteInferenceEndpointResult"
+ }
+ }
+ }
+ },
+ "inference.get-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "endpoints": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpointInfo"
+ }
+ }
+ },
+ "required": [
+ "endpoints"
+ ]
+ }
+ }
+ }
+ },
+ "inference.inference-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/inference._types.InferenceResult"
+ }
+ }
+ }
+ },
+ "inference.put-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpointInfo"
+ }
+ }
+ }
+ },
+ "ingest.get_pipeline-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/ingest._types.Pipeline"
+ }
+ },
+ "examples": {
+ "GetPipelineResponseExample1": {
+ "description": "A successful response for retrieving information about an ingest pipeline.",
+ "value": "{\n \"my-pipeline-id\" : {\n \"description\" : \"describe pipeline\",\n \"version\" : 123,\n \"processors\" : [\n {\n \"set\" : {\n \"field\" : \"foo\",\n \"value\" : \"bar\"\n }\n }\n ],\n \"created_date\" : \"2024-01-01T12:00:00.000Z\",\n \"created_date_millis\" : 1704110400000,\n \"modified_date\" : \"2025-01-01T12:00:00.000Z\",\n \"modified_date_millis\" : 1735732800000\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "ingest.simulate-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "docs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ingest._types.SimulateDocumentResult"
+ }
+ }
+ },
+ "required": [
+ "docs"
+ ]
+ },
+ "examples": {
+ "SimulatePipelineResponseExample1": {
+ "description": "A successful response for running an ingest pipeline against a set of provided documents.",
+ "value": "{\n \"docs\": [\n {\n \"doc\": {\n \"_id\": \"id\",\n \"_index\": \"index\",\n \"_version\": \"-3\",\n \"_source\": {\n \"field2\": \"_value\",\n \"foo\": \"bar\"\n },\n \"_ingest\": {\n \"timestamp\": \"2017-05-04T22:30:03.187Z\"\n }\n }\n },\n {\n \"doc\": {\n \"_id\": \"id\",\n \"_index\": \"index\",\n \"_version\": \"-3\",\n \"_source\": {\n \"field2\": \"_value\",\n \"foo\": \"rab\"\n },\n \"_ingest\": {\n \"timestamp\": \"2017-05-04T22:30:03.188Z\"\n }\n }\n }\n ]\n}"
+ }
+ }
+ }
+ }
+ },
+ "logstash.get_pipeline-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/logstash._types.Pipeline"
+ }
+ },
+ "examples": {
+ "LogstashGetPipelineResponseExample1": {
+ "description": "A successful response from `GET _logstash/pipeline/my_pipeline`.\n",
+ "value": "{\n \"my_pipeline\": {\n \"description\": \"Sample pipeline for illustration purposes\",\n \"last_modified\": \"2021-01-02T02:50:51.250Z\",\n \"pipeline_metadata\": {\n \"type\": \"logstash_pipeline\",\n \"version\": \"1\"\n },\n \"username\": \"elastic\",\n \"pipeline\": \"input {}\\\\n filter { grok {} }\\\\n output {}\",\n \"pipeline_settings\": {\n \"pipeline.workers\": 1,\n \"pipeline.batch.size\": 125,\n \"pipeline.batch.delay\": 50,\n \"queue.type\": \"memory\",\n \"queue.max_bytes\": \"1gb\",\n \"queue.checkpoint.writes\": 1024\n }\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "mget-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "docs": {
+ "description": "The response includes a docs array that contains the documents in the order specified in the request.\nThe structure of the returned documents is similar to that returned by the get API.\nIf there is a failure getting a particular document, the error is included in place of the document.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.mget.ResponseItem"
+ }
+ }
+ },
+ "required": [
+ "docs"
+ ]
+ }
+ }
+ }
+ },
+ "ml.get_calendars-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "calendars": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml.get_calendars.Calendar"
+ }
+ },
+ "count": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "calendars",
+ "count"
+ ]
+ }
+ }
+ }
+ },
+ "ml.get_data_frame_analytics-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number"
+ },
+ "data_frame_analytics": {
+ "description": "An array of data frame analytics job resources, which are sorted by the id value in ascending order.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalyticsSummary"
+ }
+ }
+ },
+ "required": [
+ "count",
+ "data_frame_analytics"
+ ]
+ }
+ }
+ }
+ },
+ "ml.get_data_frame_analytics_stats-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number"
+ },
+ "data_frame_analytics": {
+ "description": "An array of objects that contain usage information for data frame analytics jobs, which are sorted by the id value in ascending order.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.DataframeAnalytics"
+ }
+ }
+ },
+ "required": [
+ "count",
+ "data_frame_analytics"
+ ]
+ }
+ }
+ }
+ },
+ "ml.get_datafeed_stats-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number"
+ },
+ "datafeeds": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.DatafeedStats"
+ }
+ }
+ },
+ "required": [
+ "count",
+ "datafeeds"
+ ]
+ }
+ }
+ }
+ },
+ "ml.get_datafeeds-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number"
+ },
+ "datafeeds": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.Datafeed"
+ }
+ }
+ },
+ "required": [
+ "count",
+ "datafeeds"
+ ]
+ }
+ }
+ }
+ },
+ "ml.get_filters-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number"
+ },
+ "filters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.Filter"
+ }
+ }
+ },
+ "required": [
+ "count",
+ "filters"
+ ]
+ }
+ }
+ }
+ },
+ "ml.get_job_stats-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number"
+ },
+ "jobs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.JobStats"
+ }
+ }
+ },
+ "required": [
+ "count",
+ "jobs"
+ ]
+ }
+ }
+ }
+ },
+ "ml.get_jobs-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number"
+ },
+ "jobs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.Job"
+ }
+ }
+ },
+ "required": [
+ "count",
+ "jobs"
+ ]
+ }
+ }
+ }
+ },
+ "ml.get_overall_buckets-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number"
+ },
+ "overall_buckets": {
+ "description": "Array of overall bucket objects",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.OverallBucket"
+ }
+ }
+ },
+ "required": [
+ "count",
+ "overall_buckets"
+ ]
+ }
+ }
+ }
+ },
+ "ml.get_trained_models-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number"
+ },
+ "trained_model_configs": {
+ "description": "An array of trained model resources, which are sorted by the model_id value in ascending order.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.TrainedModelConfig"
+ }
+ }
+ },
+ "required": [
+ "count",
+ "trained_model_configs"
+ ]
+ }
+ }
+ }
+ },
+ "ml.get_trained_models_stats-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "description": "The total number of trained model statistics that matched the requested ID patterns. Could be higher than the number of items in the trained_model_stats array as the size of the array is restricted by the supplied size parameter.",
+ "type": "number"
+ },
+ "trained_model_stats": {
+ "description": "An array of trained model statistics, which are sorted by the model_id value in ascending order.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ml._types.TrainedModelStats"
+ }
+ }
+ },
+ "required": [
+ "count",
+ "trained_model_stats"
+ ]
+ }
+ }
+ }
+ },
+ "ml.preview_data_frame_analytics-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "feature_values": {
+ "description": "An array of objects that contain feature name and value pairs. The features have been processed and indicate what will be sent to the model for training.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "required": [
+ "feature_values"
+ ]
+ }
+ }
+ }
+ },
+ "ml.preview_datafeed-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ },
+ "msearch-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_global.msearch.MultiSearchResult"
+ }
+ }
+ }
+ },
+ "msearch_template-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_global.msearch.MultiSearchResult"
+ }
+ }
+ }
+ },
+ "mtermvectors-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "docs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.mtermvectors.TermVectorsResult"
+ }
+ }
+ },
+ "required": [
+ "docs"
+ ]
+ }
+ }
+ }
+ },
+ "put_script-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.AcknowledgedResponseBase"
+ }
+ }
+ }
+ },
+ "rank_eval-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "metric_score": {
+ "description": "The overall evaluation quality calculated by the defined metric",
+ "type": "number"
+ },
+ "details": {
+ "description": "The details section contains one entry for every query in the original requests section, keyed by the search request id",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricDetail"
+ }
+ },
+ "failures": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "required": [
+ "metric_score",
+ "details",
+ "failures"
+ ]
+ }
+ }
+ }
+ },
+ "render_search_template-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "template_output": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "required": [
+ "template_output"
+ ]
+ }
+ }
+ }
+ },
+ "scripts_painless_execute-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "result": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "result"
+ ]
+ },
+ "examples": {
+ "ExecutePainlessScriptResponseExample1": {
+ "summary": "Test context",
+ "description": "A successful response from `POST /_scripts/painless/_execute` with a `painless_test` context.",
+ "value": "{\n \"result\": \"0.1\"\n}"
+ },
+ "ExecutePainlessScriptResponseExample2": {
+ "summary": "Filter context",
+ "description": "A successful response from `POST /_scripts/painless/_execute` with a `filter` context.",
+ "value": "{\n \"result\": true\n}"
+ },
+ "ExecutePainlessScriptResponseExample3": {
+ "summary": "Score context",
+ "description": "A successful response from `POST /_scripts/painless/_execute` with a `score` context.",
+ "value": "{\n \"result\": 0.8\n}"
+ }
+ }
+ }
+ }
+ },
+ "scroll-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_global.search.ResponseBody"
+ }
+ }
+ }
+ },
+ "search-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_global.search.ResponseBody"
+ },
+ "examples": {
+ "SearchResponseExample1": {
+ "description": "An abbreviated response from `GET /my-index-000001/_search?from=40&size=20` with a simple term query.\n",
+ "value": "{\n \"took\": 5,\n \"timed_out\": false,\n \"_shards\": {\n \"total\": 1,\n \"successful\": 1,\n \"skipped\": 0,\n \"failed\": 0\n },\n \"hits\": {\n \"total\": {\n \"value\": 20,\n \"relation\": \"eq\"\n },\n \"max_score\": 1.3862942,\n \"hits\": [\n {\n \"_index\": \"my-index-000001\",\n \"_id\": \"0\",\n \"_score\": 1.3862942,\n \"_source\": {\n \"@timestamp\": \"2099-11-15T14:12:12\",\n \"http\": {\n \"request\": {\n \"method\": \"get\"\n },\n \"response\": {\n \"status_code\": 200,\n \"bytes\": 1070000\n },\n \"version\": \"1.1\"\n },\n \"source\": {\n \"ip\": \"127.0.0.1\"\n },\n \"message\": \"GET /search HTTP/1.1 200 1070000\",\n \"user\": {\n \"id\": \"kimchy\"\n }\n }\n }\n ]\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "search_application.get_behavioral_analytics-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/search_application._types.AnalyticsCollection"
+ }
+ },
+ "examples": {
+ "BehavioralAnalyticsGetResponseExample1": {
+ "description": "A successful response from `GET _application/analytics/my*`",
+ "value": "{\n \"my_analytics_collection\": {\n \"event_data_stream\": {\n \"name\": \"behavioral_analytics-events-my_analytics_collection\"\n }\n },\n \"my_analytics_collection2\": {\n \"event_data_stream\": {\n \"name\": \"behavioral_analytics-events-my_analytics_collection2\"\n }\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "search_application.search-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_global.search.ResponseBody"
+ }
+ }
+ }
+ },
+ "search_mvt-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/_types.MapboxVectorTiles"
+ },
+ "examples": {
+ "SearchMvtResponseExample1": {
+ "description": "A successful response from `GET museums/_mvt/location/13/4207/2692`. It returns results as a binary vector tile. When decoded into JSON, the tile contains the following data.\n",
+ "value": "{\n \"hits\": {\n \"extent\": 4096,\n \"version\": 2,\n \"features\": [\n {\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n 3208,\n 3864\n ]\n },\n \"properties\": {\n \"_id\": \"1\",\n \"_index\": \"museums\",\n \"name\": \"NEMO Science Museum\",\n \"price\": 1750\n },\n \"type\": 1\n },\n {\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n 3429,\n 3496\n ]\n },\n \"properties\": {\n \"_id\": \"3\",\n \"_index\": \"museums\",\n \"name\": \"Nederlands Scheepvaartmuseum\",\n \"price\": 1650\n },\n \"type\": 1\n },\n {\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n 3429,\n 3496\n ]\n },\n \"properties\": {\n \"_id\": \"4\",\n \"_index\": \"museums\",\n \"name\": \"Amsterdam Centre for Architecture\",\n \"price\": 0\n },\n \"type\": 1\n }\n ]\n },\n \"aggs\": {\n \"extent\": 4096,\n \"version\": 2,\n \"features\": [\n {\n \"geometry\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n 3072,\n 3072\n ],\n [\n 4096,\n 3072\n ],\n [\n 4096,\n 4096\n ],\n [\n 3072,\n 4096\n ],\n [\n 3072,\n 3072\n ]\n ]\n ]\n },\n \"properties\": {\n \"_count\": 3,\n \"max_price.value\": 1750.0,\n \"min_price.value\": 0.0,\n \"avg_price.value\": 1133.3333333333333\n },\n \"type\": 3\n }\n ]\n },\n \"meta\": {\n \"extent\": 4096,\n \"version\": 2,\n \"features\": [\n {\n \"geometry\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n 0,\n 0\n ],\n [\n 4096,\n 0\n ],\n [\n 4096,\n 4096\n ],\n [\n 0,\n 4096\n ],\n [\n 0,\n 0\n ]\n ]\n ]\n },\n \"properties\": {\n \"_shards.failed\": 0,\n \"_shards.skipped\": 0,\n \"_shards.successful\": 1,\n \"_shards.total\": 1,\n \"aggregations._count.avg\": 3.0,\n \"aggregations._count.count\": 1,\n \"aggregations._count.max\": 3.0,\n \"aggregations._count.min\": 3.0,\n \"aggregations._count.sum\": 3.0,\n \"aggregations.avg_price.avg\": 1133.3333333333333,\n \"aggregations.avg_price.count\": 1,\n \"aggregations.avg_price.max\": 1133.3333333333333,\n \"aggregations.avg_price.min\": 1133.3333333333333,\n \"aggregations.avg_price.sum\": 1133.3333333333333,\n \"aggregations.max_price.avg\": 1750.0,\n \"aggregations.max_price.count\": 1,\n \"aggregations.max_price.max\": 1750.0,\n \"aggregations.max_price.min\": 1750.0,\n \"aggregations.max_price.sum\": 1750.0,\n \"aggregations.min_price.avg\": 0.0,\n \"aggregations.min_price.count\": 1,\n \"aggregations.min_price.max\": 0.0,\n \"aggregations.min_price.min\": 0.0,\n \"aggregations.min_price.sum\": 0.0,\n \"hits.max_score\": 0.0,\n \"hits.total.relation\": \"eq\",\n \"hits.total.value\": 3,\n \"timed_out\": false,\n \"took\": 2\n },\n \"type\": 3\n }\n ]\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "search_template-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "took": {
+ "type": "number"
+ },
+ "timed_out": {
+ "type": "boolean"
+ },
+ "_shards": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ShardStatistics"
+ }
+ ]
+ },
+ "hits": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.HitsMetadata"
+ }
+ ]
+ },
+ "aggregations": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.Aggregate"
+ }
+ },
+ "_clusters": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ClusterStatistics"
+ }
+ ]
+ },
+ "fields": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "max_score": {
+ "type": "number"
+ },
+ "num_reduce_phases": {
+ "type": "number"
+ },
+ "profile": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.Profile"
+ }
+ ]
+ },
+ "pit_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "_scroll_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScrollId"
+ }
+ ]
+ },
+ "suggest": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.Suggest"
+ }
+ }
+ },
+ "terminated_early": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "took",
+ "timed_out",
+ "_shards",
+ "hits"
+ ]
+ }
+ }
+ }
+ },
+ "security.create_api_key-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "api_key": {
+ "description": "Generated API key.",
+ "type": "string"
+ },
+ "expiration": {
+ "description": "Expiration in milliseconds for the API key.",
+ "type": "number"
+ },
+ "id": {
+ "description": "Unique ID for this API key.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "name": {
+ "description": "Specifies the name for this API key.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "encoded": {
+ "description": "API key credentials which is the base64-encoding of\nthe UTF-8 representation of `id` and `api_key` joined\nby a colon (`:`).",
+ "x-state": "Generally available",
+ "type": "string"
+ }
+ },
+ "required": [
+ "api_key",
+ "id",
+ "name",
+ "encoded"
+ ]
+ },
+ "examples": {
+ "SecurityCreateApiKeyResponseExample1": {
+ "description": "A successful response from `POST /_security/api_key`.",
+ "value": "{\n \"id\": \"VuaCfGcBCdbkQm-e5aOx\", \n \"name\": \"my-api-key\",\n \"expiration\": 1544068612110, \n \"api_key\": \"ui2lp2axTNmsyakw9tvNnw\", \n \"encoded\": \"VnVhQ2ZHY0JDZGJrUW0tZTVhT3g6dWkybHAyYXhUTm1zeWFrdzl0dk5udw==\" \n}"
+ }
+ }
+ }
+ }
+ },
+ "security.get_role-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/security.get_role.Role"
+ }
+ },
+ "examples": {
+ "SecurityGetRoleResponseExample1": {
+ "description": "A successful response from `GET /_security/role/my_admin_role`. The response contains information about the `my_admin_role` role in the native realm.\n",
+ "value": "{\n \"my_admin_role\": {\n \"description\": \"Grants full access to all management features within the cluster.\",\n \"cluster\" : [ \"all\" ],\n \"indices\" : [\n {\n \"names\" : [ \"index1\", \"index2\" ],\n \"privileges\" : [ \"all\" ],\n \"allow_restricted_indices\" : false,\n \"field_security\" : {\n \"grant\" : [ \"title\", \"body\" ]}\n }\n ],\n \"applications\" : [ ],\n \"run_as\" : [ \"other_user\" ],\n \"metadata\" : {\n \"version\" : 1\n },\n \"transient_metadata\": {\n \"enabled\": true\n }\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "security.has_privileges-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "application": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/security.has_privileges.ApplicationsPrivileges"
+ }
+ ]
+ },
+ "cluster": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "boolean"
+ }
+ },
+ "has_all_requested": {
+ "type": "boolean"
+ },
+ "index": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/security.has_privileges.Privileges"
+ }
+ },
+ "username": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Username"
+ }
+ ]
+ }
+ },
+ "required": [
+ "application",
+ "cluster",
+ "has_all_requested",
+ "index",
+ "username"
+ ]
+ },
+ "examples": {
+ "SecurityHasPrivilegesResponseExample1": {
+ "description": "A successful response from `GET /_security/user/_has_privileges`, which lists the privileges for the `rdeniro` user.",
+ "value": "{\n \"username\": \"rdeniro\",\n \"has_all_requested\" : false,\n \"cluster\" : {\n \"monitor\" : true,\n \"manage\" : false\n },\n \"index\" : {\n \"suppliers\" : {\n \"read\" : true\n },\n \"products\" : {\n \"read\" : true\n },\n \"inventory\" : {\n \"read\" : true,\n \"write\" : false\n }\n },\n \"application\" : {\n \"inventory_manager\" : {\n \"product/1852563\" : {\n \"read\": false,\n \"data:write/inventory\": false\n }\n }\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "security.put_role-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "role": {
+ "description": "When an existing role is updated, `created` is set to `false`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/security._types.CreatedStatus"
+ }
+ ]
+ }
+ },
+ "required": [
+ "role"
+ ]
+ },
+ "examples": {
+ "SecurityPutRoleResponseExample1": {
+ "description": "A successful response from `POST /_security/role/my_admin_role`.",
+ "value": "{\n \"role\": {\n \"created\": true \n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "security.query_api_keys-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "total": {
+ "description": "The total number of API keys found.",
+ "type": "number"
+ },
+ "count": {
+ "description": "The number of API keys returned in the response.",
+ "type": "number"
+ },
+ "api_keys": {
+ "description": "A list of API key information.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/security._types.ApiKey"
+ }
+ },
+ "aggregations": {
+ "description": "The aggregations result, if requested.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/security.query_api_keys.ApiKeyAggregate"
+ }
+ }
+ },
+ "required": [
+ "total",
+ "count",
+ "api_keys"
+ ]
+ },
+ "examples": {
+ "QueryApiKeysResponseExample1": {
+ "summary": "Query API keys by ID",
+ "description": "A successful response from `GET /_security/_query/api_key?with_limited_by=true`. The `limited_by` details are the owner user's permissions associated with the API key. It is a point-in-time snapshot captured at creation and subsequent updates. An API key's effective permissions are an intersection of its assigned privileges and the owner user's permissions.\n",
+ "value": "{\n \"api_keys\": [\n {\n \"id\": \"VuaCfGcBCdbkQm-e5aOx\",\n \"name\": \"application-key-1\",\n \"creation\": 1548550550158,\n \"expiration\": 1548551550158,\n \"invalidated\": false,\n \"username\": \"myuser\",\n \"realm\": \"native1\",\n \"realm_type\": \"native\",\n \"metadata\": {\n \"application\": \"my-application\"\n },\n \"role_descriptors\": { },\n \"limited_by\": [ \n {\n \"role-power-user\": {\n \"cluster\": [\n \"monitor\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"*\"\n ],\n \"privileges\": [\n \"read\"\n ],\n \"allow_restricted_indices\": false\n }\n ],\n \"applications\": [ ],\n \"run_as\": [ ],\n \"metadata\": { },\n \"transient_metadata\": {\n \"enabled\": true\n }\n }\n }\n ]\n }\n ]\n}"
+ },
+ "QueryApiKeysResponseExample2": {
+ "summary": "Query API keys with pagination",
+ "description": "An abbreviated response from `GET /_security/_query/api_key` that contains a list of matched API keys along with their sort values. The first sort value is creation time, which is displayed in `date_time` format. The second sort value is the API key name.\n",
+ "value": "{\n \"total\": 100,\n \"count\": 10,\n \"api_keys\": [\n {\n \"id\": \"CLXgVnsBOGkf8IyjcXU7\",\n \"name\": \"app1-key-79\",\n \"creation\": 1629250154811,\n \"invalidated\": false,\n \"username\": \"org-admin-user\",\n \"realm\": \"native1\",\n \"metadata\": {\n \"environment\": \"production\"\n },\n \"role_descriptors\": { },\n \"_sort\": [\n \"2021-08-18T01:29:14.811Z\", \n \"app1-key-79\" \n ]\n },\n {\n \"id\": \"BrXgVnsBOGkf8IyjbXVB\",\n \"name\": \"app1-key-78\",\n \"creation\": 1629250153794,\n \"invalidated\": false,\n \"username\": \"org-admin-user\",\n \"realm\": \"native1\",\n \"metadata\": {\n \"environment\": \"production\"\n },\n \"role_descriptors\": { },\n \"_sort\": [\n \"2021-08-18T01:29:13.794Z\",\n \"app1-key-78\"\n ]\n }\n ]\n}"
+ },
+ "QueryApiKeysResponseExample3": {
+ "summary": "Query all API keys",
+ "description": "A successful response from `GET /_security/_query/api_key`. It includes the role descriptors that are assigned to each API key when it was created or last updated. Note that an API key's effective permissions are an intersection of its assigned privileges and the point-in-time snapshot of the owner user's permissions. An empty role descriptors object means the API key inherits the owner user's permissions.\n",
+ "value": "{\n \"total\": 3,\n \"count\": 3,\n \"api_keys\": [ \n {\n \"id\": \"nkvrGXsB8w290t56q3Rg\",\n \"name\": \"my-api-key-1\",\n \"creation\": 1628227480421,\n \"expiration\": 1629091480421,\n \"invalidated\": false,\n \"username\": \"elastic\",\n \"realm\": \"reserved\",\n \"realm_type\": \"reserved\",\n \"metadata\": {\n \"letter\": \"a\"\n },\n \"role_descriptors\": { \n \"role-a\": {\n \"cluster\": [\n \"monitor\"\n ],\n \"indices\": [\n {\n \"names\": [\n \"index-a\"\n ],\n \"privileges\": [\n \"read\"\n ],\n \"allow_restricted_indices\": false\n }\n ],\n \"applications\": [ ],\n \"run_as\": [ ],\n \"metadata\": { },\n \"transient_metadata\": {\n \"enabled\": true\n }\n }\n }\n },\n {\n \"id\": \"oEvrGXsB8w290t5683TI\",\n \"name\": \"my-api-key-2\",\n \"creation\": 1628227498953,\n \"expiration\": 1628313898953,\n \"invalidated\": false,\n \"username\": \"elastic\",\n \"realm\": \"reserved\",\n \"metadata\": {\n \"letter\": \"b\"\n },\n \"role_descriptors\": { } \n }\n ]\n}"
+ }
+ }
+ }
+ }
+ },
+ "security.query_role-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "total": {
+ "description": "The total number of roles found.",
+ "type": "number"
+ },
+ "count": {
+ "description": "The number of roles returned in the response.",
+ "type": "number"
+ },
+ "roles": {
+ "description": "A list of roles that match the query.\nThe returned role format is an extension of the role definition format.\nIt adds the `transient_metadata.enabled` and the `_sort` fields.\n`transient_metadata.enabled` is set to `false` in case the role is automatically disabled, for example when the role grants privileges that are not allowed by the installed license.\n`_sort` is present when the search query sorts on some field.\nIt contains the array of values that have been used for sorting.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/security.query_role.QueryRole"
+ }
+ }
+ },
+ "required": [
+ "total",
+ "count",
+ "roles"
+ ]
+ },
+ "examples": {
+ "QueryRolesResponseExample1": {
+ "summary": "Query roles by name",
+ "description": "A successful response from `POST /_security/_query/role`. It returns a JSON structure that contains the information retrieved for one or more roles.\n",
+ "value": "{\n \"total\": 2,\n \"count\": 2,\n \"roles\": [ \n {\n \"name\" : \"my_admin_role\",\n \"cluster\" : [\n \"all\"\n ],\n \"indices\" : [\n {\n \"names\" : [\n \"index1\",\n \"index2\"\n ],\n \"privileges\" : [\n \"all\"\n ],\n \"field_security\" : {\n \"grant\" : [\n \"title\",\n \"body\"\n ]\n },\n \"allow_restricted_indices\" : false\n }\n ],\n \"applications\" : [ ],\n \"run_as\" : [\n \"other_user\"\n ],\n \"metadata\" : {\n \"version\" : 1\n },\n \"transient_metadata\" : {\n \"enabled\" : true\n },\n \"description\" : \"Grants full access to all management features within the cluster.\",\n \"_sort\" : [\n \"my_admin_role\"\n ]\n },\n {\n \"name\" : \"my_user_role\",\n \"cluster\" : [ ],\n \"indices\" : [\n {\n \"names\" : [\n \"index1\",\n \"index2\"\n ],\n \"privileges\" : [\n \"all\"\n ],\n \"field_security\" : {\n \"grant\" : [\n \"title\",\n \"body\"\n ]\n },\n \"allow_restricted_indices\" : false\n }\n ],\n \"applications\" : [ ],\n \"run_as\" : [ ],\n \"metadata\" : {\n \"version\" : 1\n },\n \"transient_metadata\" : {\n \"enabled\" : true\n },\n \"description\" : \"Grants user access to some indicies.\",\n \"_sort\" : [\n \"my_user_role\"\n ]\n }\n ]\n}"
+ },
+ "QueryRolesResponseExample2": {
+ "summary": "Query roles by description",
+ "description": "A successful response from `POST /_security/_query/role`.\n",
+ "value": "{\n \"total\": 2,\n \"count\": 1,\n \"roles\": [\n {\n \"name\" : \"my_user_role\",\n \"cluster\" : [ ],\n \"indices\" : [\n {\n \"names\" : [\n \"index1\",\n \"index2\"\n ],\n \"privileges\" : [\n \"all\"\n ],\n \"field_security\" : {\n \"grant\" : [\n \"title\",\n \"body\"\n ]\n },\n \"allow_restricted_indices\" : false\n }\n ],\n \"applications\" : [ ],\n \"run_as\" : [ ],\n \"metadata\" : {\n \"version\" : 1\n },\n \"transient_metadata\" : {\n \"enabled\" : true\n },\n \"description\" : \"Grants user access to some indicies.\"\n }\n ]\n}"
+ }
+ }
+ }
+ }
+ },
+ "sql.query-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "columns": {
+ "description": "Column headings for the search results. Each object is a column.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/sql._types.Column"
+ }
+ },
+ "cursor": {
+ "description": "The cursor for the next set of paginated results.\nFor CSV, TSV, and TXT responses, this value is returned in the `Cursor` HTTP header.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The identifier for the search.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-ID` HTTP header.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "is_running": {
+ "description": "If `true`, the search is still running.\nIf `false`, the search has finished.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.",
+ "type": "boolean"
+ },
+ "is_partial": {
+ "description": "If `true`, the response does not contain complete search results.\nIf `is_partial` is `true` and `is_running` is `true`, the search is still running.\nIf `is_partial` is `true` but `is_running` is `false`, the results are partial due to a failure or timeout.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.",
+ "type": "boolean"
+ },
+ "rows": {
+ "description": "The values for the search results.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/sql._types.Row"
+ }
+ }
+ },
+ "required": [
+ "rows"
+ ]
+ }
+ }
+ }
+ },
+ "sql.translate-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "aggregations": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.AggregationContainer"
+ }
+ },
+ "size": {
+ "type": "number"
+ },
+ "_source": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.SourceConfig"
+ }
+ ]
+ },
+ "fields": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
+ }
+ },
+ "query": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "sort": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Sort"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "terms_enum-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "_shards": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ShardStatistics"
+ }
+ ]
+ },
+ "terms": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "complete": {
+ "description": "If `false`, the returned terms set may be incomplete and should be treated as approximate.\nThis can occur due to a few reasons, such as a request timeout or a node error.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "_shards",
+ "terms",
+ "complete"
+ ]
+ },
+ "examples": {
+ "TermsEnumResponseExample1": {
+ "description": "A successful response from `POST stackoverflow/_terms_enum`.",
+ "value": "{\n \"_shards\": {\n \"total\": 1,\n \"successful\": 1,\n \"failed\": 0\n },\n \"terms\": [\n \"kibana\"\n ],\n \"complete\" : true\n}"
+ }
+ }
+ }
+ }
+ },
+ "termvectors-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "found": {
+ "type": "boolean"
+ },
+ "_id": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "_index": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "term_vectors": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_global.termvectors.TermVector"
+ }
+ },
+ "took": {
+ "type": "number"
+ },
+ "_version": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ }
+ ]
+ }
+ },
+ "required": [
+ "found",
+ "_index",
+ "took",
+ "_version"
+ ]
+ },
+ "examples": {
+ "TermVectorsResponseExample1": {
+ "summary": "Return stored term vectors",
+ "description": "A successful response from `GET /my-index-000001/_termvectors/1`.",
+ "value": "{\n \"_index\": \"my-index-000001\",\n \"_id\": \"1\",\n \"_version\": 1,\n \"found\": true,\n \"took\": 6,\n \"term_vectors\": {\n \"text\": {\n \"field_statistics\": {\n \"sum_doc_freq\": 4,\n \"doc_count\": 2,\n \"sum_ttf\": 6\n },\n \"terms\": {\n \"test\": {\n \"doc_freq\": 2,\n \"ttf\": 4,\n \"term_freq\": 3,\n \"tokens\": [\n {\n \"position\": 0,\n \"start_offset\": 0,\n \"end_offset\": 4,\n \"payload\": \"d29yZA==\"\n },\n {\n \"position\": 1,\n \"start_offset\": 5,\n \"end_offset\": 9,\n \"payload\": \"d29yZA==\"\n },\n {\n \"position\": 2,\n \"start_offset\": 10,\n \"end_offset\": 14,\n \"payload\": \"d29yZA==\"\n }\n ]\n }\n }\n }\n }\n}"
+ },
+ "TermVectorsResponseExample2": {
+ "summary": "Per-field analyzer",
+ "description": "A successful response from `GET /my-index-000001/_termvectors` with `per_field_analyzer` in the request body.",
+ "value": "{\n \"_index\": \"my-index-000001\",\n \"_version\": 0,\n \"found\": true,\n \"took\": 6,\n \"term_vectors\": {\n \"fullname\": {\n \"field_statistics\": {\n \"sum_doc_freq\": 2,\n \"doc_count\": 4,\n \"sum_ttf\": 4\n },\n \"terms\": {\n \"John Doe\": {\n \"term_freq\": 1,\n \"tokens\": [\n {\n \"position\": 0,\n \"start_offset\": 0,\n \"end_offset\": 8\n }\n ]\n }\n }\n }\n }\n}"
+ },
+ "TermVectorsResponseExample3": {
+ "summary": "Terms filtering",
+ "description": "A successful response from `GET /my-index-000001/_termvectors` with a `filter` in the request body.",
+ "value": "{\n \"_index\": \"imdb\",\n \"_version\": 0,\n \"found\": true,\n \"term_vectors\": {\n \"plot\": {\n \"field_statistics\": {\n \"sum_doc_freq\": 3384269,\n \"doc_count\": 176214,\n \"sum_ttf\": 3753460\n },\n \"terms\": {\n \"armored\": {\n \"doc_freq\": 27,\n \"ttf\": 27,\n \"term_freq\": 1,\n \"score\": 9.74725\n },\n \"industrialist\": {\n \"doc_freq\": 88,\n \"ttf\": 88,\n \"term_freq\": 1,\n \"score\": 8.590818\n },\n \"stark\": {\n \"doc_freq\": 44,\n \"ttf\": 47,\n \"term_freq\": 1,\n \"score\": 9.272792\n }\n }\n }\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "transform.get_transform-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number"
+ },
+ "transforms": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/transform.get_transform.TransformSummary"
+ }
+ }
+ },
+ "required": [
+ "count",
+ "transforms"
+ ]
+ },
+ "examples": {
+ "GetTransformResponseExample1": {
+ "description": "A successful response that contains configuration information for a transform.",
+ "value": "{\n \"count\": 1,\n \"transforms\": [\n {\n \"id\": \"ecommerce_transform1\",\n \"authorization\": {\n \"roles\": [\n \"superuser\"\n ]\n },\n \"version\": \"8.4.0\",\n \"create_time\": 1656023416565,\n \"source\": {\n \"index\": [\n \"kibana_sample_data_ecommerce\"\n ],\n \"query\": {\n \"term\": {\n \"geoip.continent_name\": {\n \"value\": \"Asia\"\n }\n }\n }\n },\n \"dest\": {\n \"index\": \"kibana_sample_data_ecommerce_transform1\",\n \"pipeline\": \"add_timestamp_pipeline\"\n },\n \"frequency\": \"5m\",\n \"sync\": {\n \"time\": {\n \"field\": \"order_date\",\n \"delay\": \"60s\"\n }\n },\n \"pivot\": {\n \"group_by\": {\n \"customer_id\": {\n \"terms\": {\n \"field\": \"customer_id\"\n }\n }\n },\n \"aggregations\": {\n \"max_price\": {\n \"max\": {\n \"field\": \"taxful_total_price\"\n }\n }\n }\n },\n \"description\": \"Maximum priced ecommerce data by customer_id in Asia\",\n \"settings\": {},\n \"retention_policy\": {\n \"time\": {\n \"field\": \"order_date\",\n \"max_age\": \"30d\"\n }\n }\n }\n ]\n}"
+ }
+ }
+ }
+ }
+ },
+ "transform.preview_transform-200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "generated_dest_index": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexState"
+ }
+ ]
+ },
+ "preview": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ }
+ },
+ "required": [
+ "generated_dest_index",
+ "preview"
+ ]
+ },
+ "examples": {
+ "PreviewTransformResponseExample1": {
+ "description": "An abbreviated response from `POST _transform/_preview` that contains a preview a transform that uses the pivot method.",
+ "value": "{\n \"preview\": [\n {\n \"max_price\": 171,\n \"customer_id\": \"10\"\n },\n {\n \"max_price\": 233,\n \"customer_id\": \"11\"\n },\n {\n \"max_price\": 200,\n \"customer_id\": \"12\"\n },\n {\n \"max_price\": 301,\n \"customer_id\": \"13\"\n },\n {\n \"max_price\": 176,\n \"customer_id\": \"14\"\n },\n {\n \"max_price\": 2250,\n \"customer_id\": \"15\"\n },\n {\n \"max_price\": 170,\n \"customer_id\": \"16\"\n },\n {\n \"max_price\": 243,\n \"customer_id\": \"17\"\n },\n {\n \"max_price\": 154,\n \"customer_id\": \"18\"\n },\n {\n \"max_price\": 393,\n \"customer_id\": \"19\"\n },\n {\n \"max_price\": 165,\n \"customer_id\": \"20\"\n },\n {\n \"max_price\": 115,\n \"customer_id\": \"21\"\n },\n {\n \"max_price\": 192,\n \"customer_id\": \"22\"\n },\n {\n \"max_price\": 169,\n \"customer_id\": \"23\"\n },\n {\n \"max_price\": 230,\n \"customer_id\": \"24\"\n },\n {\n \"max_price\": 278,\n \"customer_id\": \"25\"\n },\n {\n \"max_price\": 200,\n \"customer_id\": \"26\"\n },\n {\n \"max_price\": 344,\n \"customer_id\": \"27\"\n },\n {\n \"max_price\": 175,\n \"customer_id\": \"28\"\n },\n {\n \"max_price\": 177,\n \"customer_id\": \"29\"\n },\n {\n \"max_price\": 190,\n \"customer_id\": \"30\"\n },\n {\n \"max_price\": 190,\n \"customer_id\": \"31\"\n },\n {\n \"max_price\": 205,\n \"customer_id\": \"32\"\n },\n {\n \"max_price\": 215,\n \"customer_id\": \"33\"\n },\n {\n \"max_price\": 270,\n \"customer_id\": \"34\"\n },\n {\n \"max_price\": 184,\n \"customer_id\": \"36\"\n },\n {\n \"max_price\": 222,\n \"customer_id\": \"37\"\n },\n {\n \"max_price\": 370,\n \"customer_id\": \"38\"\n },\n {\n \"max_price\": 240,\n \"customer_id\": \"39\"\n },\n {\n \"max_price\": 230,\n \"customer_id\": \"4\"\n },\n {\n \"max_price\": 229,\n \"customer_id\": \"41\"\n },\n {\n \"max_price\": 190,\n \"customer_id\": \"42\"\n },\n {\n \"max_price\": 150,\n \"customer_id\": \"43\"\n },\n {\n \"max_price\": 175,\n \"customer_id\": \"44\"\n },\n {\n \"max_price\": 190,\n \"customer_id\": \"45\"\n },\n {\n \"max_price\": 150,\n \"customer_id\": \"46\"\n },\n {\n \"max_price\": 310,\n \"customer_id\": \"48\"\n },\n {\n \"max_price\": 223,\n \"customer_id\": \"49\"\n },\n {\n \"max_price\": 283,\n \"customer_id\": \"5\"\n },\n {\n \"max_price\": 185,\n \"customer_id\": \"50\"\n },\n {\n \"max_price\": 190,\n \"customer_id\": \"51\"\n },\n {\n \"max_price\": 333,\n \"customer_id\": \"52\"\n },\n {\n \"max_price\": 165,\n \"customer_id\": \"6\"\n },\n {\n \"max_price\": 144,\n \"customer_id\": \"7\"\n },\n {\n \"max_price\": 198,\n \"customer_id\": \"8\"\n },\n {\n \"max_price\": 210,\n \"customer_id\": \"9\"\n }\n ],\n \"generated_dest_index\": {\n \"mappings\": {\n \"_meta\": {\n \"_transform\": {\n \"transform\": \"transform-preview\",\n \"version\": {\n \"created\": \"10.0.0\"\n },\n \"creation_date_in_millis\": 1712948905889\n },\n \"created_by\": \"transform\"\n },\n \"properties\": {\n \"max_price\": {\n \"type\": \"half_float\"\n },\n \"customer_id\": {\n \"type\": \"keyword\"\n }\n }\n },\n \"settings\": {\n \"index\": {\n \"number_of_shards\": \"1\",\n \"auto_expand_replicas\": \"0-1\"\n }\n },\n \"aliases\": {}\n }\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "async_search.submit-index": {
+ "in": "path",
+ "name": "index",
+ "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ "async_search.submit-wait_for_completion_timeout": {
+ "in": "query",
+ "name": "wait_for_completion_timeout",
+ "description": "Blocks and waits until the search is completed up to a certain timeout.\nWhen the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "async_search.submit-keep_alive": {
+ "in": "query",
+ "name": "keep_alive",
+ "description": "Specifies how long the async search needs to be available.\nOngoing async searches and any saved search results are deleted after this period.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "async_search.submit-keep_on_completion": {
+ "in": "query",
+ "name": "keep_on_completion",
+ "description": "If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "async_search.submit-allow_no_indices": {
+ "in": "query",
+ "name": "allow_no_indices",
+ "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)",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "async_search.submit-allow_partial_search_results": {
+ "in": "query",
+ "name": "allow_partial_search_results",
+ "description": "Indicate if an error should be returned if there is a partial search failure or timeout",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "async_search.submit-analyzer": {
+ "in": "query",
+ "name": "analyzer",
+ "description": "The analyzer to use for the query string",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "async_search.submit-analyze_wildcard": {
+ "in": "query",
+ "name": "analyze_wildcard",
+ "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "async_search.submit-batched_reduce_size": {
+ "in": "query",
+ "name": "batched_reduce_size",
+ "description": "Affects how often partial results become available, which happens whenever shard results are reduced.\nA partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default).",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "async_search.submit-ccs_minimize_roundtrips": {
+ "in": "query",
+ "name": "ccs_minimize_roundtrips",
+ "description": "The default value is the only supported value.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "async_search.submit-default_operator": {
+ "in": "query",
+ "name": "default_operator",
+ "description": "The default operator for query string query (AND or OR)",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.query_dsl.Operator"
+ },
+ "style": "form"
+ },
+ "async_search.submit-df": {
+ "in": "query",
+ "name": "df",
+ "description": "The field to use as default where no field prefix is given in the query string",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "async_search.submit-docvalue_fields": {
+ "in": "query",
+ "name": "docvalue_fields",
+ "description": "A comma-separated list of fields to return as the docvalue representation of a field for each hit",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Fields"
+ },
+ "style": "form"
+ },
+ "async_search.submit-expand_wildcards": {
+ "in": "query",
+ "name": "expand_wildcards",
+ "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ExpandWildcards"
+ },
+ "style": "form"
+ },
+ "async_search.submit-explain": {
+ "in": "query",
+ "name": "explain",
+ "description": "Specify whether to return detailed information about score computation as part of a hit",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "async_search.submit-ignore_throttled": {
+ "in": "query",
+ "name": "ignore_throttled",
+ "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "async_search.submit-ignore_unavailable": {
+ "in": "query",
+ "name": "ignore_unavailable",
+ "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "async_search.submit-lenient": {
+ "in": "query",
+ "name": "lenient",
+ "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "async_search.submit-max_concurrent_shard_requests": {
+ "in": "query",
+ "name": "max_concurrent_shard_requests",
+ "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "async_search.submit-preference": {
+ "in": "query",
+ "name": "preference",
+ "description": "Specify the node or shard the operation should be performed on (default: random)",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "async_search.submit-request_cache": {
+ "in": "query",
+ "name": "request_cache",
+ "description": "Specify if request cache should be used for this request or not, defaults to true",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "async_search.submit-routing": {
+ "in": "query",
+ "name": "routing",
+ "description": "A comma-separated list of specific routing values",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Routing"
+ },
+ "style": "form"
+ },
+ "async_search.submit-search_type": {
+ "in": "query",
+ "name": "search_type",
+ "description": "Search operation type\n\nSupported values include:\n - `query_then_fetch`: Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.\n - `dfs_query_then_fetch`: Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.SearchType"
+ },
+ "style": "form"
+ },
+ "async_search.submit-stats": {
+ "in": "query",
+ "name": "stats",
+ "description": "Specific 'tag' of the request for logging and statistical purposes",
+ "deprecated": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "style": "form"
+ },
+ "async_search.submit-stored_fields": {
+ "in": "query",
+ "name": "stored_fields",
+ "description": "A comma-separated list of stored fields to return as part of a hit",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Fields"
+ },
+ "style": "form"
+ },
+ "async_search.submit-suggest_field": {
+ "in": "query",
+ "name": "suggest_field",
+ "description": "Specifies which field to use for suggestions.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Field"
+ },
+ "style": "form"
+ },
+ "async_search.submit-suggest_mode": {
+ "in": "query",
+ "name": "suggest_mode",
+ "description": "Specify suggest mode\n\nSupported values include:\n - `missing`: Only generate suggestions for terms that are not in the shard.\n - `popular`: Only suggest terms that occur in more docs on the shard than the original term.\n - `always`: Suggest any matching suggestions based on terms in the suggest text.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.SuggestMode"
+ },
+ "style": "form"
+ },
+ "async_search.submit-suggest_size": {
+ "in": "query",
+ "name": "suggest_size",
+ "description": "How many suggestions to return in response",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "async_search.submit-suggest_text": {
+ "in": "query",
+ "name": "suggest_text",
+ "description": "The source text for which the suggestions should be returned.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "async_search.submit-terminate_after": {
+ "in": "query",
+ "name": "terminate_after",
+ "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "async_search.submit-timeout": {
+ "in": "query",
+ "name": "timeout",
+ "description": "Explicit operation timeout",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "async_search.submit-track_total_hits": {
+ "in": "query",
+ "name": "track_total_hits",
+ "description": "Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_global.search._types.TrackHits"
+ },
+ "style": "form"
+ },
+ "async_search.submit-track_scores": {
+ "in": "query",
+ "name": "track_scores",
+ "description": "Whether to calculate and return scores even if they are not used for sorting",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "async_search.submit-typed_keys": {
+ "in": "query",
+ "name": "typed_keys",
+ "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "async_search.submit-rest_total_hits_as_int": {
+ "in": "query",
+ "name": "rest_total_hits_as_int",
+ "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "async_search.submit-version": {
+ "in": "query",
+ "name": "version",
+ "description": "Specify whether to return document version as part of a hit",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "async_search.submit-_source": {
+ "in": "query",
+ "name": "_source",
+ "description": "True or false to return the _source field or not, or a list of fields to return",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_global.search._types.SourceConfigParam"
+ },
+ "style": "form"
+ },
+ "async_search.submit-_source_excludes": {
+ "in": "query",
+ "name": "_source_excludes",
+ "description": "A list of fields to exclude from the returned _source field",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Fields"
+ },
+ "style": "form"
+ },
+ "async_search.submit-_source_includes": {
+ "in": "query",
+ "name": "_source_includes",
+ "description": "A list of fields to extract and return from the _source field",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Fields"
+ },
+ "style": "form"
+ },
+ "async_search.submit-seq_no_primary_term": {
+ "in": "query",
+ "name": "seq_no_primary_term",
+ "description": "Specify whether to return sequence number and primary term of the last modification of each hit",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "async_search.submit-q": {
+ "in": "query",
+ "name": "q",
+ "description": "Query in the Lucene query string syntax",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "async_search.submit-size": {
+ "in": "query",
+ "name": "size",
+ "description": "Number of hits to return (default: 10)",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "async_search.submit-from": {
+ "in": "query",
+ "name": "from",
+ "description": "Starting offset (default: 0)",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "async_search.submit-sort": {
+ "in": "query",
+ "name": "sort",
+ "description": "A comma-separated list of : pairs",
+ "deprecated": false,
+ "schema": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "style": "form"
+ },
+ "bulk-index": {
+ "in": "path",
+ "name": "index",
+ "description": "The name of the data stream, index, or index alias to perform bulk actions on.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.IndexName"
+ },
+ "style": "simple"
+ },
+ "bulk-include_source_on_error": {
+ "in": "query",
+ "name": "include_source_on_error",
+ "description": "True or false if to include the document source in the error message in case of parsing errors.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "bulk-list_executed_pipelines": {
+ "in": "query",
+ "name": "list_executed_pipelines",
+ "description": "If `true`, the response will include the ingest pipelines that were run for each index or create.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "bulk-pipeline": {
+ "in": "query",
+ "name": "pipeline",
+ "description": "The pipeline identifier to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request.\nIf a final pipeline is configured, it will always run regardless of the value of this parameter.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "bulk-refresh": {
+ "in": "query",
+ "name": "refresh",
+ "description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf `wait_for`, wait for a refresh to make this operation visible to search.\nIf `false`, do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Refresh"
+ },
+ "style": "form"
+ },
+ "bulk-routing": {
+ "in": "query",
+ "name": "routing",
+ "description": "A custom value that is used to route operations to a specific shard.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Routing"
+ },
+ "style": "form"
+ },
+ "bulk-_source": {
+ "in": "query",
+ "name": "_source",
+ "description": "Indicates whether to return the `_source` field (`true` or `false`) or contains a list of fields to return.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_global.search._types.SourceConfigParam"
+ },
+ "style": "form"
+ },
+ "bulk-_source_excludes": {
+ "in": "query",
+ "name": "_source_excludes",
+ "description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Fields"
+ },
+ "style": "form"
+ },
+ "bulk-_source_includes": {
+ "in": "query",
+ "name": "_source_includes",
+ "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned.\nYou can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Fields"
+ },
+ "style": "form"
+ },
+ "bulk-timeout": {
+ "in": "query",
+ "name": "timeout",
+ "description": "The period each action waits for the following operations: automatic index creation, dynamic mapping updates, and waiting for active shards.\nThe default is `1m` (one minute), which guarantees Elasticsearch waits for at least the timeout before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "bulk-wait_for_active_shards": {
+ "in": "query",
+ "name": "wait_for_active_shards",
+ "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe default is `1`, which waits for each primary shard to be active.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.WaitForActiveShards"
+ },
+ "style": "form"
+ },
+ "bulk-require_alias": {
+ "in": "query",
+ "name": "require_alias",
+ "description": "If `true`, the request's actions must target an index alias.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "bulk-require_data_stream": {
+ "in": "query",
+ "name": "require_data_stream",
+ "description": "If `true`, the request's actions must target a data stream (existing or to be created).",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "cat.aliases-name": {
+ "in": "path",
+ "name": "name",
+ "description": "A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Names"
+ },
+ "style": "simple"
+ },
+ "cat.aliases-h": {
+ "in": "query",
+ "name": "h",
+ "description": "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `alias` (or `a`): The name of the alias.\n - `index` (or `i`, `idx`): The name of the index the alias points to.\n - `filter` (or `f`, `fi`): The filter applied to the alias.\n - `routing.index` (or `ri`, `routingIndex`): Index routing value for the alias.\n - `routing.search` (or `rs`, `routingSearch`): Search routing value for the alias.\n - `is_write_index` (or `w`, `isWriteIndex`): Indicates if the index is the write index for the alias.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/cat._types.CatAliasesColumns"
+ },
+ "style": "form"
+ },
+ "cat.aliases-s": {
+ "in": "query",
+ "name": "s",
+ "description": "List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Names"
+ },
+ "style": "form"
+ },
+ "cat.aliases-expand_wildcards": {
+ "in": "query",
+ "name": "expand_wildcards",
+ "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`.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ExpandWildcards"
+ },
+ "style": "form"
+ },
+ "cat.aliases-master_timeout": {
+ "in": "query",
+ "name": "master_timeout",
+ "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicated that the request should never timeout, you can set it to `-1`.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "cat.component_templates-name": {
+ "in": "path",
+ "name": "name",
+ "description": "The name of the component template.\nIt accepts wildcard expressions.\nIf it is omitted, all component templates are returned.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "simple"
+ },
+ "cat.component_templates-h": {
+ "in": "query",
+ "name": "h",
+ "description": "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `name` (or `n`): The name of the component template.\n - `version` (or `v`): The version number of the component template.\n - `alias_count` (or `a`): The number of aliases in the component template.\n - `mapping_count` (or `m`): The number of mappings in the component template.\n - `settings_count` (or `s`): The number of settings in the component template.\n - `metadata_count` (or `me`): The number of metadata entries in the component template.\n - `included_in` (or `i`): The index templates that include this component template.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/cat._types.CatComponentColumns"
+ },
+ "style": "form"
+ },
+ "cat.component_templates-s": {
+ "in": "query",
+ "name": "s",
+ "description": "List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Names"
+ },
+ "style": "form"
+ },
+ "cat.component_templates-local": {
+ "in": "query",
+ "name": "local",
+ "description": "If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "cat.component_templates-master_timeout": {
+ "in": "query",
+ "name": "master_timeout",
+ "description": "The period to wait for a connection to the master node.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "cat.count-index": {
+ "in": "path",
+ "name": "index",
+ "description": "A comma-separated list of data streams, indices, and aliases used to limit the request.\nIt supports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ "cat.count-h": {
+ "in": "query",
+ "name": "h",
+ "description": "A comma-separated list of columns names to display. It supports simple wildcards.\n\nSupported values include:\n - `epoch` (or `t`, `time`): The Unix epoch time in seconds since 1970-01-01 00:00:00.\n - `timestamp` (or `ts`, `hms`, `hhmmss`): The current time in HH:MM:SS format.\n - `count` (or `dc`, `docs.count`, `docsCount`): The document count in the cluster or index.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/cat._types.CatCountColumns"
+ },
+ "style": "form"
+ },
+ "cat.count-s": {
+ "in": "query",
+ "name": "s",
+ "description": "List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Names"
+ },
+ "style": "form"
+ },
+ "cat.indices-index": {
+ "in": "path",
+ "name": "index",
+ "description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ "cat.indices-bytes": {
+ "in": "query",
+ "name": "bytes",
+ "description": "The unit used to display byte values.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Bytes"
+ },
+ "style": "form"
+ },
+ "cat.indices-expand_wildcards": {
+ "in": "query",
+ "name": "expand_wildcards",
+ "description": "The type of index that wildcard patterns can match.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ExpandWildcards"
+ },
+ "style": "form"
+ },
+ "cat.indices-health": {
+ "in": "query",
+ "name": "health",
+ "description": "The health status used to limit returned indices. By default, the response includes indices of any health status.\n\nSupported values include:\n - `green` (or `GREEN`): All shards are assigned.\n - `yellow` (or `YELLOW`): All primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data could be unavailable until that node is repaired.\n - `red` (or `RED`): One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned.\n - `unknown`\n - `unavailable`\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.HealthStatus"
+ },
+ "style": "form"
+ },
+ "cat.indices-include_unloaded_segments": {
+ "in": "query",
+ "name": "include_unloaded_segments",
+ "description": "If true, the response includes information from segments that are not loaded into memory.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "cat.indices-pri": {
+ "in": "query",
+ "name": "pri",
+ "description": "If true, the response only includes information from primary shards.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "cat.indices-time": {
+ "in": "query",
+ "name": "time",
+ "description": "The unit used to display time values.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.TimeUnit"
+ },
+ "style": "form"
+ },
+ "cat.indices-master_timeout": {
+ "in": "query",
+ "name": "master_timeout",
+ "description": "Period to wait for a connection to the master node.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "cat.indices-h": {
+ "in": "query",
+ "name": "h",
+ "description": "List of columns to appear in the response. Supports simple wildcards.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Names"
+ },
+ "style": "form"
+ },
+ "cat.indices-s": {
+ "in": "query",
+ "name": "s",
+ "description": "List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Names"
+ },
+ "style": "form"
+ },
+ "cat.ml_data_frame_analytics-id": {
+ "in": "path",
+ "name": "id",
+ "description": "The ID of the data frame analytics to fetch",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "cat.ml_data_frame_analytics-allow_no_match": {
+ "in": "query",
+ "name": "allow_no_match",
+ "description": "Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified)",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "cat.ml_data_frame_analytics-bytes": {
+ "in": "query",
+ "name": "bytes",
+ "description": "The unit in which to display byte values",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Bytes"
+ },
+ "style": "form"
+ },
+ "cat.ml_data_frame_analytics-h": {
+ "in": "query",
+ "name": "h",
+ "description": "Comma-separated list of column names to display.\n\nSupported values include:\n - `assignment_explanation` (or `ae`): Contains messages relating to the selection of a node.\n - `create_time` (or `ct`, `createTime`): The time when the data frame analytics job was created.\n - `description` (or `d`): A description of a job.\n - `dest_index` (or `di`, `destIndex`): Name of the destination index.\n - `failure_reason` (or `fr`, `failureReason`): Contains messages about the reason why a data frame analytics job failed.\n - `id`: Identifier for the data frame analytics job.\n - `model_memory_limit` (or `mml`, `modelMemoryLimit`): The approximate maximum amount of memory resources that are permitted for\nthe data frame analytics job.\n - `node.address` (or `na`, `nodeAddress`): The network address of the node that the data frame analytics job is\nassigned to.\n - `node.ephemeral_id` (or `ne`, `nodeEphemeralId`): The ephemeral ID of the node that the data frame analytics job is assigned\nto.\n - `node.id` (or `ni`, `nodeId`): The unique identifier of the node that the data frame analytics job is\nassigned to.\n - `node.name` (or `nn`, `nodeName`): The name of the node that the data frame analytics job is assigned to.\n - `progress` (or `p`): The progress report of the data frame analytics job by phase.\n - `source_index` (or `si`, `sourceIndex`): Name of the source index.\n - `state` (or `s`): Current state of the data frame analytics job.\n - `type` (or `t`): The type of analysis that the data frame analytics job performs.\n - `version` (or `v`): The Elasticsearch version number in which the data frame analytics job was\ncreated.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/cat._types.CatDfaColumns"
+ },
+ "style": "form"
+ },
+ "cat.ml_data_frame_analytics-s": {
+ "in": "query",
+ "name": "s",
+ "description": "Comma-separated list of column names or column aliases used to sort the\nresponse.\n\nSupported values include:\n - `assignment_explanation` (or `ae`): Contains messages relating to the selection of a node.\n - `create_time` (or `ct`, `createTime`): The time when the data frame analytics job was created.\n - `description` (or `d`): A description of a job.\n - `dest_index` (or `di`, `destIndex`): Name of the destination index.\n - `failure_reason` (or `fr`, `failureReason`): Contains messages about the reason why a data frame analytics job failed.\n - `id`: Identifier for the data frame analytics job.\n - `model_memory_limit` (or `mml`, `modelMemoryLimit`): The approximate maximum amount of memory resources that are permitted for\nthe data frame analytics job.\n - `node.address` (or `na`, `nodeAddress`): The network address of the node that the data frame analytics job is\nassigned to.\n - `node.ephemeral_id` (or `ne`, `nodeEphemeralId`): The ephemeral ID of the node that the data frame analytics job is assigned\nto.\n - `node.id` (or `ni`, `nodeId`): The unique identifier of the node that the data frame analytics job is\nassigned to.\n - `node.name` (or `nn`, `nodeName`): The name of the node that the data frame analytics job is assigned to.\n - `progress` (or `p`): The progress report of the data frame analytics job by phase.\n - `source_index` (or `si`, `sourceIndex`): Name of the source index.\n - `state` (or `s`): Current state of the data frame analytics job.\n - `type` (or `t`): The type of analysis that the data frame analytics job performs.\n - `version` (or `v`): The Elasticsearch version number in which the data frame analytics job was\ncreated.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/cat._types.CatDfaColumns"
+ },
+ "style": "form"
+ },
+ "cat.ml_data_frame_analytics-time": {
+ "in": "query",
+ "name": "time",
+ "description": "Unit used to display time values.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.TimeUnit"
+ },
+ "style": "form"
+ },
+ "cat.ml_datafeeds-datafeed_id": {
+ "in": "path",
+ "name": "datafeed_id",
+ "description": "A numerical character string that uniquely identifies the datafeed.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "cat.ml_datafeeds-allow_no_match": {
+ "in": "query",
+ "name": "allow_no_match",
+ "description": "Specifies what to do when the request:\n\n* Contains wildcard expressions and there are no datafeeds that match.\n* Contains the `_all` string or no identifiers and there are no matches.\n* Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when\nthere are partial matches. If `false`, the API returns a 404 status code when there are no matches or only\npartial matches.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "cat.ml_datafeeds-h": {
+ "in": "query",
+ "name": "h",
+ "description": "Comma-separated list of column names to display.\n\nSupported values include:\n - `ae` (or `assignment_explanation`): For started datafeeds only, contains messages relating to the selection of\na node.\n - `bc` (or `buckets.count`, `bucketsCount`): The number of buckets processed.\n - `id`: A numerical character string that uniquely identifies the datafeed.\n - `na` (or `node.address`, `nodeAddress`): For started datafeeds only, the network address of the node where the\ndatafeed is started.\n - `ne` (or `node.ephemeral_id`, `nodeEphemeralId`): For started datafeeds only, the ephemeral ID of the node where the\ndatafeed is started.\n - `ni` (or `node.id`, `nodeId`): For started datafeeds only, the unique identifier of the node where the\ndatafeed is started.\n - `nn` (or `node.name`, `nodeName`): For started datafeeds only, the name of the node where the datafeed is\nstarted.\n - `sba` (or `search.bucket_avg`, `searchBucketAvg`): The average search time per bucket, in milliseconds.\n - `sc` (or `search.count`, `searchCount`): The number of searches run by the datafeed.\n - `seah` (or `search.exp_avg_hour`, `searchExpAvgHour`): The exponential average search time per hour, in milliseconds.\n - `st` (or `search.time`, `searchTime`): The total time the datafeed spent searching, in milliseconds.\n - `s` (or `state`): The status of the datafeed: `starting`, `started`, `stopping`, or `stopped`.\nIf `starting`, the datafeed has been requested to start but has not yet\nstarted. If `started`, the datafeed is actively receiving data. If\n`stopping`, the datafeed has been requested to stop gracefully and is\ncompleting its final action. If `stopped`, the datafeed is stopped and will\nnot receive data until it is re-started.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/cat._types.CatDatafeedColumns"
+ },
+ "style": "form"
+ },
+ "cat.ml_datafeeds-s": {
+ "in": "query",
+ "name": "s",
+ "description": "Comma-separated list of column names or column aliases used to sort the response.\n\nSupported values include:\n - `ae` (or `assignment_explanation`): For started datafeeds only, contains messages relating to the selection of\na node.\n - `bc` (or `buckets.count`, `bucketsCount`): The number of buckets processed.\n - `id`: A numerical character string that uniquely identifies the datafeed.\n - `na` (or `node.address`, `nodeAddress`): For started datafeeds only, the network address of the node where the\ndatafeed is started.\n - `ne` (or `node.ephemeral_id`, `nodeEphemeralId`): For started datafeeds only, the ephemeral ID of the node where the\ndatafeed is started.\n - `ni` (or `node.id`, `nodeId`): For started datafeeds only, the unique identifier of the node where the\ndatafeed is started.\n - `nn` (or `node.name`, `nodeName`): For started datafeeds only, the name of the node where the datafeed is\nstarted.\n - `sba` (or `search.bucket_avg`, `searchBucketAvg`): The average search time per bucket, in milliseconds.\n - `sc` (or `search.count`, `searchCount`): The number of searches run by the datafeed.\n - `seah` (or `search.exp_avg_hour`, `searchExpAvgHour`): The exponential average search time per hour, in milliseconds.\n - `st` (or `search.time`, `searchTime`): The total time the datafeed spent searching, in milliseconds.\n - `s` (or `state`): The status of the datafeed: `starting`, `started`, `stopping`, or `stopped`.\nIf `starting`, the datafeed has been requested to start but has not yet\nstarted. If `started`, the datafeed is actively receiving data. If\n`stopping`, the datafeed has been requested to stop gracefully and is\ncompleting its final action. If `stopped`, the datafeed is stopped and will\nnot receive data until it is re-started.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/cat._types.CatDatafeedColumns"
+ },
+ "style": "form"
+ },
+ "cat.ml_datafeeds-time": {
+ "in": "query",
+ "name": "time",
+ "description": "The unit used to display time values.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.TimeUnit"
+ },
+ "style": "form"
+ },
+ "cat.ml_jobs-job_id": {
+ "in": "path",
+ "name": "job_id",
+ "description": "Identifier for the anomaly detection job.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "cat.ml_jobs-allow_no_match": {
+ "in": "query",
+ "name": "allow_no_match",
+ "description": "Specifies what to do when the request:\n\n* Contains wildcard expressions and there are no jobs that match.\n* Contains the `_all` string or no identifiers and there are no matches.\n* Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty jobs array when there are no matches and the subset of results when there\nare partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial\nmatches.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "cat.ml_jobs-bytes": {
+ "in": "query",
+ "name": "bytes",
+ "description": "The unit used to display byte values.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Bytes"
+ },
+ "style": "form"
+ },
+ "cat.ml_jobs-h": {
+ "in": "query",
+ "name": "h",
+ "description": "Comma-separated list of column names to display.\n\nSupported values include:\n - `assignment_explanation` (or `ae`): For open anomaly detection jobs only, contains messages relating to the\nselection of a node to run the job.\n - `buckets.count` (or `bc`, `bucketsCount`): The number of bucket results produced by the job.\n - `buckets.time.exp_avg` (or `btea`, `bucketsTimeExpAvg`): Exponential moving average of all bucket processing times, in milliseconds.\n - `buckets.time.exp_avg_hour` (or `bteah`, `bucketsTimeExpAvgHour`): Exponentially-weighted moving average of bucket processing times calculated\nin a 1 hour time window, in milliseconds.\n - `buckets.time.max` (or `btmax`, `bucketsTimeMax`): Maximum among all bucket processing times, in milliseconds.\n - `buckets.time.min` (or `btmin`, `bucketsTimeMin`): Minimum among all bucket processing times, in milliseconds.\n - `buckets.time.total` (or `btt`, `bucketsTimeTotal`): Sum of all bucket processing times, in milliseconds.\n - `data.buckets` (or `db`, `dataBuckets`): The number of buckets processed.\n - `data.earliest_record` (or `der`, `dataEarliestRecord`): The timestamp of the earliest chronologically input document.\n - `data.empty_buckets` (or `deb`, `dataEmptyBuckets`): The number of buckets which did not contain any data.\n - `data.input_bytes` (or `dib`, `dataInputBytes`): The number of bytes of input data posted to the anomaly detection job.\n - `data.input_fields` (or `dif`, `dataInputFields`): The total number of fields in input documents posted to the anomaly\ndetection job. This count includes fields that are not used in the analysis.\nHowever, be aware that if you are using a datafeed, it extracts only the\nrequired fields from the documents it retrieves before posting them to the job.\n - `data.input_records` (or `dir`, `dataInputRecords`): The number of input documents posted to the anomaly detection job.\n - `data.invalid_dates` (or `did`, `dataInvalidDates`): The number of input documents with either a missing date field or a date\nthat could not be parsed.\n - `data.last` (or `dl`, `dataLast`): The timestamp at which data was last analyzed, according to server time.\n - `data.last_empty_bucket` (or `dleb`, `dataLastEmptyBucket`): The timestamp of the last bucket that did not contain any data.\n - `data.last_sparse_bucket` (or `dlsb`, `dataLastSparseBucket`): The timestamp of the last bucket that was considered sparse.\n - `data.latest_record` (or `dlr`, `dataLatestRecord`): The timestamp of the latest chronologically input document.\n - `data.missing_fields` (or `dmf`, `dataMissingFields`): The number of input documents that are missing a field that the anomaly\ndetection job is configured to analyze. Input documents with missing fields\nare still processed because it is possible that not all fields are missing.\n - `data.out_of_order_timestamps` (or `doot`, `dataOutOfOrderTimestamps`): The number of input documents that have a timestamp chronologically\npreceding the start of the current anomaly detection bucket offset by the\nlatency window. This information is applicable only when you provide data\nto the anomaly detection job by using the post data API. These out of order\ndocuments are discarded, since jobs require time series data to be in\nascending chronological order.\n - `data.processed_fields` (or `dpf`, `dataProcessedFields`): The total number of fields in all the documents that have been processed by\nthe anomaly detection job. Only fields that are specified in the detector\nconfiguration object contribute to this count. The timestamp is not\nincluded in this count.\n - `data.processed_records` (or `dpr`, `dataProcessedRecords`): The number of input documents that have been processed by the anomaly\ndetection job. This value includes documents with missing fields, since\nthey are nonetheless analyzed. If you use datafeeds and have aggregations\nin your search query, the processed record count is the number of\naggregation results processed, not the number of Elasticsearch documents.\n - `data.sparse_buckets` (or `dsb`, `dataSparseBuckets`): The number of buckets that contained few data points compared to the\nexpected number of data points.\n - `forecasts.memory.avg` (or `fmavg`, `forecastsMemoryAvg`): The average memory usage in bytes for forecasts related to the anomaly\ndetection job.\n - `forecasts.memory.max` (or `fmmax`, `forecastsMemoryMax`): The maximum memory usage in bytes for forecasts related to the anomaly\ndetection job.\n - `forecasts.memory.min` (or `fmmin`, `forecastsMemoryMin`): The minimum memory usage in bytes for forecasts related to the anomaly\ndetection job.\n - `forecasts.memory.total` (or `fmt`, `forecastsMemoryTotal`): The total memory usage in bytes for forecasts related to the anomaly\ndetection job.\n - `forecasts.records.avg` (or `fravg`, `forecastsRecordsAvg`): The average number of `m`odel_forecast` documents written for forecasts\nrelated to the anomaly detection job.\n - `forecasts.records.max` (or `frmax`, `forecastsRecordsMax`): The maximum number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.\n - `forecasts.records.min` (or `frmin`, `forecastsRecordsMin`): The minimum number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.\n - `forecasts.records.total` (or `frt`, `forecastsRecordsTotal`): The total number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.\n - `forecasts.time.avg` (or `ftavg`, `forecastsTimeAvg`): The average runtime in milliseconds for forecasts related to the anomaly\ndetection job.\n - `forecasts.time.max` (or `ftmax`, `forecastsTimeMax`): The maximum runtime in milliseconds for forecasts related to the anomaly\ndetection job.\n - `forecasts.time.min` (or `ftmin`, `forecastsTimeMin`): The minimum runtime in milliseconds for forecasts related to the anomaly\ndetection job.\n - `forecasts.time.total` (or `ftt`, `forecastsTimeTotal`): The total runtime in milliseconds for forecasts related to the anomaly\ndetection job.\n - `forecasts.total` (or `ft`, `forecastsTotal`): The number of individual forecasts currently available for the job.\n - `id`: Identifier for the anomaly detection job.\n - `model.bucket_allocation_failures` (or `mbaf`, `modelBucketAllocationFailures`): The number of buckets for which new entities in incoming data were not\nprocessed due to insufficient model memory.\n - `model.by_fields` (or `mbf`, `modelByFields`): The number of by field values that were analyzed by the models. This value\nis cumulative for all detectors in the job.\n - `model.bytes` (or `mb`, `modelBytes`): The number of bytes of memory used by the models. This is the maximum value\nsince the last time the model was persisted. If the job is closed, this\nvalue indicates the latest size.\n - `model.bytes_exceeded` (or `mbe`, `modelBytesExceeded`): The number of bytes over the high limit for memory usage at the last\nallocation failure.\n - `model.categorization_status` (or `mcs`, `modelCategorizationStatus`): The status of categorization for the job: `ok` or `warn`. If `ok`,\ncategorization is performing acceptably well (or not being used at all). If\n`warn`, categorization is detecting a distribution of categories that\nsuggests the input data is inappropriate for categorization. Problems could\nbe that there is only one category, more than 90% of categories are rare,\nthe number of categories is greater than 50% of the number of categorized\ndocuments, there are no frequently matched categories, or more than 50% of\ncategories are dead.\n - `model.categorized_doc_count` (or `mcdc`, `modelCategorizedDocCount`): The number of documents that have had a field categorized.\n - `model.dead_category_count` (or `mdcc`, `modelDeadCategoryCount`): The number of categories created by categorization that will never be\nassigned again because another category’s definition makes it a superset of\nthe dead category. Dead categories are a side effect of the way\ncategorization has no prior training.\n - `model.failed_category_count` (or `mdcc`, `modelFailedCategoryCount`): The number of times that categorization wanted to create a new category but\ncouldn’t because the job had hit its model memory limit. This count does\nnot track which specific categories failed to be created. Therefore, you\ncannot use this value to determine the number of unique categories that\nwere missed.\n - `model.frequent_category_count` (or `mfcc`, `modelFrequentCategoryCount`): The number of categories that match more than 1% of categorized documents.\n - `model.log_time` (or `mlt`, `modelLogTime`): The timestamp when the model stats were gathered, according to server time.\n - `model.memory_limit` (or `mml`, `modelMemoryLimit`): The timestamp when the model stats were gathered, according to server time.\n - `model.memory_status` (or `mms`, `modelMemoryStatus`): The status of the mathematical models: `ok`, `soft_limit`, or `hard_limit`.\nIf `ok`, the models stayed below the configured value. If `soft_limit`, the\nmodels used more than 60% of the configured memory limit and older unused\nmodels will be pruned to free up space. Additionally, in categorization jobs\nno further category examples will be stored. If `hard_limit`, the models\nused more space than the configured memory limit. As a result, not all\nincoming data was processed.\n - `model.over_fields` (or `mof`, `modelOverFields`): The number of over field values that were analyzed by the models. This\nvalue is cumulative for all detectors in the job.\n - `model.partition_fields` (or `mpf`, `modelPartitionFields`): The number of partition field values that were analyzed by the models. This\nvalue is cumulative for all detectors in the job.\n - `model.rare_category_count` (or `mrcc`, `modelRareCategoryCount`): The number of categories that match just one categorized document.\n - `model.timestamp` (or `mt`, `modelTimestamp`): The timestamp of the last record when the model stats were gathered.\n - `model.total_category_count` (or `mtcc`, `modelTotalCategoryCount`): The number of categories created by categorization.\n - `node.address` (or `na`, `nodeAddress`): The network address of the node that runs the job. This information is\navailable only for open jobs.\n - `node.ephemeral_id` (or `ne`, `nodeEphemeralId`): The ephemeral ID of the node that runs the job. This information is\navailable only for open jobs.\n - `node.id` (or `ni`, `nodeId`): The unique identifier of the node that runs the job. This information is\navailable only for open jobs.\n - `node.name` (or `nn`, `nodeName`): The name of the node that runs the job. This information is available only\nfor open jobs.\n - `opened_time` (or `ot`): For open jobs only, the elapsed time for which the job has been open.\n - `state` (or `s`): The status of the anomaly detection job: `closed`, `closing`, `failed`,\n`opened`, or `opening`. If `closed`, the job finished successfully with its\nmodel state persisted. The job must be opened before it can accept further\ndata. If `closing`, the job close action is in progress and has not yet\ncompleted. A closing job cannot accept further data. If `failed`, the job\ndid not finish successfully due to an error. This situation can occur due\nto invalid input data, a fatal error occurring during the analysis, or an\nexternal interaction such as the process being killed by the Linux out of\nmemory (OOM) killer. If the job had irrevocably failed, it must be force\nclosed and then deleted. If the datafeed can be corrected, the job can be\nclosed and then re-opened. If `opened`, the job is available to receive and\nprocess data. If `opening`, the job open action is in progress and has not\nyet completed.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/cat._types.CatAnomalyDetectorColumns"
+ },
+ "style": "form"
+ },
+ "cat.ml_jobs-s": {
+ "in": "query",
+ "name": "s",
+ "description": "Comma-separated list of column names or column aliases used to sort the response.\n\nSupported values include:\n - `assignment_explanation` (or `ae`): For open anomaly detection jobs only, contains messages relating to the\nselection of a node to run the job.\n - `buckets.count` (or `bc`, `bucketsCount`): The number of bucket results produced by the job.\n - `buckets.time.exp_avg` (or `btea`, `bucketsTimeExpAvg`): Exponential moving average of all bucket processing times, in milliseconds.\n - `buckets.time.exp_avg_hour` (or `bteah`, `bucketsTimeExpAvgHour`): Exponentially-weighted moving average of bucket processing times calculated\nin a 1 hour time window, in milliseconds.\n - `buckets.time.max` (or `btmax`, `bucketsTimeMax`): Maximum among all bucket processing times, in milliseconds.\n - `buckets.time.min` (or `btmin`, `bucketsTimeMin`): Minimum among all bucket processing times, in milliseconds.\n - `buckets.time.total` (or `btt`, `bucketsTimeTotal`): Sum of all bucket processing times, in milliseconds.\n - `data.buckets` (or `db`, `dataBuckets`): The number of buckets processed.\n - `data.earliest_record` (or `der`, `dataEarliestRecord`): The timestamp of the earliest chronologically input document.\n - `data.empty_buckets` (or `deb`, `dataEmptyBuckets`): The number of buckets which did not contain any data.\n - `data.input_bytes` (or `dib`, `dataInputBytes`): The number of bytes of input data posted to the anomaly detection job.\n - `data.input_fields` (or `dif`, `dataInputFields`): The total number of fields in input documents posted to the anomaly\ndetection job. This count includes fields that are not used in the analysis.\nHowever, be aware that if you are using a datafeed, it extracts only the\nrequired fields from the documents it retrieves before posting them to the job.\n - `data.input_records` (or `dir`, `dataInputRecords`): The number of input documents posted to the anomaly detection job.\n - `data.invalid_dates` (or `did`, `dataInvalidDates`): The number of input documents with either a missing date field or a date\nthat could not be parsed.\n - `data.last` (or `dl`, `dataLast`): The timestamp at which data was last analyzed, according to server time.\n - `data.last_empty_bucket` (or `dleb`, `dataLastEmptyBucket`): The timestamp of the last bucket that did not contain any data.\n - `data.last_sparse_bucket` (or `dlsb`, `dataLastSparseBucket`): The timestamp of the last bucket that was considered sparse.\n - `data.latest_record` (or `dlr`, `dataLatestRecord`): The timestamp of the latest chronologically input document.\n - `data.missing_fields` (or `dmf`, `dataMissingFields`): The number of input documents that are missing a field that the anomaly\ndetection job is configured to analyze. Input documents with missing fields\nare still processed because it is possible that not all fields are missing.\n - `data.out_of_order_timestamps` (or `doot`, `dataOutOfOrderTimestamps`): The number of input documents that have a timestamp chronologically\npreceding the start of the current anomaly detection bucket offset by the\nlatency window. This information is applicable only when you provide data\nto the anomaly detection job by using the post data API. These out of order\ndocuments are discarded, since jobs require time series data to be in\nascending chronological order.\n - `data.processed_fields` (or `dpf`, `dataProcessedFields`): The total number of fields in all the documents that have been processed by\nthe anomaly detection job. Only fields that are specified in the detector\nconfiguration object contribute to this count. The timestamp is not\nincluded in this count.\n - `data.processed_records` (or `dpr`, `dataProcessedRecords`): The number of input documents that have been processed by the anomaly\ndetection job. This value includes documents with missing fields, since\nthey are nonetheless analyzed. If you use datafeeds and have aggregations\nin your search query, the processed record count is the number of\naggregation results processed, not the number of Elasticsearch documents.\n - `data.sparse_buckets` (or `dsb`, `dataSparseBuckets`): The number of buckets that contained few data points compared to the\nexpected number of data points.\n - `forecasts.memory.avg` (or `fmavg`, `forecastsMemoryAvg`): The average memory usage in bytes for forecasts related to the anomaly\ndetection job.\n - `forecasts.memory.max` (or `fmmax`, `forecastsMemoryMax`): The maximum memory usage in bytes for forecasts related to the anomaly\ndetection job.\n - `forecasts.memory.min` (or `fmmin`, `forecastsMemoryMin`): The minimum memory usage in bytes for forecasts related to the anomaly\ndetection job.\n - `forecasts.memory.total` (or `fmt`, `forecastsMemoryTotal`): The total memory usage in bytes for forecasts related to the anomaly\ndetection job.\n - `forecasts.records.avg` (or `fravg`, `forecastsRecordsAvg`): The average number of `m`odel_forecast` documents written for forecasts\nrelated to the anomaly detection job.\n - `forecasts.records.max` (or `frmax`, `forecastsRecordsMax`): The maximum number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.\n - `forecasts.records.min` (or `frmin`, `forecastsRecordsMin`): The minimum number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.\n - `forecasts.records.total` (or `frt`, `forecastsRecordsTotal`): The total number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.\n - `forecasts.time.avg` (or `ftavg`, `forecastsTimeAvg`): The average runtime in milliseconds for forecasts related to the anomaly\ndetection job.\n - `forecasts.time.max` (or `ftmax`, `forecastsTimeMax`): The maximum runtime in milliseconds for forecasts related to the anomaly\ndetection job.\n - `forecasts.time.min` (or `ftmin`, `forecastsTimeMin`): The minimum runtime in milliseconds for forecasts related to the anomaly\ndetection job.\n - `forecasts.time.total` (or `ftt`, `forecastsTimeTotal`): The total runtime in milliseconds for forecasts related to the anomaly\ndetection job.\n - `forecasts.total` (or `ft`, `forecastsTotal`): The number of individual forecasts currently available for the job.\n - `id`: Identifier for the anomaly detection job.\n - `model.bucket_allocation_failures` (or `mbaf`, `modelBucketAllocationFailures`): The number of buckets for which new entities in incoming data were not\nprocessed due to insufficient model memory.\n - `model.by_fields` (or `mbf`, `modelByFields`): The number of by field values that were analyzed by the models. This value\nis cumulative for all detectors in the job.\n - `model.bytes` (or `mb`, `modelBytes`): The number of bytes of memory used by the models. This is the maximum value\nsince the last time the model was persisted. If the job is closed, this\nvalue indicates the latest size.\n - `model.bytes_exceeded` (or `mbe`, `modelBytesExceeded`): The number of bytes over the high limit for memory usage at the last\nallocation failure.\n - `model.categorization_status` (or `mcs`, `modelCategorizationStatus`): The status of categorization for the job: `ok` or `warn`. If `ok`,\ncategorization is performing acceptably well (or not being used at all). If\n`warn`, categorization is detecting a distribution of categories that\nsuggests the input data is inappropriate for categorization. Problems could\nbe that there is only one category, more than 90% of categories are rare,\nthe number of categories is greater than 50% of the number of categorized\ndocuments, there are no frequently matched categories, or more than 50% of\ncategories are dead.\n - `model.categorized_doc_count` (or `mcdc`, `modelCategorizedDocCount`): The number of documents that have had a field categorized.\n - `model.dead_category_count` (or `mdcc`, `modelDeadCategoryCount`): The number of categories created by categorization that will never be\nassigned again because another category’s definition makes it a superset of\nthe dead category. Dead categories are a side effect of the way\ncategorization has no prior training.\n - `model.failed_category_count` (or `mdcc`, `modelFailedCategoryCount`): The number of times that categorization wanted to create a new category but\ncouldn’t because the job had hit its model memory limit. This count does\nnot track which specific categories failed to be created. Therefore, you\ncannot use this value to determine the number of unique categories that\nwere missed.\n - `model.frequent_category_count` (or `mfcc`, `modelFrequentCategoryCount`): The number of categories that match more than 1% of categorized documents.\n - `model.log_time` (or `mlt`, `modelLogTime`): The timestamp when the model stats were gathered, according to server time.\n - `model.memory_limit` (or `mml`, `modelMemoryLimit`): The timestamp when the model stats were gathered, according to server time.\n - `model.memory_status` (or `mms`, `modelMemoryStatus`): The status of the mathematical models: `ok`, `soft_limit`, or `hard_limit`.\nIf `ok`, the models stayed below the configured value. If `soft_limit`, the\nmodels used more than 60% of the configured memory limit and older unused\nmodels will be pruned to free up space. Additionally, in categorization jobs\nno further category examples will be stored. If `hard_limit`, the models\nused more space than the configured memory limit. As a result, not all\nincoming data was processed.\n - `model.over_fields` (or `mof`, `modelOverFields`): The number of over field values that were analyzed by the models. This\nvalue is cumulative for all detectors in the job.\n - `model.partition_fields` (or `mpf`, `modelPartitionFields`): The number of partition field values that were analyzed by the models. This\nvalue is cumulative for all detectors in the job.\n - `model.rare_category_count` (or `mrcc`, `modelRareCategoryCount`): The number of categories that match just one categorized document.\n - `model.timestamp` (or `mt`, `modelTimestamp`): The timestamp of the last record when the model stats were gathered.\n - `model.total_category_count` (or `mtcc`, `modelTotalCategoryCount`): The number of categories created by categorization.\n - `node.address` (or `na`, `nodeAddress`): The network address of the node that runs the job. This information is\navailable only for open jobs.\n - `node.ephemeral_id` (or `ne`, `nodeEphemeralId`): The ephemeral ID of the node that runs the job. This information is\navailable only for open jobs.\n - `node.id` (or `ni`, `nodeId`): The unique identifier of the node that runs the job. This information is\navailable only for open jobs.\n - `node.name` (or `nn`, `nodeName`): The name of the node that runs the job. This information is available only\nfor open jobs.\n - `opened_time` (or `ot`): For open jobs only, the elapsed time for which the job has been open.\n - `state` (or `s`): The status of the anomaly detection job: `closed`, `closing`, `failed`,\n`opened`, or `opening`. If `closed`, the job finished successfully with its\nmodel state persisted. The job must be opened before it can accept further\ndata. If `closing`, the job close action is in progress and has not yet\ncompleted. A closing job cannot accept further data. If `failed`, the job\ndid not finish successfully due to an error. This situation can occur due\nto invalid input data, a fatal error occurring during the analysis, or an\nexternal interaction such as the process being killed by the Linux out of\nmemory (OOM) killer. If the job had irrevocably failed, it must be force\nclosed and then deleted. If the datafeed can be corrected, the job can be\nclosed and then re-opened. If `opened`, the job is available to receive and\nprocess data. If `opening`, the job open action is in progress and has not\nyet completed.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/cat._types.CatAnomalyDetectorColumns"
+ },
+ "style": "form"
+ },
+ "cat.ml_jobs-time": {
+ "in": "query",
+ "name": "time",
+ "description": "The unit used to display time values.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.TimeUnit"
+ },
+ "style": "form"
+ },
+ "cat.ml_trained_models-model_id": {
+ "in": "path",
+ "name": "model_id",
+ "description": "A unique identifier for the trained model.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "cat.ml_trained_models-allow_no_match": {
+ "in": "query",
+ "name": "allow_no_match",
+ "description": "Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches.\nIf `true`, the API returns an empty array when there are no matches and the subset of results when there are partial matches.\nIf `false`, the API returns a 404 status code when there are no matches or only partial matches.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "cat.ml_trained_models-bytes": {
+ "in": "query",
+ "name": "bytes",
+ "description": "The unit used to display byte values.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Bytes"
+ },
+ "style": "form"
+ },
+ "cat.ml_trained_models-h": {
+ "in": "query",
+ "name": "h",
+ "description": "A comma-separated list of column names to display.\n\nSupported values include:\n - `create_time` (or `ct`): The time when the trained model was created.\n - `created_by` (or `c`, `createdBy`): Information on the creator of the trained model.\n - `data_frame_analytics_id` (or `df`, `dataFrameAnalytics`, `dfid`): Identifier for the data frame analytics job that created the model. Only\ndisplayed if it is still available.\n - `description` (or `d`): The description of the trained model.\n - `heap_size` (or `hs`, `modelHeapSize`): The estimated heap size to keep the trained model in memory.\n - `id`: Identifier for the trained model.\n - `ingest.count` (or `ic`, `ingestCount`): The total number of documents that are processed by the model.\n - `ingest.current` (or `icurr`, `ingestCurrent`): The total number of document that are currently being handled by the\ntrained model.\n - `ingest.failed` (or `if`, `ingestFailed`): The total number of failed ingest attempts with the trained model.\n - `ingest.pipelines` (or `ip`, `ingestPipelines`): The total number of ingest pipelines that are referencing the trained\nmodel.\n - `ingest.time` (or `it`, `ingestTime`): The total time that is spent processing documents with the trained model.\n - `license` (or `l`): The license level of the trained model.\n - `operations` (or `o`, `modelOperations`): The estimated number of operations to use the trained model. This number\nhelps measuring the computational complexity of the model.\n - `version` (or `v`): The Elasticsearch version number in which the trained model was created.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/cat._types.CatTrainedModelsColumns"
+ },
+ "style": "form"
+ },
+ "cat.ml_trained_models-s": {
+ "in": "query",
+ "name": "s",
+ "description": "A comma-separated list of column names or aliases used to sort the response.\n\nSupported values include:\n - `create_time` (or `ct`): The time when the trained model was created.\n - `created_by` (or `c`, `createdBy`): Information on the creator of the trained model.\n - `data_frame_analytics_id` (or `df`, `dataFrameAnalytics`, `dfid`): Identifier for the data frame analytics job that created the model. Only\ndisplayed if it is still available.\n - `description` (or `d`): The description of the trained model.\n - `heap_size` (or `hs`, `modelHeapSize`): The estimated heap size to keep the trained model in memory.\n - `id`: Identifier for the trained model.\n - `ingest.count` (or `ic`, `ingestCount`): The total number of documents that are processed by the model.\n - `ingest.current` (or `icurr`, `ingestCurrent`): The total number of document that are currently being handled by the\ntrained model.\n - `ingest.failed` (or `if`, `ingestFailed`): The total number of failed ingest attempts with the trained model.\n - `ingest.pipelines` (or `ip`, `ingestPipelines`): The total number of ingest pipelines that are referencing the trained\nmodel.\n - `ingest.time` (or `it`, `ingestTime`): The total time that is spent processing documents with the trained model.\n - `license` (or `l`): The license level of the trained model.\n - `operations` (or `o`, `modelOperations`): The estimated number of operations to use the trained model. This number\nhelps measuring the computational complexity of the model.\n - `version` (or `v`): The Elasticsearch version number in which the trained model was created.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/cat._types.CatTrainedModelsColumns"
+ },
+ "style": "form"
+ },
+ "cat.ml_trained_models-from": {
+ "in": "query",
+ "name": "from",
+ "description": "Skips the specified number of transforms.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "cat.ml_trained_models-size": {
+ "in": "query",
+ "name": "size",
+ "description": "The maximum number of transforms to display.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "cat.ml_trained_models-time": {
+ "in": "query",
+ "name": "time",
+ "description": "Unit used to display time values.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.TimeUnit"
+ },
+ "style": "form"
+ },
+ "cat.transforms-transform_id": {
+ "in": "path",
+ "name": "transform_id",
+ "description": "A transform identifier or a wildcard expression.\nIf you do not specify one of these options, the API returns information for all transforms.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "cat.transforms-allow_no_match": {
+ "in": "query",
+ "name": "allow_no_match",
+ "description": "Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches.\nIf `true`, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches.\nIf `false`, the request returns a 404 status code when there are no matches or only partial matches.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "cat.transforms-from": {
+ "in": "query",
+ "name": "from",
+ "description": "Skips the specified number of transforms.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "cat.transforms-h": {
+ "in": "query",
+ "name": "h",
+ "description": "Comma-separated list of column names to display.\n\nSupported values include:\n - `changes_last_detection_time` (or `cldt`): The timestamp when changes were last detected in the source indices.\n - `checkpoint` (or `cp`): The sequence number for the checkpoint.\n - `checkpoint_duration_time_exp_avg` (or `cdtea`, `checkpointTimeExpAvg`): Exponential moving average of the duration of the checkpoint, in\nmilliseconds.\n - `checkpoint_progress` (or `c`, `checkpointProgress`): The progress of the next checkpoint that is currently in progress.\n - `create_time` (or `ct`, `createTime`): The time the transform was created.\n - `delete_time` (or `dtime`): The amount of time spent deleting, in milliseconds.\n - `description` (or `d`): The description of the transform.\n - `dest_index` (or `di`, `destIndex`): The destination index for the transform. The mappings of the destination\nindex are deduced based on the source fields when possible. If alternate\nmappings are required, use the Create index API prior to starting the\ntransform.\n - `documents_deleted` (or `docd`): The number of documents that have been deleted from the destination index\ndue to the retention policy for this transform.\n - `documents_indexed` (or `doci`): The number of documents that have been indexed into the destination index\nfor the transform.\n - `docs_per_second` (or `dps`): Specifies a limit on the number of input documents per second. This setting\nthrottles the transform by adding a wait time between search requests. The\ndefault value is `null`, which disables throttling.\n - `documents_processed` (or `docp`): The number of documents that have been processed from the source index of\nthe transform.\n - `frequency` (or `f`): The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is `1s` and the maximum is `1h`. The default\nvalue is `1m`.\n - `id`: Identifier for the transform.\n - `index_failure` (or `if`): The number of indexing failures.\n - `index_time` (or `itime`): The amount of time spent indexing, in milliseconds.\n - `index_total` (or `it`): The number of index operations.\n - `indexed_documents_exp_avg` (or `idea`): Exponential moving average of the number of new documents that have been\nindexed.\n - `last_search_time` (or `lst`, `lastSearchTime`): The timestamp of the last search in the source indices. This field is only\nshown if the transform is running.\n - `max_page_search_size` (or `mpsz`): Defines the initial page size to use for the composite aggregation for each\ncheckpoint. If circuit breaker exceptions occur, the page size is\ndynamically adjusted to a lower value. The minimum value is `10` and the\nmaximum is `65,536`. The default value is `500`.\n - `pages_processed` (or `pp`): The number of search or bulk index operations processed. Documents are\nprocessed in batches instead of individually.\n - `pipeline` (or `p`): The unique identifier for an ingest pipeline.\n - `processed_documents_exp_avg` (or `pdea`): Exponential moving average of the number of documents that have been\nprocessed.\n - `processing_time` (or `pt`): The amount of time spent processing results, in milliseconds.\n - `reason` (or `r`): If a transform has a `failed` state, this property provides details about\nthe reason for the failure.\n - `search_failure` (or `sf`): The number of search failures.\n - `search_time` (or `stime`): The amount of time spent searching, in milliseconds.\n - `search_total` (or `st`): The number of search operations on the source index for the transform.\n - `source_index` (or `si`, `sourceIndex`): The source indices for the transform. It can be a single index, an index\npattern (for example, `\"my-index-*\"`), an array of indices (for example,\n`[\"my-index-000001\", \"my-index-000002\"]`), or an array of index patterns\n(for example, `[\"my-index-*\", \"my-other-index-*\"]`. For remote indices use\nthe syntax `\"remote_name:index_name\"`. If any indices are in remote\nclusters then the master node and at least one transform node must have the\n`remote_cluster_client` node role.\n - `state` (or `s`): The status of the transform, which can be one of the following values:\n\n* `aborting`: The transform is aborting.\n* `failed`: The transform failed. For more information about the failure,\ncheck the reason field.\n* `indexing`: The transform is actively processing data and creating new\ndocuments.\n* `started`: The transform is running but not actively indexing data.\n* `stopped`: The transform is stopped.\n* `stopping`: The transform is stopping.\n - `transform_type` (or `tt`): Indicates the type of transform: `batch` or `continuous`.\n - `trigger_count` (or `tc`): The number of times the transform has been triggered by the scheduler. For\nexample, the scheduler triggers the transform indexer to check for updates\nor ingest new data at an interval specified in the `frequency` property.\n - `version` (or `v`): The version of Elasticsearch that existed on the node when the transform\nwas created.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/cat._types.CatTransformColumns"
+ },
+ "style": "form"
+ },
+ "cat.transforms-s": {
+ "in": "query",
+ "name": "s",
+ "description": "Comma-separated list of column names or column aliases used to sort the response.\n\nSupported values include:\n - `changes_last_detection_time` (or `cldt`): The timestamp when changes were last detected in the source indices.\n - `checkpoint` (or `cp`): The sequence number for the checkpoint.\n - `checkpoint_duration_time_exp_avg` (or `cdtea`, `checkpointTimeExpAvg`): Exponential moving average of the duration of the checkpoint, in\nmilliseconds.\n - `checkpoint_progress` (or `c`, `checkpointProgress`): The progress of the next checkpoint that is currently in progress.\n - `create_time` (or `ct`, `createTime`): The time the transform was created.\n - `delete_time` (or `dtime`): The amount of time spent deleting, in milliseconds.\n - `description` (or `d`): The description of the transform.\n - `dest_index` (or `di`, `destIndex`): The destination index for the transform. The mappings of the destination\nindex are deduced based on the source fields when possible. If alternate\nmappings are required, use the Create index API prior to starting the\ntransform.\n - `documents_deleted` (or `docd`): The number of documents that have been deleted from the destination index\ndue to the retention policy for this transform.\n - `documents_indexed` (or `doci`): The number of documents that have been indexed into the destination index\nfor the transform.\n - `docs_per_second` (or `dps`): Specifies a limit on the number of input documents per second. This setting\nthrottles the transform by adding a wait time between search requests. The\ndefault value is `null`, which disables throttling.\n - `documents_processed` (or `docp`): The number of documents that have been processed from the source index of\nthe transform.\n - `frequency` (or `f`): The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is `1s` and the maximum is `1h`. The default\nvalue is `1m`.\n - `id`: Identifier for the transform.\n - `index_failure` (or `if`): The number of indexing failures.\n - `index_time` (or `itime`): The amount of time spent indexing, in milliseconds.\n - `index_total` (or `it`): The number of index operations.\n - `indexed_documents_exp_avg` (or `idea`): Exponential moving average of the number of new documents that have been\nindexed.\n - `last_search_time` (or `lst`, `lastSearchTime`): The timestamp of the last search in the source indices. This field is only\nshown if the transform is running.\n - `max_page_search_size` (or `mpsz`): Defines the initial page size to use for the composite aggregation for each\ncheckpoint. If circuit breaker exceptions occur, the page size is\ndynamically adjusted to a lower value. The minimum value is `10` and the\nmaximum is `65,536`. The default value is `500`.\n - `pages_processed` (or `pp`): The number of search or bulk index operations processed. Documents are\nprocessed in batches instead of individually.\n - `pipeline` (or `p`): The unique identifier for an ingest pipeline.\n - `processed_documents_exp_avg` (or `pdea`): Exponential moving average of the number of documents that have been\nprocessed.\n - `processing_time` (or `pt`): The amount of time spent processing results, in milliseconds.\n - `reason` (or `r`): If a transform has a `failed` state, this property provides details about\nthe reason for the failure.\n - `search_failure` (or `sf`): The number of search failures.\n - `search_time` (or `stime`): The amount of time spent searching, in milliseconds.\n - `search_total` (or `st`): The number of search operations on the source index for the transform.\n - `source_index` (or `si`, `sourceIndex`): The source indices for the transform. It can be a single index, an index\npattern (for example, `\"my-index-*\"`), an array of indices (for example,\n`[\"my-index-000001\", \"my-index-000002\"]`), or an array of index patterns\n(for example, `[\"my-index-*\", \"my-other-index-*\"]`. For remote indices use\nthe syntax `\"remote_name:index_name\"`. If any indices are in remote\nclusters then the master node and at least one transform node must have the\n`remote_cluster_client` node role.\n - `state` (or `s`): The status of the transform, which can be one of the following values:\n\n* `aborting`: The transform is aborting.\n* `failed`: The transform failed. For more information about the failure,\ncheck the reason field.\n* `indexing`: The transform is actively processing data and creating new\ndocuments.\n* `started`: The transform is running but not actively indexing data.\n* `stopped`: The transform is stopped.\n* `stopping`: The transform is stopping.\n - `transform_type` (or `tt`): Indicates the type of transform: `batch` or `continuous`.\n - `trigger_count` (or `tc`): The number of times the transform has been triggered by the scheduler. For\nexample, the scheduler triggers the transform indexer to check for updates\nor ingest new data at an interval specified in the `frequency` property.\n - `version` (or `v`): The version of Elasticsearch that existed on the node when the transform\nwas created.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/cat._types.CatTransformColumns"
+ },
+ "style": "form"
+ },
+ "cat.transforms-time": {
+ "in": "query",
+ "name": "time",
+ "description": "The unit used to display time values.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.TimeUnit"
+ },
+ "style": "form"
+ },
+ "cat.transforms-size": {
+ "in": "query",
+ "name": "size",
+ "description": "The maximum number of transforms to obtain.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "clear_scroll-scroll_id": {
+ "in": "path",
+ "name": "scroll_id",
+ "description": "A comma-separated list of scroll IDs to clear.\nTo clear all scroll IDs, use `_all`.\nIMPORTANT: Scroll IDs can be long. It is recommended to specify scroll IDs in the request body parameter.",
+ "required": true,
+ "deprecated": true,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ScrollIds"
+ },
+ "style": "simple"
+ },
+ "cluster.get_component_template-name": {
+ "in": "path",
+ "name": "name",
+ "description": "Comma-separated list of component template names used to limit the request.\nWildcard (`*`) expressions are supported.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Name"
+ },
+ "style": "simple"
+ },
+ "cluster.get_component_template-flat_settings": {
+ "in": "query",
+ "name": "flat_settings",
+ "description": "If `true`, returns settings in flat format.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "cluster.get_component_template-settings_filter": {
+ "in": "query",
+ "name": "settings_filter",
+ "description": "Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys",
+ "deprecated": false,
+ "schema": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "style": "form"
+ },
+ "cluster.get_component_template-include_defaults": {
+ "in": "query",
+ "name": "include_defaults",
+ "description": "Return all default configurations for the component template (default: false)",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "x-state": "Generally available",
+ "style": "form"
+ },
+ "cluster.get_component_template-local": {
+ "in": "query",
+ "name": "local",
+ "description": "If `true`, the request retrieves information from the local node only.\nIf `false`, information is retrieved from the master node.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "cluster.get_component_template-master_timeout": {
+ "in": "query",
+ "name": "master_timeout",
+ "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "cluster.put_component_template-name": {
+ "in": "path",
+ "name": "name",
+ "description": "Name of the component template to create.\nElasticsearch includes the following built-in component templates: `logs-mappings`; `logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`.\nElastic Agent uses these templates to configure backing indices for its data streams.\nIf you use Elastic Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version.\nIf you don’t use Elastic Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Name"
+ },
+ "style": "simple"
+ },
+ "cluster.put_component_template-create": {
+ "in": "query",
+ "name": "create",
+ "description": "If `true`, this request cannot replace or update existing component templates.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "cluster.put_component_template-cause": {
+ "in": "query",
+ "name": "cause",
+ "description": "User defined reason for create the component template.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "cluster.put_component_template-master_timeout": {
+ "in": "query",
+ "name": "master_timeout",
+ "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "connector.put-connector_id": {
+ "in": "path",
+ "name": "connector_id",
+ "description": "The unique identifier of the connector to be created or updated. ID is auto-generated if not provided.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "count-index": {
+ "in": "path",
+ "name": "index",
+ "description": "A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ "count-allow_no_indices": {
+ "in": "query",
+ "name": "allow_no_indices",
+ "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`.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "count-analyzer": {
+ "in": "query",
+ "name": "analyzer",
+ "description": "The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "count-analyze_wildcard": {
+ "in": "query",
+ "name": "analyze_wildcard",
+ "description": "If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "count-default_operator": {
+ "in": "query",
+ "name": "default_operator",
+ "description": "The default operator for query string query: `AND` or `OR`.\nThis parameter can be used only when the `q` query string parameter is specified.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.query_dsl.Operator"
+ },
+ "style": "form"
+ },
+ "count-df": {
+ "in": "query",
+ "name": "df",
+ "description": "The field to use as a default when no field prefix is given in the query string.\nThis parameter can be used only when the `q` query string parameter is specified.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "count-expand_wildcards": {
+ "in": "query",
+ "name": "expand_wildcards",
+ "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`.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ExpandWildcards"
+ },
+ "style": "form"
+ },
+ "count-ignore_throttled": {
+ "in": "query",
+ "name": "ignore_throttled",
+ "description": "If `true`, concrete, expanded, or aliased indices are ignored when frozen.",
+ "deprecated": true,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "count-ignore_unavailable": {
+ "in": "query",
+ "name": "ignore_unavailable",
+ "description": "If `false`, the request returns an error if it targets a missing or closed index.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "count-lenient": {
+ "in": "query",
+ "name": "lenient",
+ "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.\nThis parameter can be used only when the `q` query string parameter is specified.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "count-min_score": {
+ "in": "query",
+ "name": "min_score",
+ "description": "The minimum `_score` value that documents must have to be included in the result.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "count-preference": {
+ "in": "query",
+ "name": "preference",
+ "description": "The node or shard the operation should be performed on.\nBy default, it is random.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "count-routing": {
+ "in": "query",
+ "name": "routing",
+ "description": "A custom value used to route operations to a specific shard.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Routing"
+ },
+ "style": "form"
+ },
+ "count-terminate_after": {
+ "in": "query",
+ "name": "terminate_after",
+ "description": "The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this parameter to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "count-q": {
+ "in": "query",
+ "name": "q",
+ "description": "The query in Lucene query string syntax. This parameter cannot be used with a request body.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "create-id": {
+ "in": "path",
+ "name": "id",
+ "description": "A unique identifier for the document.\nTo automatically generate a document ID, use the `POST //_doc/` request format.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "create-index": {
+ "in": "path",
+ "name": "index",
+ "description": "The name of the data stream or index to target.\nIf the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream.\nIf the target doesn't exist and doesn’t match a data stream template, this request creates the index.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.IndexName"
+ },
+ "style": "simple"
+ },
+ "create-include_source_on_error": {
+ "in": "query",
+ "name": "include_source_on_error",
+ "description": "True or false if to include the document source in the error message in case of parsing errors.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "create-pipeline": {
+ "in": "query",
+ "name": "pipeline",
+ "description": "The ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request.\nIf a final pipeline is configured, it will always run regardless of the value of this parameter.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "create-refresh": {
+ "in": "query",
+ "name": "refresh",
+ "description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf `wait_for`, it waits for a refresh to make this operation visible to search.\nIf `false`, it does nothing with refreshes.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Refresh"
+ },
+ "style": "form"
+ },
+ "create-require_alias": {
+ "in": "query",
+ "name": "require_alias",
+ "description": "If `true`, the destination must be an index alias.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "create-require_data_stream": {
+ "in": "query",
+ "name": "require_data_stream",
+ "description": "If `true`, the request's actions must target a data stream (existing or to be created).",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "create-routing": {
+ "in": "query",
+ "name": "routing",
+ "description": "A custom value that is used to route operations to a specific shard.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Routing"
+ },
+ "style": "form"
+ },
+ "create-timeout": {
+ "in": "query",
+ "name": "timeout",
+ "description": "The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.\nElasticsearch waits for at least the specified timeout period before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.\n\nThis parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs.\nSome reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation.\nBy default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error.\nThe actual wait time could be longer, particularly when multiple waits occur.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "create-version": {
+ "in": "query",
+ "name": "version",
+ "description": "The explicit version number for concurrency control.\nIt must be a non-negative long number.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ },
+ "style": "form"
+ },
+ "create-version_type": {
+ "in": "query",
+ "name": "version_type",
+ "description": "The version type.\n\nSupported values include:\n - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n - `force`: This option is deprecated because it can cause primary and replica shards to diverge.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.VersionType"
+ },
+ "style": "form"
+ },
+ "create-wait_for_active_shards": {
+ "in": "query",
+ "name": "wait_for_active_shards",
+ "description": "The number of shard copies that must be active before proceeding with the operation.\nYou can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe default value of `1` means it waits for each primary shard to be active.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.WaitForActiveShards"
+ },
+ "style": "form"
+ },
+ "enrich.get_policy-name": {
+ "in": "path",
+ "name": "name",
+ "description": "Comma-separated list of enrich policy names used to limit the request.\nTo return information for all enrich policies, omit this parameter.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Names"
+ },
+ "style": "simple"
+ },
+ "enrich.get_policy-master_timeout": {
+ "in": "query",
+ "name": "master_timeout",
+ "description": "Period to wait for a connection to the master node.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "eql.search-index": {
+ "in": "path",
+ "name": "index",
+ "description": "The name of the index to scope the operation",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ "eql.search-allow_no_indices": {
+ "in": "query",
+ "name": "allow_no_indices",
+ "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)",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "eql.search-allow_partial_search_results": {
+ "in": "query",
+ "name": "allow_partial_search_results",
+ "description": "If true, returns partial results if there are shard failures. If false, returns an error with no partial results.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "eql.search-allow_partial_sequence_results": {
+ "in": "query",
+ "name": "allow_partial_sequence_results",
+ "description": "If true, sequence queries will return partial results in case of shard failures. If false, they will return no results at all.\nThis flag has effect only if allow_partial_search_results is true.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "eql.search-expand_wildcards": {
+ "in": "query",
+ "name": "expand_wildcards",
+ "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ExpandWildcards"
+ },
+ "style": "form"
+ },
+ "eql.search-ccs_minimize_roundtrips": {
+ "in": "query",
+ "name": "ccs_minimize_roundtrips",
+ "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "eql.search-ignore_unavailable": {
+ "in": "query",
+ "name": "ignore_unavailable",
+ "description": "If true, missing or closed indices are not included in the response.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "eql.search-keep_alive": {
+ "in": "query",
+ "name": "keep_alive",
+ "description": "Period for which the search and its results are stored on the cluster.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "eql.search-keep_on_completion": {
+ "in": "query",
+ "name": "keep_on_completion",
+ "description": "If true, the search and its results are stored on the cluster.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "eql.search-wait_for_completion_timeout": {
+ "in": "query",
+ "name": "wait_for_completion_timeout",
+ "description": "Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "explain-id": {
+ "in": "path",
+ "name": "id",
+ "description": "The document identifier.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "explain-index": {
+ "in": "path",
+ "name": "index",
+ "description": "Index names that are used to limit the request.\nOnly a single index name can be provided to this parameter.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.IndexName"
+ },
+ "style": "simple"
+ },
+ "explain-analyzer": {
+ "in": "query",
+ "name": "analyzer",
+ "description": "The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "explain-analyze_wildcard": {
+ "in": "query",
+ "name": "analyze_wildcard",
+ "description": "If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "explain-default_operator": {
+ "in": "query",
+ "name": "default_operator",
+ "description": "The default operator for query string query: `AND` or `OR`.\nThis parameter can be used only when the `q` query string parameter is specified.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.query_dsl.Operator"
+ },
+ "style": "form"
+ },
+ "explain-df": {
+ "in": "query",
+ "name": "df",
+ "description": "The field to use as default where no field prefix is given in the query string.\nThis parameter can be used only when the `q` query string parameter is specified.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "explain-lenient": {
+ "in": "query",
+ "name": "lenient",
+ "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.\nThis parameter can be used only when the `q` query string parameter is specified.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "explain-preference": {
+ "in": "query",
+ "name": "preference",
+ "description": "The node or shard the operation should be performed on.\nIt is random by default.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "explain-routing": {
+ "in": "query",
+ "name": "routing",
+ "description": "A custom value used to route operations to a specific shard.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Routing"
+ },
+ "style": "form"
+ },
+ "explain-_source": {
+ "in": "query",
+ "name": "_source",
+ "description": "`True` or `false` to return the `_source` field or not or a list of fields to return.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_global.search._types.SourceConfigParam"
+ },
+ "style": "form"
+ },
+ "explain-_source_excludes": {
+ "in": "query",
+ "name": "_source_excludes",
+ "description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Fields"
+ },
+ "style": "form"
+ },
+ "explain-_source_includes": {
+ "in": "query",
+ "name": "_source_includes",
+ "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned.\nYou can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Fields"
+ },
+ "style": "form"
+ },
+ "explain-stored_fields": {
+ "in": "query",
+ "name": "stored_fields",
+ "description": "A comma-separated list of stored fields to return in the response.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Fields"
+ },
+ "style": "form"
+ },
+ "explain-q": {
+ "in": "query",
+ "name": "q",
+ "description": "The query in the Lucene query string syntax.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "field_caps-index": {
+ "in": "path",
+ "name": "index",
+ "description": "A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ "field_caps-allow_no_indices": {
+ "in": "query",
+ "name": "allow_no_indices",
+ "description": "If false, the request returns an error if any wildcard expression, index alias,\nor `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request\ntargeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "field_caps-expand_wildcards": {
+ "in": "query",
+ "name": "expand_wildcards",
+ "description": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ExpandWildcards"
+ },
+ "style": "form"
+ },
+ "field_caps-fields": {
+ "in": "query",
+ "name": "fields",
+ "description": "A comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Fields"
+ },
+ "style": "form"
+ },
+ "field_caps-ignore_unavailable": {
+ "in": "query",
+ "name": "ignore_unavailable",
+ "description": "If `true`, missing or closed indices are not included in the response.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "field_caps-include_unmapped": {
+ "in": "query",
+ "name": "include_unmapped",
+ "description": "If true, unmapped fields are included in the response.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "field_caps-filters": {
+ "in": "query",
+ "name": "filters",
+ "description": "A comma-separated list of filters to apply to the response.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "x-state": "Generally available",
+ "style": "form"
+ },
+ "field_caps-types": {
+ "in": "query",
+ "name": "types",
+ "description": "A comma-separated list of field types to include.\nAny fields that do not match one of these types will be excluded from the results.\nIt defaults to empty, meaning that all field types are returned.",
+ "deprecated": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "x-state": "Generally available",
+ "style": "form"
+ },
+ "field_caps-include_empty_fields": {
+ "in": "query",
+ "name": "include_empty_fields",
+ "description": "If false, empty fields are not included in the response.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "x-state": "Generally available",
+ "style": "form"
+ },
+ "graph.explore-index": {
+ "in": "path",
+ "name": "index",
+ "description": "Name of the index.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ "graph.explore-routing": {
+ "in": "query",
+ "name": "routing",
+ "description": "Custom value used to route operations to a specific shard.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Routing"
+ },
+ "style": "form"
+ },
+ "graph.explore-timeout": {
+ "in": "query",
+ "name": "timeout",
+ "description": "Specifies the period of time to wait for a response from each shard.\nIf no response is received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "index-id": {
+ "in": "path",
+ "name": "id",
+ "description": "A unique identifier for the document.\nTo automatically generate a document ID, use the `POST //_doc/` request format and omit this parameter.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "index-index": {
+ "in": "path",
+ "name": "index",
+ "description": "The name of the data stream or index to target.\nIf the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream.\nIf the target doesn't exist and doesn't match a data stream template, this request creates the index.\nYou can check for existing targets with the resolve index API.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.IndexName"
+ },
+ "style": "simple"
+ },
+ "index-if_primary_term": {
+ "in": "query",
+ "name": "if_primary_term",
+ "description": "Only perform the operation if the document has this primary term.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "index-if_seq_no": {
+ "in": "query",
+ "name": "if_seq_no",
+ "description": "Only perform the operation if the document has this sequence number.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.SequenceNumber"
+ },
+ "style": "form"
+ },
+ "index-include_source_on_error": {
+ "in": "query",
+ "name": "include_source_on_error",
+ "description": "True or false if to include the document source in the error message in case of parsing errors.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "index-op_type": {
+ "in": "query",
+ "name": "op_type",
+ "description": "Set to `create` to only index the document if it does not already exist (put if absent).\nIf a document with the specified `_id` already exists, the indexing operation will fail.\nThe behavior is the same as using the `/_create` endpoint.\nIf a document ID is specified, this paramater defaults to `index`.\nOtherwise, it defaults to `create`.\nIf the request targets a data stream, an `op_type` of `create` is required.\n\nSupported values include:\n - `index`: Overwrite any documents that already exist.\n - `create`: Only index documents that do not already exist.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.OpType"
+ },
+ "style": "form"
+ },
+ "index-pipeline": {
+ "in": "query",
+ "name": "pipeline",
+ "description": "The ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "index-refresh": {
+ "in": "query",
+ "name": "refresh",
+ "description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf `wait_for`, it waits for a refresh to make this operation visible to search.\nIf `false`, it does nothing with refreshes.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Refresh"
+ },
+ "style": "form"
+ },
+ "index-routing": {
+ "in": "query",
+ "name": "routing",
+ "description": "A custom value that is used to route operations to a specific shard.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Routing"
+ },
+ "style": "form"
+ },
+ "index-timeout": {
+ "in": "query",
+ "name": "timeout",
+ "description": "The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.\n\nThis parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs.\nSome reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation.\nBy default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error.\nThe actual wait time could be longer, particularly when multiple waits occur.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "index-version": {
+ "in": "query",
+ "name": "version",
+ "description": "An explicit version number for concurrency control.\nIt must be a non-negative long number.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ },
+ "style": "form"
+ },
+ "index-version_type": {
+ "in": "query",
+ "name": "version_type",
+ "description": "The version type.\n\nSupported values include:\n - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n - `force`: This option is deprecated because it can cause primary and replica shards to diverge.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.VersionType"
+ },
+ "style": "form"
+ },
+ "index-wait_for_active_shards": {
+ "in": "query",
+ "name": "wait_for_active_shards",
+ "description": "The number of shard copies that must be active before proceeding with the operation.\nYou can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe default value of `1` means it waits for each primary shard to be active.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.WaitForActiveShards"
+ },
+ "style": "form"
+ },
+ "index-require_alias": {
+ "in": "query",
+ "name": "require_alias",
+ "description": "If `true`, the destination must be an index alias.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "index-require_data_stream": {
+ "in": "query",
+ "name": "require_data_stream",
+ "description": "If `true`, the request's actions must target a data stream (existing or to be created).",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.analyze-index": {
+ "in": "path",
+ "name": "index",
+ "description": "Index used to derive the analyzer.\nIf specified, the `analyzer` or field parameter overrides this value.\nIf no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.IndexName"
+ },
+ "style": "simple"
+ },
+ "indices.analyze-index_": {
+ "in": "query",
+ "name": "index",
+ "description": "Index used to derive the analyzer.\nIf specified, the `analyzer` or field parameter overrides this value.\nIf no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.IndexName"
+ },
+ "style": "form"
+ },
+ "indices.delete_alias-index": {
+ "in": "path",
+ "name": "index",
+ "description": "Comma-separated list of data streams or indices used to limit the request.\nSupports wildcards (`*`).",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ "indices.delete_alias-name": {
+ "in": "path",
+ "name": "name",
+ "description": "Comma-separated list of aliases to remove.\nSupports wildcards (`*`). To remove all aliases, use `*` or `_all`.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Names"
+ },
+ "style": "simple"
+ },
+ "indices.delete_alias-master_timeout": {
+ "in": "query",
+ "name": "master_timeout",
+ "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "indices.delete_alias-timeout": {
+ "in": "query",
+ "name": "timeout",
+ "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "indices.exists_alias-name": {
+ "in": "path",
+ "name": "name",
+ "description": "Comma-separated list of aliases to check. Supports wildcards (`*`).",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Names"
+ },
+ "style": "simple"
+ },
+ "indices.exists_alias-index": {
+ "in": "path",
+ "name": "index",
+ "description": "Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ "indices.exists_alias-allow_no_indices": {
+ "in": "query",
+ "name": "allow_no_indices",
+ "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.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.exists_alias-expand_wildcards": {
+ "in": "query",
+ "name": "expand_wildcards",
+ "description": "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.\nSupports comma-separated values, such as `open,hidden`.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ExpandWildcards"
+ },
+ "style": "form"
+ },
+ "indices.exists_alias-ignore_unavailable": {
+ "in": "query",
+ "name": "ignore_unavailable",
+ "description": "If `false`, requests that include a missing data stream or index in the target indices or data streams return an error.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.exists_alias-master_timeout": {
+ "in": "query",
+ "name": "master_timeout",
+ "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "indices.get_alias-name": {
+ "in": "path",
+ "name": "name",
+ "description": "Comma-separated list of aliases to retrieve.\nSupports wildcards (`*`).\nTo retrieve all aliases, omit this parameter or use `*` or `_all`.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Names"
+ },
+ "style": "simple"
+ },
+ "indices.get_alias-index": {
+ "in": "path",
+ "name": "index",
+ "description": "Comma-separated list of data streams or indices used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ "indices.get_alias-allow_no_indices": {
+ "in": "query",
+ "name": "allow_no_indices",
+ "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.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.get_alias-expand_wildcards": {
+ "in": "query",
+ "name": "expand_wildcards",
+ "description": "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.\nSupports comma-separated values, such as `open,hidden`.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ExpandWildcards"
+ },
+ "style": "form"
+ },
+ "indices.get_alias-ignore_unavailable": {
+ "in": "query",
+ "name": "ignore_unavailable",
+ "description": "If `false`, the request returns an error if it targets a missing or closed index.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.get_alias-master_timeout": {
+ "in": "query",
+ "name": "master_timeout",
+ "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "indices.get_data_stream-name": {
+ "in": "path",
+ "name": "name",
+ "description": "Comma-separated list of data stream names used to limit the request.\nWildcard (`*`) expressions are supported. If omitted, all data streams are returned.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.DataStreamNames"
+ },
+ "style": "simple"
+ },
+ "indices.get_data_stream-expand_wildcards": {
+ "in": "query",
+ "name": "expand_wildcards",
+ "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ExpandWildcards"
+ },
+ "style": "form"
+ },
+ "indices.get_data_stream-include_defaults": {
+ "in": "query",
+ "name": "include_defaults",
+ "description": "If true, returns all relevant default configurations for the index template.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "x-state": "Generally available",
+ "style": "form"
+ },
+ "indices.get_data_stream-master_timeout": {
+ "in": "query",
+ "name": "master_timeout",
+ "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "indices.get_data_stream-verbose": {
+ "in": "query",
+ "name": "verbose",
+ "description": "Whether the maximum timestamp for each data stream should be calculated and returned.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.get_index_template-name": {
+ "in": "path",
+ "name": "name",
+ "description": "Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Name"
+ },
+ "style": "simple"
+ },
+ "indices.get_index_template-local": {
+ "in": "query",
+ "name": "local",
+ "description": "If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.get_index_template-flat_settings": {
+ "in": "query",
+ "name": "flat_settings",
+ "description": "If true, returns settings in flat format.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.get_index_template-master_timeout": {
+ "in": "query",
+ "name": "master_timeout",
+ "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "indices.get_index_template-include_defaults": {
+ "in": "query",
+ "name": "include_defaults",
+ "description": "If true, returns all relevant default configurations for the index template.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "x-state": "Generally available",
+ "style": "form"
+ },
+ "indices.get_mapping-index": {
+ "in": "path",
+ "name": "index",
+ "description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ "indices.get_mapping-allow_no_indices": {
+ "in": "query",
+ "name": "allow_no_indices",
+ "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.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.get_mapping-expand_wildcards": {
+ "in": "query",
+ "name": "expand_wildcards",
+ "description": "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.\nSupports comma-separated values, such as `open,hidden`.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ExpandWildcards"
+ },
+ "style": "form"
+ },
+ "indices.get_mapping-ignore_unavailable": {
+ "in": "query",
+ "name": "ignore_unavailable",
+ "description": "If `false`, the request returns an error if it targets a missing or closed index.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.get_mapping-local": {
+ "in": "query",
+ "name": "local",
+ "description": "If `true`, the request retrieves information from the local node only.",
+ "deprecated": true,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.get_mapping-master_timeout": {
+ "in": "query",
+ "name": "master_timeout",
+ "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "indices.get_settings-index": {
+ "in": "path",
+ "name": "index",
+ "description": "Comma-separated list of data streams, indices, and aliases used to limit\nthe request. Supports wildcards (`*`). To target all data streams and\nindices, omit this parameter or use `*` or `_all`.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ "indices.get_settings-name": {
+ "in": "path",
+ "name": "name",
+ "description": "Comma-separated list or wildcard expression of settings to retrieve.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Names"
+ },
+ "style": "simple"
+ },
+ "indices.get_settings-allow_no_indices": {
+ "in": "query",
+ "name": "allow_no_indices",
+ "description": "If `false`, the request returns an error if any wildcard expression, index\nalias, or `_all` value targets only missing or closed indices. This\nbehavior applies even if the request targets other open indices. For\nexample, a request targeting `foo*,bar*` returns an error if an index\nstarts with foo but no index starts with `bar`.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.get_settings-expand_wildcards": {
+ "in": "query",
+ "name": "expand_wildcards",
+ "description": "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.\nSupports comma-separated values, such as `open,hidden`.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ExpandWildcards"
+ },
+ "style": "form"
+ },
+ "indices.get_settings-flat_settings": {
+ "in": "query",
+ "name": "flat_settings",
+ "description": "If `true`, returns settings in flat format.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.get_settings-ignore_unavailable": {
+ "in": "query",
+ "name": "ignore_unavailable",
+ "description": "If `false`, the request returns an error if it targets a missing or closed index.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.get_settings-include_defaults": {
+ "in": "query",
+ "name": "include_defaults",
+ "description": "If `true`, return all default settings in the response.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.get_settings-local": {
+ "in": "query",
+ "name": "local",
+ "description": "If `true`, the request retrieves information from the local node only. If\n`false`, information is retrieved from the master node.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.get_settings-master_timeout": {
+ "in": "query",
+ "name": "master_timeout",
+ "description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "indices.put_alias-index": {
+ "in": "path",
+ "name": "index",
+ "description": "Comma-separated list of data streams or indices to add.\nSupports wildcards (`*`).\nWildcard patterns that match both data streams and indices return an error.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ "indices.put_alias-name": {
+ "in": "path",
+ "name": "name",
+ "description": "Alias to update.\nIf the alias doesn’t exist, the request creates it.\nIndex alias names support date math.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Name"
+ },
+ "style": "simple"
+ },
+ "indices.put_alias-master_timeout": {
+ "in": "query",
+ "name": "master_timeout",
+ "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "indices.put_alias-timeout": {
+ "in": "query",
+ "name": "timeout",
+ "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "indices.put_index_template-name": {
+ "in": "path",
+ "name": "name",
+ "description": "Index or template name",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Name"
+ },
+ "style": "simple"
+ },
+ "indices.put_index_template-create": {
+ "in": "query",
+ "name": "create",
+ "description": "If `true`, this request cannot replace or update existing index templates.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.put_index_template-master_timeout": {
+ "in": "query",
+ "name": "master_timeout",
+ "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "indices.put_index_template-cause": {
+ "in": "query",
+ "name": "cause",
+ "description": "User defined reason for creating/updating the index template",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "indices.put_mapping-index": {
+ "in": "path",
+ "name": "index",
+ "description": "A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ "indices.put_mapping-allow_no_indices": {
+ "in": "query",
+ "name": "allow_no_indices",
+ "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.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.put_mapping-expand_wildcards": {
+ "in": "query",
+ "name": "expand_wildcards",
+ "description": "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.\nSupports comma-separated values, such as `open,hidden`.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ExpandWildcards"
+ },
+ "style": "form"
+ },
+ "indices.put_mapping-ignore_unavailable": {
+ "in": "query",
+ "name": "ignore_unavailable",
+ "description": "If `false`, the request returns an error if it targets a missing or closed index.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.put_mapping-master_timeout": {
+ "in": "query",
+ "name": "master_timeout",
+ "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "indices.put_mapping-timeout": {
+ "in": "query",
+ "name": "timeout",
+ "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "indices.put_mapping-write_index_only": {
+ "in": "query",
+ "name": "write_index_only",
+ "description": "If `true`, the mappings are applied only to the current write index for the target.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.put_settings-index": {
+ "in": "path",
+ "name": "index",
+ "description": "Comma-separated list of data streams, indices, and aliases used to limit\nthe request. Supports wildcards (`*`). To target all data streams and\nindices, omit this parameter or use `*` or `_all`.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ "indices.put_settings-allow_no_indices": {
+ "in": "query",
+ "name": "allow_no_indices",
+ "description": "If `false`, the request returns an error if any wildcard expression, index\nalias, or `_all` value targets only missing or closed indices. This\nbehavior applies even if the request targets other open indices. For\nexample, a request targeting `foo*,bar*` returns an error if an index\nstarts with `foo` but no index starts with `bar`.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.put_settings-expand_wildcards": {
+ "in": "query",
+ "name": "expand_wildcards",
+ "description": "Type of index that wildcard patterns can match. If the request can target\ndata streams, this argument determines whether wildcard expressions match\nhidden data streams. Supports comma-separated values, such as\n`open,hidden`.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ExpandWildcards"
+ },
+ "style": "form"
+ },
+ "indices.put_settings-flat_settings": {
+ "in": "query",
+ "name": "flat_settings",
+ "description": "If `true`, returns settings in flat format.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.put_settings-ignore_unavailable": {
+ "in": "query",
+ "name": "ignore_unavailable",
+ "description": "If `true`, returns settings in flat format.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.put_settings-master_timeout": {
+ "in": "query",
+ "name": "master_timeout",
+ "description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "indices.put_settings-preserve_existing": {
+ "in": "query",
+ "name": "preserve_existing",
+ "description": "If `true`, existing index settings remain unchanged.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.put_settings-reopen": {
+ "in": "query",
+ "name": "reopen",
+ "description": "Whether to close and reopen the index to apply non-dynamic settings.\nIf set to `true` the indices to which the settings are being applied\nwill be closed temporarily and then reopened in order to apply the changes.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.put_settings-timeout": {
+ "in": "query",
+ "name": "timeout",
+ "description": "Period to wait for a response. If no response is received before the\n timeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "indices.refresh-index": {
+ "in": "path",
+ "name": "index",
+ "description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ "indices.refresh-allow_no_indices": {
+ "in": "query",
+ "name": "allow_no_indices",
+ "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.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.refresh-expand_wildcards": {
+ "in": "query",
+ "name": "expand_wildcards",
+ "description": "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.\nSupports comma-separated values, such as `open,hidden`.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ExpandWildcards"
+ },
+ "style": "form"
+ },
+ "indices.refresh-ignore_unavailable": {
+ "in": "query",
+ "name": "ignore_unavailable",
+ "description": "If `false`, the request returns an error if it targets a missing or closed index.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.rollover-alias": {
+ "in": "path",
+ "name": "alias",
+ "description": "Name of the data stream or index alias to roll over.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.IndexAlias"
+ },
+ "style": "simple"
+ },
+ "indices.rollover-new_index": {
+ "in": "path",
+ "name": "new_index",
+ "description": "Name of the index to create.\nSupports date math.\nData streams do not support this parameter.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.IndexName"
+ },
+ "style": "simple"
+ },
+ "indices.rollover-dry_run": {
+ "in": "query",
+ "name": "dry_run",
+ "description": "If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.rollover-master_timeout": {
+ "in": "query",
+ "name": "master_timeout",
+ "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "indices.rollover-timeout": {
+ "in": "query",
+ "name": "timeout",
+ "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "indices.rollover-wait_for_active_shards": {
+ "in": "query",
+ "name": "wait_for_active_shards",
+ "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.WaitForActiveShards"
+ },
+ "style": "form"
+ },
+ "indices.rollover-lazy": {
+ "in": "query",
+ "name": "lazy",
+ "description": "If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write.\nOnly allowed on data streams.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.simulate_template-name": {
+ "in": "path",
+ "name": "name",
+ "description": "Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit\nthis parameter and specify the template configuration in the request body.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Name"
+ },
+ "style": "simple"
+ },
+ "indices.simulate_template-create": {
+ "in": "query",
+ "name": "create",
+ "description": "If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.simulate_template-cause": {
+ "in": "query",
+ "name": "cause",
+ "description": "User defined reason for dry-run creating the new template for simulation purposes",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "indices.simulate_template-master_timeout": {
+ "in": "query",
+ "name": "master_timeout",
+ "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "indices.simulate_template-include_defaults": {
+ "in": "query",
+ "name": "include_defaults",
+ "description": "If true, returns all relevant default configurations for the index template.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "x-state": "Generally available",
+ "style": "form"
+ },
+ "indices.validate_query-index": {
+ "in": "path",
+ "name": "index",
+ "description": "Comma-separated list of data streams, indices, and aliases to search.\nSupports wildcards (`*`).\nTo search all data streams or indices, omit this parameter or use `*` or `_all`.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ "indices.validate_query-allow_no_indices": {
+ "in": "query",
+ "name": "allow_no_indices",
+ "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.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.validate_query-all_shards": {
+ "in": "query",
+ "name": "all_shards",
+ "description": "If `true`, the validation is executed on all shards instead of one random shard per index.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.validate_query-analyzer": {
+ "in": "query",
+ "name": "analyzer",
+ "description": "Analyzer to use for the query string.\nThis parameter can only be used when the `q` query string parameter is specified.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "indices.validate_query-analyze_wildcard": {
+ "in": "query",
+ "name": "analyze_wildcard",
+ "description": "If `true`, wildcard and prefix queries are analyzed.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.validate_query-default_operator": {
+ "in": "query",
+ "name": "default_operator",
+ "description": "The default operator for query string query: `AND` or `OR`.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.query_dsl.Operator"
+ },
+ "style": "form"
+ },
+ "indices.validate_query-df": {
+ "in": "query",
+ "name": "df",
+ "description": "Field to use as default where no field prefix is given in the query string.\nThis parameter can only be used when the `q` query string parameter is specified.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "indices.validate_query-expand_wildcards": {
+ "in": "query",
+ "name": "expand_wildcards",
+ "description": "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.\nSupports comma-separated values, such as `open,hidden`.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ExpandWildcards"
+ },
+ "style": "form"
+ },
+ "indices.validate_query-explain": {
+ "in": "query",
+ "name": "explain",
+ "description": "If `true`, the response returns detailed information if an error has occurred.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.validate_query-ignore_unavailable": {
+ "in": "query",
+ "name": "ignore_unavailable",
+ "description": "If `false`, the request returns an error if it targets a missing or closed index.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.validate_query-lenient": {
+ "in": "query",
+ "name": "lenient",
+ "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.validate_query-rewrite": {
+ "in": "query",
+ "name": "rewrite",
+ "description": "If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "indices.validate_query-q": {
+ "in": "query",
+ "name": "q",
+ "description": "Query in the Lucene query string syntax.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "inference.delete-task_type": {
+ "in": "path",
+ "name": "task_type",
+ "description": "The task type",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/inference._types.TaskType"
+ },
+ "style": "simple"
+ },
+ "inference.delete-inference_id": {
+ "in": "path",
+ "name": "inference_id",
+ "description": "The inference identifier.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "inference.delete-dry_run": {
+ "in": "query",
+ "name": "dry_run",
+ "description": "When true, the endpoint is not deleted and a list of ingest processors which reference this endpoint is returned.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "inference.delete-force": {
+ "in": "query",
+ "name": "force",
+ "description": "When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "inference.get-task_type": {
+ "in": "path",
+ "name": "task_type",
+ "description": "The task type",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/inference._types.TaskType"
+ },
+ "style": "simple"
+ },
+ "inference.get-inference_id": {
+ "in": "path",
+ "name": "inference_id",
+ "description": "The inference Id",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "inference.inference-task_type": {
+ "in": "path",
+ "name": "task_type",
+ "description": "The type of inference task that the model performs.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/inference._types.TaskType"
+ },
+ "style": "simple"
+ },
+ "inference.inference-inference_id": {
+ "in": "path",
+ "name": "inference_id",
+ "description": "The unique identifier for the inference endpoint.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "inference.inference-timeout": {
+ "in": "query",
+ "name": "timeout",
+ "description": "The amount of time to wait for the inference request to complete.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "inference.put-task_type": {
+ "in": "path",
+ "name": "task_type",
+ "description": "The task type. Refer to the integration list in the API description for the available task types.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/inference._types.TaskType"
+ },
+ "style": "simple"
+ },
+ "inference.put-inference_id": {
+ "in": "path",
+ "name": "inference_id",
+ "description": "The inference Id",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "inference.put-timeout": {
+ "in": "query",
+ "name": "timeout",
+ "description": "Specifies the amount of time to wait for the inference endpoint to be created.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "ingest.get_pipeline-id": {
+ "in": "path",
+ "name": "id",
+ "description": "Comma-separated list of pipeline IDs to retrieve.\nWildcard (`*`) expressions are supported.\nTo get all ingest pipelines, omit this parameter or use `*`.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "ingest.get_pipeline-master_timeout": {
+ "in": "query",
+ "name": "master_timeout",
+ "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "ingest.get_pipeline-summary": {
+ "in": "query",
+ "name": "summary",
+ "description": "Return pipelines without their definitions (default: false)",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "ingest.simulate-id": {
+ "in": "path",
+ "name": "id",
+ "description": "The pipeline to test.\nIf you don't specify a `pipeline` in the request body, this parameter is required.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "ingest.simulate-verbose": {
+ "in": "query",
+ "name": "verbose",
+ "description": "If `true`, the response includes output data for each processor in the executed pipeline.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "logstash.get_pipeline-id": {
+ "in": "path",
+ "name": "id",
+ "description": "A comma-separated list of pipeline identifiers.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Ids"
+ },
+ "style": "simple"
+ },
+ "mget-index": {
+ "in": "path",
+ "name": "index",
+ "description": "Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.IndexName"
+ },
+ "style": "simple"
+ },
+ "mget-preference": {
+ "in": "query",
+ "name": "preference",
+ "description": "Specifies the node or shard the operation should be performed on. Random by default.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "mget-realtime": {
+ "in": "query",
+ "name": "realtime",
+ "description": "If `true`, the request is real-time as opposed to near-real-time.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "mget-refresh": {
+ "in": "query",
+ "name": "refresh",
+ "description": "If `true`, the request refreshes relevant shards before retrieving documents.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "mget-routing": {
+ "in": "query",
+ "name": "routing",
+ "description": "Custom value used to route operations to a specific shard.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Routing"
+ },
+ "style": "form"
+ },
+ "mget-_source": {
+ "in": "query",
+ "name": "_source",
+ "description": "True or false to return the `_source` field or not, or a list of fields to return.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_global.search._types.SourceConfigParam"
+ },
+ "style": "form"
+ },
+ "mget-_source_excludes": {
+ "in": "query",
+ "name": "_source_excludes",
+ "description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Fields"
+ },
+ "style": "form"
+ },
+ "mget-_source_includes": {
+ "in": "query",
+ "name": "_source_includes",
+ "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Fields"
+ },
+ "style": "form"
+ },
+ "mget-stored_fields": {
+ "in": "query",
+ "name": "stored_fields",
+ "description": "If `true`, retrieves the document fields stored in the index rather than the document `_source`.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Fields"
+ },
+ "style": "form"
+ },
+ "ml.get_calendars-calendar_id": {
+ "in": "path",
+ "name": "calendar_id",
+ "description": "A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using `_all` or `*` or by omitting the calendar identifier.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "ml.get_calendars-from": {
+ "in": "query",
+ "name": "from",
+ "description": "Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "ml.get_calendars-size": {
+ "in": "query",
+ "name": "size",
+ "description": "Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "ml.get_data_frame_analytics-id": {
+ "in": "path",
+ "name": "id",
+ "description": "Identifier for the data frame analytics job. If you do not specify this\noption, the API returns information for the first hundred data frame\nanalytics jobs.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "ml.get_data_frame_analytics-allow_no_match": {
+ "in": "query",
+ "name": "allow_no_match",
+ "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no data frame analytics\njobs that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value returns an empty data_frame_analytics array when there\nare no matches and the subset of results when there are partial matches.\nIf this parameter is `false`, the request returns a 404 status code when\nthere are no matches or only partial matches.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "ml.get_data_frame_analytics-from": {
+ "in": "query",
+ "name": "from",
+ "description": "Skips the specified number of data frame analytics jobs.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "ml.get_data_frame_analytics-size": {
+ "in": "query",
+ "name": "size",
+ "description": "Specifies the maximum number of data frame analytics jobs to obtain.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "ml.get_data_frame_analytics-exclude_generated": {
+ "in": "query",
+ "name": "exclude_generated",
+ "description": "Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "ml.get_data_frame_analytics_stats-id": {
+ "in": "path",
+ "name": "id",
+ "description": "Identifier for the data frame analytics job. If you do not specify this\noption, the API returns information for the first hundred data frame\nanalytics jobs.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "ml.get_data_frame_analytics_stats-allow_no_match": {
+ "in": "query",
+ "name": "allow_no_match",
+ "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no data frame analytics\njobs that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value returns an empty data_frame_analytics array when there\nare no matches and the subset of results when there are partial matches.\nIf this parameter is `false`, the request returns a 404 status code when\nthere are no matches or only partial matches.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "ml.get_data_frame_analytics_stats-from": {
+ "in": "query",
+ "name": "from",
+ "description": "Skips the specified number of data frame analytics jobs.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "ml.get_data_frame_analytics_stats-size": {
+ "in": "query",
+ "name": "size",
+ "description": "Specifies the maximum number of data frame analytics jobs to obtain.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "ml.get_data_frame_analytics_stats-verbose": {
+ "in": "query",
+ "name": "verbose",
+ "description": "Defines whether the stats response should be verbose.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "ml.get_datafeed_stats-datafeed_id": {
+ "in": "path",
+ "name": "datafeed_id",
+ "description": "Identifier for the datafeed. It can be a datafeed identifier or a\nwildcard expression. If you do not specify one of these options, the API\nreturns information about all datafeeds.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Ids"
+ },
+ "style": "simple"
+ },
+ "ml.get_datafeed_stats-allow_no_match": {
+ "in": "query",
+ "name": "allow_no_match",
+ "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no datafeeds that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is `true`, which returns an empty `datafeeds` array\nwhen there are no matches and the subset of results when there are\npartial matches. If this parameter is `false`, the request returns a\n`404` status code when there are no matches or only partial matches.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "ml.get_datafeeds-datafeed_id": {
+ "in": "path",
+ "name": "datafeed_id",
+ "description": "Identifier for the datafeed. It can be a datafeed identifier or a\nwildcard expression. If you do not specify one of these options, the API\nreturns information about all datafeeds.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Ids"
+ },
+ "style": "simple"
+ },
+ "ml.get_datafeeds-allow_no_match": {
+ "in": "query",
+ "name": "allow_no_match",
+ "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no datafeeds that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is `true`, which returns an empty `datafeeds` array\nwhen there are no matches and the subset of results when there are\npartial matches. If this parameter is `false`, the request returns a\n`404` status code when there are no matches or only partial matches.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "ml.get_datafeeds-exclude_generated": {
+ "in": "query",
+ "name": "exclude_generated",
+ "description": "Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "ml.get_filters-filter_id": {
+ "in": "path",
+ "name": "filter_id",
+ "description": "A string that uniquely identifies a filter.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Ids"
+ },
+ "style": "simple"
+ },
+ "ml.get_filters-from": {
+ "in": "query",
+ "name": "from",
+ "description": "Skips the specified number of filters.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "ml.get_filters-size": {
+ "in": "query",
+ "name": "size",
+ "description": "Specifies the maximum number of filters to obtain.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "ml.get_job_stats-job_id": {
+ "in": "path",
+ "name": "job_id",
+ "description": "Identifier for the anomaly detection job. It can be a job identifier, a\ngroup name, a comma-separated list of jobs, or a wildcard expression. If\nyou do not specify one of these options, the API returns information for\nall anomaly detection jobs.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "ml.get_job_stats-allow_no_match": {
+ "in": "query",
+ "name": "allow_no_match",
+ "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no jobs that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the API returns an empty `jobs` array when\nthere are no matches and the subset of results when there are partial\nmatches. If `false`, the API returns a `404` status\ncode when there are no matches or only partial matches.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "ml.get_jobs-job_id": {
+ "in": "path",
+ "name": "job_id",
+ "description": "Identifier for the anomaly detection job. It can be a job identifier, a\ngroup name, or a wildcard expression. If you do not specify one of these\noptions, the API returns information for all anomaly detection jobs.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Ids"
+ },
+ "style": "simple"
+ },
+ "ml.get_jobs-allow_no_match": {
+ "in": "query",
+ "name": "allow_no_match",
+ "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no jobs that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nThe default value is `true`, which returns an empty `jobs` array when\nthere are no matches and the subset of results when there are partial\nmatches. If this parameter is `false`, the request returns a `404` status\ncode when there are no matches or only partial matches.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "ml.get_jobs-exclude_generated": {
+ "in": "query",
+ "name": "exclude_generated",
+ "description": "Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "ml.get_overall_buckets-job_id": {
+ "in": "path",
+ "name": "job_id",
+ "description": "Identifier for the anomaly detection job. It can be a job identifier, a\ngroup name, a comma-separated list of jobs or groups, or a wildcard\nexpression.\n\nYou can summarize the bucket results for all anomaly detection jobs by\nusing `_all` or by specifying `*` as the ``.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "ml.get_overall_buckets-allow_no_match": {
+ "in": "query",
+ "name": "allow_no_match",
+ "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no jobs that match.\n2. Contains the `_all` string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf `true`, the request returns an empty `jobs` array when there are no\nmatches and the subset of results when there are partial matches. If this\nparameter is `false`, the request returns a `404` status code when there\nare no matches or only partial matches.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "ml.get_overall_buckets-bucket_span": {
+ "in": "query",
+ "name": "bucket_span",
+ "description": "The span of the overall buckets. Must be greater or equal to the largest\nbucket span of the specified anomaly detection jobs, which is the default\nvalue.\n\nBy default, an overall bucket has a span equal to the largest bucket span\nof the specified anomaly detection jobs. To override that behavior, use\nthe optional `bucket_span` parameter.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "ml.get_overall_buckets-end": {
+ "in": "query",
+ "name": "end",
+ "description": "Returns overall buckets with timestamps earlier than this time.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.DateTime"
+ },
+ "style": "form"
+ },
+ "ml.get_overall_buckets-exclude_interim": {
+ "in": "query",
+ "name": "exclude_interim",
+ "description": "If `true`, the output excludes interim results.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "ml.get_overall_buckets-overall_score": {
+ "in": "query",
+ "name": "overall_score",
+ "description": "Returns overall buckets with overall scores greater than or equal to this\nvalue.",
+ "deprecated": false,
+ "schema": {
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "style": "form"
+ },
+ "ml.get_overall_buckets-start": {
+ "in": "query",
+ "name": "start",
+ "description": "Returns overall buckets with timestamps after this time.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.DateTime"
+ },
+ "style": "form"
+ },
+ "ml.get_overall_buckets-top_n": {
+ "in": "query",
+ "name": "top_n",
+ "description": "The number of top anomaly detection job bucket scores to be used in the\n`overall_score` calculation.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "ml.get_trained_models-model_id": {
+ "in": "path",
+ "name": "model_id",
+ "description": "The unique identifier of the trained model or a model alias.\n\nYou can get information for multiple trained models in a single API\nrequest by using a comma-separated list of model IDs or a wildcard\nexpression.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Ids"
+ },
+ "style": "simple"
+ },
+ "ml.get_trained_models-allow_no_match": {
+ "in": "query",
+ "name": "allow_no_match",
+ "description": "Specifies what to do when the request:\n\n- Contains wildcard expressions and there are no models that match.\n- Contains the _all string or no identifiers and there are no matches.\n- Contains wildcard expressions and there are only partial matches.\n\nIf true, it returns an empty array when there are no matches and the\nsubset of results when there are partial matches.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "ml.get_trained_models-decompress_definition": {
+ "in": "query",
+ "name": "decompress_definition",
+ "description": "Specifies whether the included model definition should be returned as a\nJSON map (true) or in a custom compressed format (false).",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "ml.get_trained_models-exclude_generated": {
+ "in": "query",
+ "name": "exclude_generated",
+ "description": "Indicates if certain fields should be removed from the configuration on\nretrieval. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "ml.get_trained_models-from": {
+ "in": "query",
+ "name": "from",
+ "description": "Skips the specified number of models.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "ml.get_trained_models-include": {
+ "in": "query",
+ "name": "include",
+ "description": "A comma delimited string of optional fields to include in the response\nbody.\n\nSupported values include:\n - `definition`: Includes the model definition.\n - `feature_importance_baseline`: Includes the baseline for feature importance values.\n - `hyperparameters`: Includes the information about hyperparameters used to train the model.\nThis information consists of the value, the absolute and relative\nimportance of the hyperparameter as well as an indicator of whether it was\nspecified by the user or tuned during hyperparameter optimization.\n - `total_feature_importance`: Includes the total feature importance for the training data set. The\nbaseline and total feature importance values are returned in the metadata\nfield in the response body.\n - `definition_status`: Includes the model definition status.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/ml._types.Include"
+ },
+ "style": "form"
+ },
+ "ml.get_trained_models-size": {
+ "in": "query",
+ "name": "size",
+ "description": "Specifies the maximum number of models to obtain.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "ml.get_trained_models-tags": {
+ "in": "query",
+ "name": "tags",
+ "description": "A comma delimited string of tags. A trained model can have many tags, or\nnone. When supplied, only trained models that contain all the supplied\ntags are returned.",
+ "deprecated": false,
+ "schema": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "style": "form"
+ },
+ "ml.get_trained_models_stats-model_id": {
+ "in": "path",
+ "name": "model_id",
+ "description": "The unique identifier of the trained model or a model alias. It can be a\ncomma-separated list or a wildcard expression.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Ids"
+ },
+ "style": "simple"
+ },
+ "ml.get_trained_models_stats-allow_no_match": {
+ "in": "query",
+ "name": "allow_no_match",
+ "description": "Specifies what to do when the request:\n\n- Contains wildcard expressions and there are no models that match.\n- Contains the _all string or no identifiers and there are no matches.\n- Contains wildcard expressions and there are only partial matches.\n\nIf true, it returns an empty array when there are no matches and the\nsubset of results when there are partial matches.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "ml.get_trained_models_stats-from": {
+ "in": "query",
+ "name": "from",
+ "description": "Skips the specified number of models.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "ml.get_trained_models_stats-size": {
+ "in": "query",
+ "name": "size",
+ "description": "Specifies the maximum number of models to obtain.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "ml.preview_data_frame_analytics-id": {
+ "in": "path",
+ "name": "id",
+ "description": "Identifier for the data frame analytics job.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "ml.preview_datafeed-datafeed_id": {
+ "in": "path",
+ "name": "datafeed_id",
+ "description": "A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase\nalphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric\ncharacters. NOTE: If you use this path parameter, you cannot provide datafeed or anomaly detection job\nconfiguration details in the request body.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "ml.preview_datafeed-start": {
+ "in": "query",
+ "name": "start",
+ "description": "The start time from where the datafeed preview should begin",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.DateTime"
+ },
+ "style": "form"
+ },
+ "ml.preview_datafeed-end": {
+ "in": "query",
+ "name": "end",
+ "description": "The end time when the datafeed preview should stop",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.DateTime"
+ },
+ "style": "form"
+ },
+ "msearch-index": {
+ "in": "path",
+ "name": "index",
+ "description": "Comma-separated list of data streams, indices, and index aliases to search.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ "msearch-allow_no_indices": {
+ "in": "query",
+ "name": "allow_no_indices",
+ "description": "If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "msearch-ccs_minimize_roundtrips": {
+ "in": "query",
+ "name": "ccs_minimize_roundtrips",
+ "description": "If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "msearch-expand_wildcards": {
+ "in": "query",
+ "name": "expand_wildcards",
+ "description": "Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ExpandWildcards"
+ },
+ "style": "form"
+ },
+ "msearch-ignore_throttled": {
+ "in": "query",
+ "name": "ignore_throttled",
+ "description": "If true, concrete, expanded or aliased indices are ignored when frozen.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "msearch-ignore_unavailable": {
+ "in": "query",
+ "name": "ignore_unavailable",
+ "description": "If true, missing or closed indices are not included in the response.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "msearch-include_named_queries_score": {
+ "in": "query",
+ "name": "include_named_queries_score",
+ "description": "Indicates whether hit.matched_queries should be rendered as a map that includes\nthe name of the matched query associated with its score (true)\nor as an array containing the name of the matched queries (false)\nThis functionality reruns each named query on every hit in a search response.\nTypically, this adds a small overhead to a request.\nHowever, using computationally expensive named queries on a large number of hits may add significant overhead.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "msearch-index_": {
+ "in": "query",
+ "name": "index",
+ "description": "Comma-separated list of data streams, indices, and index aliases to use as default",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "form"
+ },
+ "msearch-max_concurrent_searches": {
+ "in": "query",
+ "name": "max_concurrent_searches",
+ "description": "Maximum number of concurrent searches the multi search API can execute.\nDefaults to `max(1, (# of data nodes * min(search thread pool size, 10)))`.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "msearch-max_concurrent_shard_requests": {
+ "in": "query",
+ "name": "max_concurrent_shard_requests",
+ "description": "Maximum number of concurrent shard requests that each sub-search request executes per node.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "msearch-pre_filter_shard_size": {
+ "in": "query",
+ "name": "pre_filter_shard_size",
+ "description": "Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "msearch-rest_total_hits_as_int": {
+ "in": "query",
+ "name": "rest_total_hits_as_int",
+ "description": "If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "msearch-routing": {
+ "in": "query",
+ "name": "routing",
+ "description": "Custom routing value used to route search operations to a specific shard.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Routing"
+ },
+ "style": "form"
+ },
+ "msearch-search_type": {
+ "in": "query",
+ "name": "search_type",
+ "description": "Indicates whether global term and document frequencies should be used when scoring returned documents.\n\nSupported values include:\n - `query_then_fetch`: Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.\n - `dfs_query_then_fetch`: Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.SearchType"
+ },
+ "style": "form"
+ },
+ "msearch-typed_keys": {
+ "in": "query",
+ "name": "typed_keys",
+ "description": "Specifies whether aggregation and suggester names should be prefixed by their respective types in the response.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "msearch_template-index": {
+ "in": "path",
+ "name": "index",
+ "description": "A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*`.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ "msearch_template-ccs_minimize_roundtrips": {
+ "in": "query",
+ "name": "ccs_minimize_roundtrips",
+ "description": "If `true`, network round-trips are minimized for cross-cluster search requests.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "msearch_template-max_concurrent_searches": {
+ "in": "query",
+ "name": "max_concurrent_searches",
+ "description": "The maximum number of concurrent searches the API can run.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "msearch_template-search_type": {
+ "in": "query",
+ "name": "search_type",
+ "description": "The type of the search operation.\n\nSupported values include:\n - `query_then_fetch`: Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.\n - `dfs_query_then_fetch`: Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.SearchType"
+ },
+ "style": "form"
+ },
+ "msearch_template-rest_total_hits_as_int": {
+ "in": "query",
+ "name": "rest_total_hits_as_int",
+ "description": "If `true`, the response returns `hits.total` as an integer.\nIf `false`, it returns `hits.total` as an object.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "msearch_template-typed_keys": {
+ "in": "query",
+ "name": "typed_keys",
+ "description": "If `true`, the response prefixes aggregation and suggester names with their respective types.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "mtermvectors-index": {
+ "in": "path",
+ "name": "index",
+ "description": "The name of the index that contains the documents.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.IndexName"
+ },
+ "style": "simple"
+ },
+ "mtermvectors-ids": {
+ "in": "query",
+ "name": "ids",
+ "description": "A comma-separated list of documents ids. You must define ids as parameter or set \"ids\" or \"docs\" in the request body",
+ "deprecated": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ },
+ "style": "form"
+ },
+ "mtermvectors-fields": {
+ "in": "query",
+ "name": "fields",
+ "description": "A comma-separated list or wildcard expressions of fields to include in the statistics.\nIt is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Fields"
+ },
+ "style": "form"
+ },
+ "mtermvectors-field_statistics": {
+ "in": "query",
+ "name": "field_statistics",
+ "description": "If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "mtermvectors-offsets": {
+ "in": "query",
+ "name": "offsets",
+ "description": "If `true`, the response includes term offsets.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "mtermvectors-payloads": {
+ "in": "query",
+ "name": "payloads",
+ "description": "If `true`, the response includes term payloads.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "mtermvectors-positions": {
+ "in": "query",
+ "name": "positions",
+ "description": "If `true`, the response includes term positions.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "mtermvectors-preference": {
+ "in": "query",
+ "name": "preference",
+ "description": "The node or shard the operation should be performed on.\nIt is random by default.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "mtermvectors-realtime": {
+ "in": "query",
+ "name": "realtime",
+ "description": "If true, the request is real-time as opposed to near-real-time.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "mtermvectors-routing": {
+ "in": "query",
+ "name": "routing",
+ "description": "A custom value used to route operations to a specific shard.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Routing"
+ },
+ "style": "form"
+ },
+ "mtermvectors-term_statistics": {
+ "in": "query",
+ "name": "term_statistics",
+ "description": "If true, the response includes term frequency and document frequency.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "mtermvectors-version": {
+ "in": "query",
+ "name": "version",
+ "description": "If `true`, returns the document version as part of a hit.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ },
+ "style": "form"
+ },
+ "mtermvectors-version_type": {
+ "in": "query",
+ "name": "version_type",
+ "description": "The version type.\n\nSupported values include:\n - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n - `force`: This option is deprecated because it can cause primary and replica shards to diverge.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.VersionType"
+ },
+ "style": "form"
+ },
+ "put_script-id": {
+ "in": "path",
+ "name": "id",
+ "description": "The identifier for the stored script or search template.\nIt must be unique within the cluster.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "put_script-context": {
+ "in": "path",
+ "name": "context",
+ "description": "The context in which the script or search template should run.\nTo prevent errors, the API immediately compiles the script or template in this context.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Name"
+ },
+ "style": "simple"
+ },
+ "put_script-context_": {
+ "in": "query",
+ "name": "context",
+ "description": "The context in which the script or search template should run.\nTo prevent errors, the API immediately compiles the script or template in this context.\nIf you specify both this and the `` path parameter, the API uses the request path parameter.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Name"
+ },
+ "style": "form"
+ },
+ "put_script-master_timeout": {
+ "in": "query",
+ "name": "master_timeout",
+ "description": "The period to wait for a connection to the master node.\nIf no response is received 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.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "put_script-timeout": {
+ "in": "query",
+ "name": "timeout",
+ "description": "The period to wait for a response.\nIf no response is received 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.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "rank_eval-index": {
+ "in": "path",
+ "name": "index",
+ "description": "A comma-separated list of data streams, indices, and index aliases used to limit the request.\nWildcard (`*`) expressions are supported.\nTo target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ "rank_eval-allow_no_indices": {
+ "in": "query",
+ "name": "allow_no_indices",
+ "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "rank_eval-expand_wildcards": {
+ "in": "query",
+ "name": "expand_wildcards",
+ "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ExpandWildcards"
+ },
+ "style": "form"
+ },
+ "rank_eval-ignore_unavailable": {
+ "in": "query",
+ "name": "ignore_unavailable",
+ "description": "If `true`, missing or closed indices are not included in the response.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "rank_eval-search_type": {
+ "in": "query",
+ "name": "search_type",
+ "description": "Search operation type",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "render_search_template-id": {
+ "in": "path",
+ "name": "id",
+ "description": "The ID of the search template to render.\nIf no `source` is specified, this or the `id` request body parameter is required.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "scroll-scroll_id": {
+ "in": "path",
+ "name": "scroll_id",
+ "description": "The scroll ID",
+ "required": true,
+ "deprecated": true,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ScrollId"
+ },
+ "style": "simple"
+ },
+ "scroll-scroll": {
+ "in": "query",
+ "name": "scroll",
+ "description": "The period to retain the search context for scrolling.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "scroll-scroll_id_": {
+ "in": "query",
+ "name": "scroll_id",
+ "description": "The scroll ID for scrolled search",
+ "deprecated": true,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ScrollId"
+ },
+ "style": "form"
+ },
+ "scroll-rest_total_hits_as_int": {
+ "in": "query",
+ "name": "rest_total_hits_as_int",
+ "description": "If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "search-index": {
+ "in": "path",
+ "name": "index",
+ "description": "A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ "search-allow_no_indices": {
+ "in": "query",
+ "name": "allow_no_indices",
+ "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`.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "search-allow_partial_search_results": {
+ "in": "query",
+ "name": "allow_partial_search_results",
+ "description": "If `true` and there are shard request timeouts or shard failures, the request returns partial results.\nIf `false`, it returns an error with no partial results.\n\nTo override the default behavior, you can set the `search.default_allow_partial_results` cluster setting to `false`.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "search-analyzer": {
+ "in": "query",
+ "name": "analyzer",
+ "description": "The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "search-analyze_wildcard": {
+ "in": "query",
+ "name": "analyze_wildcard",
+ "description": "If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "search-batched_reduce_size": {
+ "in": "query",
+ "name": "batched_reduce_size",
+ "description": "The number of shard results that should be reduced at once on the coordinating node.\nIf the potential number of shards in the request can be large, this value should be used as a protection mechanism to reduce the memory overhead per search request.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "search-ccs_minimize_roundtrips": {
+ "in": "query",
+ "name": "ccs_minimize_roundtrips",
+ "description": "If `true`, network round-trips between the coordinating node and the remote clusters are minimized when running cross-cluster search (CCS) requests.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "search-default_operator": {
+ "in": "query",
+ "name": "default_operator",
+ "description": "The default operator for the query string query: `AND` or `OR`.\nThis parameter can be used only when the `q` query string parameter is specified.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.query_dsl.Operator"
+ },
+ "style": "form"
+ },
+ "search-df": {
+ "in": "query",
+ "name": "df",
+ "description": "The field to use as a default when no field prefix is given in the query string.\nThis parameter can be used only when the `q` query string parameter is specified.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "search-docvalue_fields": {
+ "in": "query",
+ "name": "docvalue_fields",
+ "description": "A comma-separated list of fields to return as the docvalue representation of a field for each hit.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Fields"
+ },
+ "style": "form"
+ },
+ "search-expand_wildcards": {
+ "in": "query",
+ "name": "expand_wildcards",
+ "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`.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ExpandWildcards"
+ },
+ "style": "form"
+ },
+ "search-explain": {
+ "in": "query",
+ "name": "explain",
+ "description": "If `true`, the request returns detailed information about score computation as part of a hit.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "search-ignore_throttled": {
+ "in": "query",
+ "name": "ignore_throttled",
+ "description": "If `true`, concrete, expanded or aliased indices will be ignored when frozen.",
+ "deprecated": true,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "search-ignore_unavailable": {
+ "in": "query",
+ "name": "ignore_unavailable",
+ "description": "If `false`, the request returns an error if it targets a missing or closed index.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "search-include_named_queries_score": {
+ "in": "query",
+ "name": "include_named_queries_score",
+ "description": "If `true`, the response includes the score contribution from any named queries.\n\nThis functionality reruns each named query on every hit in a search response.\nTypically, this adds a small overhead to a request.\nHowever, using computationally expensive named queries on a large number of hits may add significant overhead.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "search-lenient": {
+ "in": "query",
+ "name": "lenient",
+ "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.\nThis parameter can be used only when the `q` query string parameter is specified.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "search-max_concurrent_shard_requests": {
+ "in": "query",
+ "name": "max_concurrent_shard_requests",
+ "description": "The number of concurrent shard requests per node that the search runs concurrently.\nThis value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "search-preference": {
+ "in": "query",
+ "name": "preference",
+ "description": "The nodes and shards used for the search.\nBy default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness.\nValid values are:\n\n* `_only_local` to run the search only on shards on the local node.\n* `_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method.\n* `_only_nodes:,` to run the search on only the specified nodes IDs. If suitable shards exist on more than one selected node, use shards on those nodes using the default method. If none of the specified nodes are available, select shards from any available node using the default method.\n* `_prefer_nodes:,` to if possible, run the search on the specified nodes IDs. If not, select shards using the default method.\n* `_shards:,` to run the search only on the specified shards. You can combine this value with other `preference` values. However, the `_shards` value must come first. For example: `_shards:2,3|_local`.\n* `` (any string that does not start with `_`) to route searches with the same `` to the same shards in the same order.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "search-pre_filter_shard_size": {
+ "in": "query",
+ "name": "pre_filter_shard_size",
+ "description": "A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold.\nThis filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint).\nWhen unspecified, the pre-filter phase is executed if any of these conditions is met:\n\n* The request targets more than 128 shards.\n* The request targets one or more read-only index.\n* The primary sort of the query targets an indexed field.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "search-request_cache": {
+ "in": "query",
+ "name": "request_cache",
+ "description": "If `true`, the caching of search results is enabled for requests where `size` is `0`.\nIt defaults to index level settings.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "search-routing": {
+ "in": "query",
+ "name": "routing",
+ "description": "A custom value that is used to route operations to a specific shard.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Routing"
+ },
+ "style": "form"
+ },
+ "search-scroll": {
+ "in": "query",
+ "name": "scroll",
+ "description": "The period to retain the search context for scrolling.\nBy default, this value cannot exceed `1d` (24 hours).\nYou can change this limit by using the `search.max_keep_alive` cluster-level setting.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "search-search_type": {
+ "in": "query",
+ "name": "search_type",
+ "description": "Indicates how distributed term frequencies are calculated for relevance scoring.\n\nSupported values include:\n - `query_then_fetch`: Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.\n - `dfs_query_then_fetch`: Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.SearchType"
+ },
+ "style": "form"
+ },
+ "search-stats": {
+ "in": "query",
+ "name": "stats",
+ "description": "Specific `tag` of the request for logging and statistical purposes.",
+ "deprecated": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "style": "form"
+ },
+ "search-stored_fields": {
+ "in": "query",
+ "name": "stored_fields",
+ "description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` parameter defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Fields"
+ },
+ "style": "form"
+ },
+ "search-suggest_field": {
+ "in": "query",
+ "name": "suggest_field",
+ "description": "The field to use for suggestions.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Field"
+ },
+ "style": "form"
+ },
+ "search-suggest_mode": {
+ "in": "query",
+ "name": "suggest_mode",
+ "description": "The suggest mode.\nThis parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.\n\nSupported values include:\n - `missing`: Only generate suggestions for terms that are not in the shard.\n - `popular`: Only suggest terms that occur in more docs on the shard than the original term.\n - `always`: Suggest any matching suggestions based on terms in the suggest text.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.SuggestMode"
+ },
+ "style": "form"
+ },
+ "search-suggest_size": {
+ "in": "query",
+ "name": "suggest_size",
+ "description": "The number of suggestions to return.\nThis parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "search-suggest_text": {
+ "in": "query",
+ "name": "suggest_text",
+ "description": "The source text for which the suggestions should be returned.\nThis parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "search-terminate_after": {
+ "in": "query",
+ "name": "terminate_after",
+ "description": "The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this parameter to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.\nIf set to `0` (default), the query does not terminate early.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "search-timeout": {
+ "in": "query",
+ "name": "timeout",
+ "description": "The period of time to wait for a response from each shard.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt defaults to no timeout.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "search-track_total_hits": {
+ "in": "query",
+ "name": "track_total_hits",
+ "description": "The number of hits matching the query to count accurately.\nIf `true`, the exact number of hits is returned at the cost of some performance.\nIf `false`, the response does not include the total number of hits matching the query.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_global.search._types.TrackHits"
+ },
+ "style": "form"
+ },
+ "search-track_scores": {
+ "in": "query",
+ "name": "track_scores",
+ "description": "If `true`, the request calculates and returns document scores, even if the scores are not used for sorting.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "search-typed_keys": {
+ "in": "query",
+ "name": "typed_keys",
+ "description": "If `true`, aggregation and suggester names are be prefixed by their respective types in the response.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "search-rest_total_hits_as_int": {
+ "in": "query",
+ "name": "rest_total_hits_as_int",
+ "description": "Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "search-version": {
+ "in": "query",
+ "name": "version",
+ "description": "If `true`, the request returns the document version as part of a hit.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "search-_source": {
+ "in": "query",
+ "name": "_source",
+ "description": "The source fields that are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nValid values are:\n\n* `true` to return the entire document source.\n* `false` to not return the document source.\n* `` to return the source fields that are specified as a comma-separated list that supports wildcard (`*`) patterns.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_global.search._types.SourceConfigParam"
+ },
+ "style": "form"
+ },
+ "search-_source_excludes": {
+ "in": "query",
+ "name": "_source_excludes",
+ "description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Fields"
+ },
+ "style": "form"
+ },
+ "search-_source_exclude_vectors": {
+ "in": "query",
+ "name": "_source_exclude_vectors",
+ "description": "Whether vectors should be excluded from _source",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "x-state": "Generally available",
+ "style": "form"
+ },
+ "search-_source_includes": {
+ "in": "query",
+ "name": "_source_includes",
+ "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned.\nYou can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Fields"
+ },
+ "style": "form"
+ },
+ "search-seq_no_primary_term": {
+ "in": "query",
+ "name": "seq_no_primary_term",
+ "description": "If `true`, the request returns the sequence number and primary term of the last modification of each hit.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "search-q": {
+ "in": "query",
+ "name": "q",
+ "description": "A query in the Lucene query string syntax.\nQuery parameter searches do not support the full Elasticsearch Query DSL but are handy for testing.\n\nIMPORTANT: This parameter overrides the query parameter in the request body.\nIf both parameters are specified, documents matching the query request body parameter are not returned.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "search-size": {
+ "in": "query",
+ "name": "size",
+ "description": "The number of hits to return.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "search-from": {
+ "in": "query",
+ "name": "from",
+ "description": "The starting document offset, which must be non-negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "search-sort": {
+ "in": "query",
+ "name": "sort",
+ "description": "A comma-separated list of `:` pairs.",
+ "deprecated": false,
+ "schema": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "style": "form"
+ },
+ "search_application.get_behavioral_analytics-name": {
+ "in": "path",
+ "name": "name",
+ "description": "A list of analytics collections to limit the returned information",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ },
+ "style": "simple"
+ },
+ "search_application.search-name": {
+ "in": "path",
+ "name": "name",
+ "description": "The name of the search application to be searched.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Name"
+ },
+ "style": "simple"
+ },
+ "search_application.search-typed_keys": {
+ "in": "query",
+ "name": "typed_keys",
+ "description": "Determines whether aggregation names are prefixed by their respective types in the response.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "x-state": "Generally available",
+ "style": "form"
+ },
+ "search_mvt-index": {
+ "in": "path",
+ "name": "index",
+ "description": "Comma-separated list of data streams, indices, or aliases to search",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ "search_mvt-field": {
+ "in": "path",
+ "name": "field",
+ "description": "Field containing geospatial data to return",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Field"
+ },
+ "style": "simple"
+ },
+ "search_mvt-zoom": {
+ "in": "path",
+ "name": "zoom",
+ "description": "Zoom level for the vector tile to search",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_global.search_mvt._types.ZoomLevel"
+ },
+ "style": "simple"
+ },
+ "search_mvt-x": {
+ "in": "path",
+ "name": "x",
+ "description": "X coordinate for the vector tile to search",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_global.search_mvt._types.Coordinate"
+ },
+ "style": "simple"
+ },
+ "search_mvt-y": {
+ "in": "path",
+ "name": "y",
+ "description": "Y coordinate for the vector tile to search",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_global.search_mvt._types.Coordinate"
+ },
+ "style": "simple"
+ },
+ "search_mvt-exact_bounds": {
+ "in": "query",
+ "name": "exact_bounds",
+ "description": "If `false`, the meta layer's feature is the bounding box of the tile.\nIf true, the meta layer's feature is a bounding box resulting from a\ngeo_bounds aggregation. The aggregation runs on values that intersect\nthe // tile with wrap_longitude set to false. The resulting\nbounding box may be larger than the vector tile.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "search_mvt-extent": {
+ "in": "query",
+ "name": "extent",
+ "description": "The size, in pixels, of a side of the tile. Vector tiles are square with equal sides.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "search_mvt-grid_agg": {
+ "in": "query",
+ "name": "grid_agg",
+ "description": "Aggregation used to create a grid for `field`.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_global.search_mvt._types.GridAggregationType"
+ },
+ "style": "form"
+ },
+ "search_mvt-grid_precision": {
+ "in": "query",
+ "name": "grid_precision",
+ "description": "Additional zoom levels available through the aggs layer. For example, if is 7\nand grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results\ndon't include the aggs layer.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "search_mvt-grid_type": {
+ "in": "query",
+ "name": "grid_type",
+ "description": "Determines the geometry type for features in the aggs layer. In the aggs layer,\neach feature represents a geotile_grid cell. If 'grid' each feature is a Polygon\nof the cells bounding box. If 'point' each feature is a Point that is the centroid\nof the cell.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_global.search_mvt._types.GridType"
+ },
+ "style": "form"
+ },
+ "search_mvt-size": {
+ "in": "query",
+ "name": "size",
+ "description": "Maximum number of features to return in the hits layer. Accepts 0-10000.\nIf 0, results don't include the hits layer.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "search_mvt-track_total_hits": {
+ "in": "query",
+ "name": "track_total_hits",
+ "description": "The number of hits matching the query to count accurately.\nIf `true`, the exact number of hits is returned at the cost of some performance.\nIf `false`, the response does not include the total number of hits matching the query.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_global.search._types.TrackHits"
+ },
+ "style": "form"
+ },
+ "search_mvt-with_labels": {
+ "in": "query",
+ "name": "with_labels",
+ "description": "If `true`, the hits and aggs layers will contain additional point features representing\nsuggested label positions for the original features.\n\n* `Point` and `MultiPoint` features will have one of the points selected.\n* `Polygon` and `MultiPolygon` features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree.\n* `LineString` features will likewise provide a roughly central point selected from the triangle-tree.\n* The aggregation results will provide one central point for each aggregation bucket.\n\nAll attributes from the original features will also be copied to the new label features.\nIn addition, the new features will be distinguishable using the tag `_mvt_label_position`.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "search_template-index": {
+ "in": "path",
+ "name": "index",
+ "description": "A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Indices"
+ },
+ "style": "simple"
+ },
+ "search_template-allow_no_indices": {
+ "in": "query",
+ "name": "allow_no_indices",
+ "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`.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "search_template-ccs_minimize_roundtrips": {
+ "in": "query",
+ "name": "ccs_minimize_roundtrips",
+ "description": "If `true`, network round-trips are minimized for cross-cluster search requests.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "search_template-expand_wildcards": {
+ "in": "query",
+ "name": "expand_wildcards",
+ "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.\nSupports comma-separated values, such as `open,hidden`.\n\nSupported values include:\n - `all`: Match any data stream or index, including hidden ones.\n - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n - `none`: Wildcard expressions are not accepted.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.ExpandWildcards"
+ },
+ "style": "form"
+ },
+ "search_template-explain": {
+ "in": "query",
+ "name": "explain",
+ "description": "If `true`, the response includes additional details about score computation as part of a hit.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "search_template-ignore_throttled": {
+ "in": "query",
+ "name": "ignore_throttled",
+ "description": "If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled.",
+ "deprecated": true,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "search_template-ignore_unavailable": {
+ "in": "query",
+ "name": "ignore_unavailable",
+ "description": "If `false`, the request returns an error if it targets a missing or closed index.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "search_template-preference": {
+ "in": "query",
+ "name": "preference",
+ "description": "The node or shard the operation should be performed on.\nIt is random by default.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "search_template-profile": {
+ "in": "query",
+ "name": "profile",
+ "description": "If `true`, the query execution is profiled.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "search_template-routing": {
+ "in": "query",
+ "name": "routing",
+ "description": "A custom value used to route operations to a specific shard.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Routing"
+ },
+ "style": "form"
+ },
+ "search_template-scroll": {
+ "in": "query",
+ "name": "scroll",
+ "description": "Specifies how long a consistent view of the index\nshould be maintained for scrolled search.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ },
+ "search_template-search_type": {
+ "in": "query",
+ "name": "search_type",
+ "description": "The type of the search operation.\n\nSupported values include:\n - `query_then_fetch`: Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.\n - `dfs_query_then_fetch`: Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.SearchType"
+ },
+ "style": "form"
+ },
+ "search_template-rest_total_hits_as_int": {
+ "in": "query",
+ "name": "rest_total_hits_as_int",
+ "description": "If `true`, `hits.total` is rendered as an integer in the response.\nIf `false`, it is rendered as an object.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "x-state": "Generally available",
+ "style": "form"
+ },
+ "search_template-typed_keys": {
+ "in": "query",
+ "name": "typed_keys",
+ "description": "If `true`, the response prefixes aggregation and suggester names with their respective types.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "security.create_api_key-refresh": {
+ "in": "query",
+ "name": "refresh",
+ "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Refresh"
+ },
+ "style": "form"
+ },
+ "security.get_role-name": {
+ "in": "path",
+ "name": "name",
+ "description": "The name of the role.\nYou can specify multiple roles as a comma-separated list.\nIf you do not specify this parameter, the API returns information about all roles.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Names"
+ },
+ "style": "simple"
+ },
+ "security.has_privileges-user": {
+ "in": "path",
+ "name": "user",
+ "description": "Username",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Name"
+ },
+ "style": "simple"
+ },
+ "security.put_role-name": {
+ "in": "path",
+ "name": "name",
+ "description": "The name of the role that is being created or updated. On Elasticsearch Serverless, the role name must begin with a letter or digit and can only contain letters, digits and the characters '_', '-', and '.'. Each role must have a unique name, as this will serve as the identifier for that role.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Name"
+ },
+ "style": "simple"
+ },
+ "security.put_role-refresh": {
+ "in": "query",
+ "name": "refresh",
+ "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Refresh"
+ },
+ "style": "form"
+ },
+ "security.query_api_keys-with_limited_by": {
+ "in": "query",
+ "name": "with_limited_by",
+ "description": "Return the snapshot of the owner user's role descriptors associated with the API key.\nAn API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors (effectively limited by it).\nAn API key cannot retrieve any API key’s limited-by role descriptors (including itself) unless it has `manage_api_key` or higher privileges.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "x-state": "Generally available",
+ "style": "form"
+ },
+ "security.query_api_keys-with_profile_uid": {
+ "in": "query",
+ "name": "with_profile_uid",
+ "description": "Determines whether to also retrieve the profile UID for the API key owner principal.\nIf it exists, the profile UID is returned under the `profile_uid` response field for each API key.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "x-state": "Generally available",
+ "style": "form"
+ },
+ "security.query_api_keys-typed_keys": {
+ "in": "query",
+ "name": "typed_keys",
+ "description": "Determines whether aggregation names are prefixed by their respective types in the response.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "x-state": "Generally available",
+ "style": "form"
+ },
+ "sql.query-format": {
+ "in": "query",
+ "name": "format",
+ "description": "The format for the response.\nYou can also specify a format using the `Accept` HTTP header.\nIf you specify both this parameter and the `Accept` HTTP header, this parameter takes precedence.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/sql.query.SqlFormat"
+ },
+ "style": "form"
+ },
+ "terms_enum-index": {
+ "in": "path",
+ "name": "index",
+ "description": "A comma-separated list of data streams, indices, and index aliases to search.\nWildcard (`*`) expressions are supported.\nTo search all data streams or indices, omit this parameter or use `*` or `_all`.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.IndexName"
+ },
+ "style": "simple"
+ },
+ "termvectors-index": {
+ "in": "path",
+ "name": "index",
+ "description": "The name of the index that contains the document.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.IndexName"
+ },
+ "style": "simple"
+ },
+ "termvectors-id": {
+ "in": "path",
+ "name": "id",
+ "description": "A unique identifier for the document.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "termvectors-fields": {
+ "in": "query",
+ "name": "fields",
+ "description": "A comma-separated list or wildcard expressions of fields to include in the statistics.\nIt is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Fields"
+ },
+ "style": "form"
+ },
+ "termvectors-field_statistics": {
+ "in": "query",
+ "name": "field_statistics",
+ "description": "If `true`, the response includes:\n\n* The document count (how many documents contain this field).\n* The sum of document frequencies (the sum of document frequencies for all terms in this field).\n* The sum of total term frequencies (the sum of total term frequencies of each term in this field).",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "termvectors-offsets": {
+ "in": "query",
+ "name": "offsets",
+ "description": "If `true`, the response includes term offsets.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "termvectors-payloads": {
+ "in": "query",
+ "name": "payloads",
+ "description": "If `true`, the response includes term payloads.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "termvectors-positions": {
+ "in": "query",
+ "name": "positions",
+ "description": "If `true`, the response includes term positions.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "termvectors-preference": {
+ "in": "query",
+ "name": "preference",
+ "description": "The node or shard the operation should be performed on.\nIt is random by default.",
+ "deprecated": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form"
+ },
+ "termvectors-realtime": {
+ "in": "query",
+ "name": "realtime",
+ "description": "If true, the request is real-time as opposed to near-real-time.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "termvectors-routing": {
+ "in": "query",
+ "name": "routing",
+ "description": "A custom value that is used to route operations to a specific shard.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Routing"
+ },
+ "style": "form"
+ },
+ "termvectors-term_statistics": {
+ "in": "query",
+ "name": "term_statistics",
+ "description": "If `true`, the response includes:\n\n* The total term frequency (how often a term occurs in all documents).\n* The document frequency (the number of documents containing the current term).\n\nBy default these values are not returned since term statistics can have a serious performance impact.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "termvectors-version": {
+ "in": "query",
+ "name": "version",
+ "description": "If `true`, returns the document version as part of a hit.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ },
+ "style": "form"
+ },
+ "termvectors-version_type": {
+ "in": "query",
+ "name": "version_type",
+ "description": "The version type.\n\nSupported values include:\n - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n - `force`: This option is deprecated because it can cause primary and replica shards to diverge.\n\n",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.VersionType"
+ },
+ "style": "form"
+ },
+ "transform.get_transform-transform_id": {
+ "in": "path",
+ "name": "transform_id",
+ "description": "Identifier for the transform. It can be a transform identifier or a\nwildcard expression. You can get information for all transforms by using\n`_all`, by specifying `*` as the ``, or by omitting the\n``.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Names"
+ },
+ "style": "simple"
+ },
+ "transform.get_transform-allow_no_match": {
+ "in": "query",
+ "name": "allow_no_match",
+ "description": "Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no transforms that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf this parameter is false, the request returns a 404 status code when\nthere are no matches or only partial matches.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "transform.get_transform-from": {
+ "in": "query",
+ "name": "from",
+ "description": "Skips the specified number of transforms.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "transform.get_transform-size": {
+ "in": "query",
+ "name": "size",
+ "description": "Specifies the maximum number of transforms to obtain.",
+ "deprecated": false,
+ "schema": {
+ "type": "number"
+ },
+ "style": "form"
+ },
+ "transform.get_transform-exclude_generated": {
+ "in": "query",
+ "name": "exclude_generated",
+ "description": "Excludes fields that were automatically added when creating the\ntransform. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.",
+ "deprecated": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ "transform.preview_transform-transform_id": {
+ "in": "path",
+ "name": "transform_id",
+ "description": "Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform\nconfiguration details in the request body.",
+ "required": true,
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Id"
+ },
+ "style": "simple"
+ },
+ "transform.preview_transform-timeout": {
+ "in": "query",
+ "name": "timeout",
+ "description": "Period to wait for a response. If no response is received before the\ntimeout expires, the request fails and returns an error.",
+ "deprecated": false,
+ "schema": {
+ "$ref": "#/components/schemas/_types.Duration"
+ },
+ "style": "form"
+ }
+ },
+ "requestBodies": {
+ "async_search.submit": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "aggregations": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.AggregationContainer"
+ }
+ },
+ "collapse": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.FieldCollapse"
+ }
+ ]
+ },
+ "explain": {
+ "description": "If true, returns detailed information about score computation as part of a hit.",
+ "default": false,
+ "type": "boolean"
+ },
+ "ext": {
+ "description": "Configuration of search extensions defined by Elasticsearch plugins.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "from": {
+ "description": "Starting document offset. By default, you cannot page through more than 10,000\nhits using the from and size parameters. To page through more hits, use the\nsearch_after parameter.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "highlight": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.Highlight"
+ }
+ ]
+ },
+ "track_total_hits": {
+ "description": "Number of hits matching the query to count accurately. If true, the exact\nnumber of hits is returned at the cost of some performance. If false, the\nresponse does not include the total number of hits matching the query.\nDefaults to 10,000 hits.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.TrackHits"
+ }
+ ]
+ },
+ "indices_boost": {
+ "description": "Boosts the _score of documents from specified indices.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "number"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ }
+ },
+ "docvalue_fields": {
+ "description": "Array of wildcard (*) patterns. The request returns doc values for field\nnames matching these patterns in the hits.fields property of the response.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
+ }
+ },
+ "knn": {
+ "description": "Defines the approximate kNN search to run.",
+ "x-state": "Generally available",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.KnnSearch"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.KnnSearch"
+ }
+ }
+ ]
+ },
+ "min_score": {
+ "description": "Minimum _score for matching documents. Documents with a lower _score are\nnot included in search results and results collected by aggregations.",
+ "type": "number"
+ },
+ "post_filter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "profile": {
+ "type": "boolean"
+ },
+ "query": {
+ "description": "Defines the search definition using the Query DSL.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "rescore": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.Rescore"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.Rescore"
+ }
+ }
+ ]
+ },
+ "script_fields": {
+ "description": "Retrieve a script evaluation (based on different fields) for each hit.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.ScriptField"
+ }
+ },
+ "search_after": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SortResults"
+ }
+ ]
+ },
+ "size": {
+ "description": "The number of hits to return. By default, you cannot page through more\nthan 10,000 hits using the from and size parameters. To page through more\nhits, use the search_after parameter.",
+ "default": 10.0,
+ "type": "number"
+ },
+ "slice": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SlicedScroll"
+ }
+ ]
+ },
+ "sort": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Sort"
+ }
+ ]
+ },
+ "_source": {
+ "description": "Indicates which source fields are returned for matching documents. These\nfields are returned in the hits._source property of the search response.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.SourceConfig"
+ }
+ ]
+ },
+ "fields": {
+ "description": "Array of wildcard (*) patterns. The request returns values for field names\nmatching these patterns in the hits.fields property of the response.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
+ }
+ },
+ "suggest": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.Suggester"
+ }
+ ]
+ },
+ "terminate_after": {
+ "description": "Maximum number of documents to collect for each shard. If a query reaches this\nlimit, Elasticsearch terminates the query early. Elasticsearch collects documents\nbefore sorting. Defaults to 0, which does not terminate query execution early.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "timeout": {
+ "description": "Specifies the period of time to wait for a response from each shard. If no response\nis received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.",
+ "type": "string"
+ },
+ "track_scores": {
+ "description": "If true, calculate and return document scores, even if the scores are not used for sorting.",
+ "default": false,
+ "type": "boolean"
+ },
+ "version": {
+ "description": "If true, returns document version as part of a hit.",
+ "default": false,
+ "type": "boolean"
+ },
+ "seq_no_primary_term": {
+ "description": "If true, returns sequence number and primary term of the last modification\nof each hit. See Optimistic concurrency control.",
+ "type": "boolean"
+ },
+ "stored_fields": {
+ "description": "List of stored fields to return as part of a hit. If no fields are specified,\nno stored fields are included in the response. If this field is specified, the _source\nparameter defaults to false. You can pass _source: true to return both source fields\nand stored fields in the search response.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ },
+ "pit": {
+ "description": "Limits the search to a point in time (PIT). If you provide a PIT, you\ncannot specify an in the request path.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.PointInTimeReference"
+ }
+ ]
+ },
+ "runtime_mappings": {
+ "description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RuntimeFields"
+ }
+ ]
+ },
+ "stats": {
+ "description": "Stats groups to associate with the search. Each group maintains a statistics\naggregation for its associated searches. You can retrieve these stats using\nthe indices stats API.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "AsyncSearchSubmitRequestExample1": {
+ "description": "Perform a search request asynchronously with `POST /sales*/_async_search?size=0`. It accepts the same parameters and request body as the search API.\n",
+ "value": "{\n \"sort\": [\n { \"date\": { \"order\": \"asc\" } }\n ],\n \"aggs\": {\n \"sale_date\": {\n \"date_histogram\": {\n \"field\": \"date\",\n \"calendar_interval\": \"1d\"\n }\n }\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "bulk": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_global.bulk.OperationContainer"
+ },
+ {
+ "$ref": "#/components/schemas/_global.bulk.UpdateAction"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ }
+ },
+ "examples": {
+ "BulkRequestExample1": {
+ "summary": "Multiple operations",
+ "description": "Run `POST _bulk` to perform multiple operations.",
+ "value": "{ \"index\" : { \"_index\" : \"test\", \"_id\" : \"1\" } }\n{ \"field1\" : \"value1\" }\n{ \"delete\" : { \"_index\" : \"test\", \"_id\" : \"2\" } }\n{ \"create\" : { \"_index\" : \"test\", \"_id\" : \"3\" } }\n{ \"field1\" : \"value3\" }\n{ \"update\" : {\"_id\" : \"1\", \"_index\" : \"test\"} }\n{ \"doc\" : {\"field2\" : \"value2\"} }"
+ },
+ "BulkRequestExample2": {
+ "summary": "Bulk updates",
+ "description": "When you run `POST _bulk` and use the `update` action, you can use `retry_on_conflict` as a field in the action itself (not in the extra payload line) to specify how many times an update should be retried in the case of a version conflict.\n",
+ "value": "{ \"update\" : {\"_id\" : \"1\", \"_index\" : \"index1\", \"retry_on_conflict\" : 3} }\n{ \"doc\" : {\"field\" : \"value\"} }\n{ \"update\" : { \"_id\" : \"0\", \"_index\" : \"index1\", \"retry_on_conflict\" : 3} }\n{ \"script\" : { \"source\": \"ctx._source.counter += params.param1\", \"lang\" : \"painless\", \"params\" : {\"param1\" : 1}}, \"upsert\" : {\"counter\" : 1}}\n{ \"update\" : {\"_id\" : \"2\", \"_index\" : \"index1\", \"retry_on_conflict\" : 3} }\n{ \"doc\" : {\"field\" : \"value\"}, \"doc_as_upsert\" : true }\n{ \"update\" : {\"_id\" : \"3\", \"_index\" : \"index1\", \"_source\" : true} }\n{ \"doc\" : {\"field\" : \"value\"} }\n{ \"update\" : {\"_id\" : \"4\", \"_index\" : \"index1\"} }\n{ \"doc\" : {\"field\" : \"value\"}, \"_source\": true}"
+ },
+ "BulkRequestExample3": {
+ "summary": "Filter for failed operations",
+ "description": "To return only information about failed operations, run `POST /_bulk?filter_path=items.*.error`.\n",
+ "value": "{ \"update\": {\"_id\": \"5\", \"_index\": \"index1\"} }\n{ \"doc\": {\"my_field\": \"foo\"} }\n{ \"update\": {\"_id\": \"6\", \"_index\": \"index1\"} }\n{ \"doc\": {\"my_field\": \"foo\"} }\n{ \"create\": {\"_id\": \"7\", \"_index\": \"index1\"} }\n{ \"my_field\": \"foo\" }"
+ },
+ "BulkRequestExample4": {
+ "summary": "Dynamic templates",
+ "description": "Run `POST /_bulk` to perform a bulk request that consists of index and create actions with the `dynamic_templates` parameter. The bulk request creates two new fields `work_location` and `home_location` with type `geo_point` according to the `dynamic_templates` parameter. However, the `raw_location` field is created using default dynamic mapping rules, as a text field in that case since it is supplied as a string in the JSON document.\n",
+ "value": "{ \"index\" : { \"_index\" : \"my_index\", \"_id\" : \"1\", \"dynamic_templates\": {\"work_location\": \"geo_point\"}} }\n{ \"field\" : \"value1\", \"work_location\": \"41.12,-71.34\", \"raw_location\": \"41.12,-71.34\"}\n{ \"create\" : { \"_index\" : \"my_index\", \"_id\" : \"2\", \"dynamic_templates\": {\"home_location\": \"geo_point\"}} }\n{ \"field\" : \"value2\", \"home_location\": \"41.12,-71.34\"}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "clear_scroll": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "scroll_id": {
+ "description": "The scroll IDs to clear.\nTo clear all scroll IDs, use `_all`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScrollIds"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "ClearScrollRequestExample1": {
+ "description": "Run `DELETE /_search/scroll` to clear the search context and results for a scrolling search.",
+ "value": "{\n \"scroll_id\": \"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==\"\n}"
+ }
+ }
+ }
+ }
+ },
+ "cluster.put_component_template": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "template": {
+ "description": "The template to be applied which includes mappings, settings, or aliases configuration.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.IndexState"
+ }
+ ]
+ },
+ "version": {
+ "description": "Version number used to manage component templates externally.\nThis number isn't automatically generated or incremented by Elasticsearch.\nTo unset a version, replace the template without specifying a version.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ }
+ ]
+ },
+ "_meta": {
+ "description": "Optional user metadata about the component template.\nIt may have any contents. This map is not automatically generated by Elasticsearch.\nThis information is stored in the cluster state, so keeping it short is preferable.\nTo unset `_meta`, replace the template without specifying this information.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ },
+ "deprecated": {
+ "description": "Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "template"
+ ]
+ },
+ "examples": {
+ "ClusterPutComponentTemplateRequestExample1": {
+ "summary": "Create a template",
+ "value": "{\n \"template\": null,\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"mappings\": {\n \"_source\": {\n \"enabled\": false\n },\n \"properties\": {\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n }\n }\n}"
+ },
+ "ClusterPutComponentTemplateRequestExample2": {
+ "summary": "Create a template with aliases",
+ "description": "You can include index aliases in a component template. During index creation, the `{index}` placeholder in the alias name will be replaced with the actual index name that the template gets applied to.\n",
+ "value": "{\n \"template\": null,\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"aliases\": {\n \"alias1\": {},\n \"alias2\": {\n \"filter\": {\n \"term\": {\n \"user.id\": \"kimchy\"\n }\n },\n \"routing\": \"shard-1\"\n },\n \"{index}-alias\": {}\n }\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "connector.put": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "index_name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.IndexName"
+ }
+ ]
+ },
+ "is_native": {
+ "type": "boolean"
+ },
+ "language": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "service_type": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "ConnectorPutRequestExample1": {
+ "value": "{\n \"index_name\": \"search-google-drive\",\n \"name\": \"My Connector\",\n \"service_type\": \"google_drive\"\n}"
+ },
+ "ConnectorPutRequestExample2": {
+ "value": "{\n \"index_name\": \"search-google-drive\",\n \"name\": \"My Connector\",\n \"description\": \"My Connector to sync data to Elastic index from Google Drive\",\n \"service_type\": \"google_drive\",\n \"language\": \"english\"\n}"
+ }
+ }
+ }
+ }
+ },
+ "count": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "query": {
+ "description": "Defines the search query using Query DSL. A request body query cannot be used\nwith the `q` query string parameter.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "CountRequestExample1": {
+ "description": "Run `GET /my-index-000001/_count?q=user:kimchy`. Alternatively, run `GET /my-index-000001/_count` with the same query in the request body. Both requests count the number of documents in `my-index-000001` with a `user.id` of `kimchy`.\n",
+ "value": "{\n \"query\" : {\n \"term\" : { \"user.id\" : \"kimchy\" }\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "create": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ },
+ "examples": {
+ "CreateRequestExample1": {
+ "description": "Run `PUT my-index-000001/_create/1` to index a document into the `my-index-000001` index if no document with that ID exists.\n",
+ "value": "{\n \"@timestamp\": \"2099-11-15T13:12:00\",\n \"message\": \"GET /search HTTP/1.1 200 1070000\",\n \"user\": {\n \"id\": \"kimchy\"\n }\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "eql.search": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "query": {
+ "description": "EQL query you wish to run.",
+ "type": "string"
+ },
+ "case_sensitive": {
+ "type": "boolean"
+ },
+ "event_category_field": {
+ "description": "Field containing the event classification, such as process, file, or network.",
+ "default": "event.category",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "tiebreaker_field": {
+ "description": "Field used to sort hits with the same timestamp in ascending order",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "timestamp_field": {
+ "description": "Field containing event timestamp. Default \"@timestamp\"",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "fetch_size": {
+ "description": "Maximum number of events to search at a time for sequence queries.",
+ "default": 1000.0,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.uint"
+ }
+ ]
+ },
+ "filter": {
+ "description": "Query, written in Query DSL, used to filter the events on which the EQL query runs.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ }
+ ]
+ },
+ "keep_alive": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "keep_on_completion": {
+ "type": "boolean"
+ },
+ "wait_for_completion_timeout": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "allow_partial_search_results": {
+ "description": "Allow query execution also in case of shard failures.\nIf true, the query will keep running and will return results based on the available shards.\nFor sequences, the behavior can be further refined using allow_partial_sequence_results",
+ "default": true,
+ "type": "boolean"
+ },
+ "allow_partial_sequence_results": {
+ "description": "This flag applies only to sequences and has effect only if allow_partial_search_results=true.\nIf true, the sequence query will return results based on the available shards, ignoring the others.\nIf false, the sequence query will return successfully, but will always have empty results.",
+ "default": false,
+ "type": "boolean"
+ },
+ "size": {
+ "description": "For basic queries, the maximum number of matching events to return. Defaults to 10",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.uint"
+ }
+ ]
+ },
+ "fields": {
+ "description": "Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
+ }
+ }
+ ]
+ },
+ "result_position": {
+ "description": "\n\nSupported values include:\n - `tail`: Return the most recent matches, similar to the Unix tail command.\n - `head`: Return the earliest matches, similar to the Unix head command.\n\n",
+ "default": "tail",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/eql.search.ResultPosition"
+ }
+ ]
+ },
+ "runtime_mappings": {
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RuntimeFields"
+ }
+ ]
+ },
+ "max_samples_per_key": {
+ "description": "By default, the response of a sample query contains up to `10` samples, with one sample per unique set of join keys. Use the `size`\nparameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the\n`max_samples_per_key` parameter. Pipes are not supported for sample queries.",
+ "default": 1.0,
+ "type": "number"
+ }
+ },
+ "required": [
+ "query"
+ ]
+ },
+ "examples": {
+ "EqlSearchRequestExample1": {
+ "summary": "Basic query",
+ "description": "Run `GET /my-data-stream/_eql/search` to search for events that have a `process.name` of `cmd.exe` and a `process.pid` other than `2013`.\n",
+ "value": "{\n \"query\": \"\"\"\n process where (process.name == \"cmd.exe\" and process.pid != 2013)\n \"\"\"\n}"
+ },
+ "EqlSearchRequestExample2": {
+ "summary": "Sequence query",
+ "description": "Run `GET /my-data-stream/_eql/search` to search for a sequence of events. The sequence starts with an event with an `event.category` of `file`, a `file.name` of `cmd.exe`, and a `process.pid` other than `2013`. It is followed by an event with an `event.category` of `process` and a `process.executable` that contains the substring `regsvr32`. These events must also share the same `process.pid` value.\n",
+ "value": "{\n \"query\": \"\"\"\n sequence by process.pid\n [ file where file.name == \"cmd.exe\" and process.pid != 2013 ]\n [ process where stringContains(process.executable, \"regsvr32\") ]\n \"\"\"\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "explain": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "query": {
+ "description": "Defines the search definition using the Query DSL.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "ExplainRequestExample1": {
+ "description": "Run `GET /my-index-000001/_explain/0` with the request body. Alternatively, run `GET /my-index-000001/_explain/0?q=message:elasticsearch`\n",
+ "value": "{\n \"query\" : {\n \"match\" : { \"message\" : \"elasticsearch\" }\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "field_caps": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "fields": {
+ "description": "A list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ },
+ "index_filter": {
+ "description": "Filter indices if the provided query rewrites to `match_none` on every shard.\n\nIMPORTANT: The filtering is done on a best-effort basis, it uses index statistics and mappings to rewrite queries to `match_none` instead of fully running the request.\nFor instance a range query over a date field can rewrite to `match_none` if all documents within a shard (including deleted documents) are outside of the provided range.\nHowever, not all queries can rewrite to `match_none` so this API may return an index even if the provided filter matches no document.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "runtime_mappings": {
+ "description": "Define ad-hoc runtime fields in the request similar to the way it is done in search requests.\nThese fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RuntimeFields"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "FieldCapabilitiesRequestExample1": {
+ "description": "Run `POST my-index-*/_field_caps?fields=rating` to get field capabilities and filter indices with a query. Indices that rewrite the provided filter to `match_none` on every shard will be filtered from the response.\n",
+ "value": "{\n \"index_filter\": {\n \"range\": {\n \"@timestamp\": {\n \"gte\": \"2018\"\n }\n }\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "graph.explore": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "connections": {
+ "description": "Specifies or more fields from which you want to extract terms that are associated with the specified vertices.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/graph._types.Hop"
+ }
+ ]
+ },
+ "controls": {
+ "description": "Direct the Graph API how to build the graph.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/graph._types.ExploreControls"
+ }
+ ]
+ },
+ "query": {
+ "description": "A seed query that identifies the documents of interest. Can be any valid Elasticsearch query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "vertices": {
+ "description": "Specifies one or more fields that contain the terms you want to include in the graph as vertices.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/graph._types.VertexDefinition"
+ }
+ }
+ }
+ },
+ "examples": {
+ "GraphExploreRequestExample1": {
+ "description": "Run `POST clicklogs/_graph/explore` for a basic exploration An initial graph explore query typically begins with a query to identify strongly related terms. Seed the exploration with a query. This example is searching `clicklogs` for people who searched for the term `midi`.Identify the vertices to include in the graph. This example is looking for product codes that are significantly associated with searches for `midi`. Find the connections. This example is looking for other search terms that led people to click on the products that are associated with searches for `midi`.\n",
+ "value": "{\n \"query\": {\n \"match\": {\n \"query.raw\": \"midi\"\n }\n },\n \"vertices\": [\n {\n \"field\": \"product\"\n }\n ],\n \"connections\": {\n \"vertices\": [\n {\n \"field\": \"query.raw\"\n }\n ]\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "index": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ },
+ "examples": {
+ "IndexRequestExample1": {
+ "summary": "Automate document IDs",
+ "description": "Run `POST my-index-000001/_doc/` to index a document. When you use the `POST //_doc/` request format, the `op_type` is automatically set to `create` and the index operation generates a unique ID for the document.\n",
+ "value": "{\n \"@timestamp\": \"2099-11-15T13:12:00\",\n \"message\": \"GET /search HTTP/1.1 200 1070000\",\n \"user\": {\n \"id\": \"kimchy\"\n }\n}"
+ },
+ "IndexRequestExample2": {
+ "summary": "Define document IDs",
+ "description": "Run `PUT my-index-000001/_doc/1` to insert a JSON document into the `my-index-000001` index with an `_id` of 1.\n",
+ "value": "{\n \"@timestamp\": \"2099-11-15T13:12:00\",\n \"message\": \"GET /search HTTP/1.1 200 1070000\",\n \"user\": {\n \"id\": \"kimchy\"\n }\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "indices.analyze": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "analyzer": {
+ "description": "The name of the analyzer that should be applied to the provided `text`.\nThis could be a built-in analyzer, or an analyzer that’s been configured in the index.",
+ "type": "string"
+ },
+ "attributes": {
+ "description": "Array of token attributes used to filter the output of the `explain` parameter.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "char_filter": {
+ "description": "Array of character filters used to preprocess characters before the tokenizer.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.analysis.CharFilter"
+ }
+ },
+ "explain": {
+ "description": "If `true`, the response includes token attributes and additional details.",
+ "default": false,
+ "type": "boolean"
+ },
+ "field": {
+ "description": "Field used to derive the analyzer.\nTo use this parameter, you must specify an index.\nIf specified, the `analyzer` parameter overrides this value.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "filter": {
+ "description": "Array of token filters used to apply after the tokenizer.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.analysis.TokenFilter"
+ }
+ },
+ "normalizer": {
+ "description": "Normalizer to use to convert text into a single token.",
+ "type": "string"
+ },
+ "text": {
+ "description": "Text to analyze.\nIf an array of strings is provided, it is analyzed as a multi-value field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices.analyze.TextToAnalyze"
+ }
+ ]
+ },
+ "tokenizer": {
+ "description": "Tokenizer to use to convert text into tokens.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.analysis.Tokenizer"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "indicesAnalyzeRequestExample1": {
+ "summary": "No index specified",
+ "description": "You can apply any of the built-in analyzers to the text string without specifying an index.",
+ "value": "{\n \"analyzer\": \"standard\",\n \"text\": \"this is a test\"\n}"
+ },
+ "indicesAnalyzeRequestExample2": {
+ "summary": "An array of text strings",
+ "description": "If the text parameter is provided as array of strings, it is analyzed as a multi-value field.",
+ "value": "{\n \"analyzer\": \"standard\",\n \"text\": [\n \"this is a test\",\n \"the second text\"\n ]\n}"
+ },
+ "indicesAnalyzeRequestExample3": {
+ "summary": "Custom analyzer example 1",
+ "description": "You can test a custom transient analyzer built from tokenizers, token filters, and char filters. Token filters use the filter parameter.",
+ "value": "{\n \"tokenizer\": \"keyword\",\n \"filter\": [\n \"lowercase\"\n ],\n \"char_filter\": [\n \"html_strip\"\n ],\n \"text\": \"this is a test\"\n}"
+ },
+ "indicesAnalyzeRequestExample4": {
+ "summary": "Custom analyzer example 2",
+ "description": "Custom tokenizers, token filters, and character filters can be specified in the request body.",
+ "value": "{\n \"tokenizer\": \"whitespace\",\n \"filter\": [\n \"lowercase\",\n {\n \"type\": \"stop\",\n \"stopwords\": [\n \"a\",\n \"is\",\n \"this\"\n ]\n }\n ],\n \"text\": \"this is a test\"\n}"
+ },
+ "indicesAnalyzeRequestExample5": {
+ "summary": "Derive analyzer from field mapping",
+ "description": "Run `GET /analyze_sample/_analyze` to run an analysis on the text using the default index analyzer associated with the `analyze_sample` index. Alternatively, the analyzer can be derived based on a field mapping.",
+ "value": "{\n \"field\": \"obj1.field1\",\n \"text\": \"this is a test\"\n}"
+ },
+ "indicesAnalyzeRequestExample6": {
+ "summary": "Normalizer",
+ "description": "Run `GET /analyze_sample/_analyze` and supply a normalizer for a keyword field if there is a normalizer associated with the specified index.",
+ "value": "{\n \"normalizer\": \"my_normalizer\",\n \"text\": \"BaR\"\n}"
+ },
+ "indicesAnalyzeRequestExample7": {
+ "summary": "Explain analysis",
+ "description": "If you want to get more advanced details, set `explain` to `true`. It will output all token attributes for each token. You can filter token attributes you want to output by setting the `attributes` option. NOTE: The format of the additional detail information is labelled as experimental in Lucene and it may change in the future.\n",
+ "value": "{\n \"tokenizer\": \"standard\",\n \"filter\": [\n \"snowball\"\n ],\n \"text\": \"detailed output\",\n \"explain\": true,\n \"attributes\": [\n \"keyword\"\n ]\n}"
+ }
+ }
+ }
+ }
+ },
+ "indices.put_alias": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "filter": {
+ "description": "Query used to limit documents the alias can access.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "index_routing": {
+ "description": "Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.\nData stream aliases don’t support this parameter.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Routing"
+ }
+ ]
+ },
+ "is_write_index": {
+ "description": "If `true`, sets the write index or data stream for the alias.\nIf an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests.\nIf an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index.\nData stream aliases don’t automatically set a write data stream, even if the alias points to one data stream.",
+ "type": "boolean"
+ },
+ "routing": {
+ "description": "Value used to route indexing and search operations to a specific shard.\nData stream aliases don’t support this parameter.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Routing"
+ }
+ ]
+ },
+ "search_routing": {
+ "description": "Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.\nData stream aliases don’t support this parameter.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Routing"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "indicesPutAliasRequestExample1": {
+ "value": "{\n \"actions\": [\n {\n \"add\": {\n \"index\": \"my-data-stream\",\n \"alias\": \"my-alias\"\n }\n }\n ]\n}"
+ }
+ }
+ }
+ }
+ },
+ "indices.put_index_template": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "index_patterns": {
+ "description": "Name of the index template to create.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Indices"
+ }
+ ]
+ },
+ "composed_of": {
+ "description": "An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ },
+ "template": {
+ "description": "Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices.put_index_template.IndexTemplateMapping"
+ }
+ ]
+ },
+ "data_stream": {
+ "description": "If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.DataStreamVisibility"
+ }
+ ]
+ },
+ "priority": {
+ "description": "Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.",
+ "type": "number"
+ },
+ "version": {
+ "description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.\nExternal systems can use these version numbers to simplify template management.\nTo unset a version, replace the template without specifying one.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ }
+ ]
+ },
+ "_meta": {
+ "description": "Optional user metadata about the index template.\nIt may have any contents.\nIt is not automatically generated or used by Elasticsearch.\nThis user-defined object is stored in the cluster state, so keeping it short is preferable\nTo unset the metadata, replace the template without specifying it.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ },
+ "allow_auto_create": {
+ "description": "This setting overrides the value of the `action.auto_create_index` cluster setting.\nIf set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.\nIf set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.",
+ "type": "boolean"
+ },
+ "ignore_missing_component_templates": {
+ "description": "The configuration option ignore_missing_component_templates can be used when an index template\nreferences a component template that might not exist",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": {
+ "description": "Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.",
+ "type": "boolean"
+ }
+ }
+ },
+ "examples": {
+ "IndicesPutIndexTemplateRequestExample1": {
+ "summary": "Create a template",
+ "value": "{\n \"index_patterns\" : [\"template*\"],\n \"priority\" : 1,\n \"template\": {\n \"settings\" : {\n \"number_of_shards\" : 2\n }\n }\n}"
+ },
+ "IndicesPutIndexTemplateRequestExample2": {
+ "summary": "Create a template with aliases",
+ "description": "You can include index aliases in an index template.\nDuring index creation, the `{index}` placeholder in the alias name will be replaced with the actual index name that the template gets applied to.\n",
+ "value": "{\n \"index_patterns\": [\n \"template*\"\n ],\n \"template\": {\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"aliases\": {\n \"alias1\": {},\n \"alias2\": {\n \"filter\": {\n \"term\": {\n \"user.id\": \"kimchy\"\n }\n },\n \"routing\": \"shard-1\"\n },\n \"{index}-alias\": {}\n }\n }\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "indices.put_mapping": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "date_detection": {
+ "description": "Controls whether dynamic date detection is enabled.",
+ "type": "boolean"
+ },
+ "dynamic": {
+ "description": "Controls whether new fields are added dynamically.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.DynamicMapping"
+ }
+ ]
+ },
+ "dynamic_date_formats": {
+ "description": "If date detection is enabled then new string fields are checked\nagainst 'dynamic_date_formats' and if the value matches then\na new date field is added instead of string.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "dynamic_templates": {
+ "description": "Specify dynamic templates for the mapping.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.mapping.DynamicTemplate"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ }
+ },
+ "_field_names": {
+ "description": "Control whether field names are enabled for the index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.FieldNamesField"
+ }
+ ]
+ },
+ "_meta": {
+ "description": "A mapping type can have custom meta data associated with it. These are\nnot used at all by Elasticsearch, but can be used to store\napplication-specific metadata.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ },
+ "numeric_detection": {
+ "description": "Automatically map strings into numeric data types for all fields.",
+ "default": false,
+ "type": "boolean"
+ },
+ "properties": {
+ "description": "Mapping for a field. For new fields, this mapping can include:\n\n- Field name\n- Field data type\n- Mapping parameters",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.mapping.Property"
+ }
+ },
+ "_routing": {
+ "description": "Enable making a routing value required on indexed documents.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RoutingField"
+ }
+ ]
+ },
+ "_source": {
+ "description": "Control whether the _source field is enabled on the index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.SourceField"
+ }
+ ]
+ },
+ "runtime": {
+ "description": "Mapping of runtime fields for the index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RuntimeFields"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "indicesPutMappingRequestExample1": {
+ "summary": "Update multiple targets",
+ "description": "The update mapping API can be applied to multiple data streams or indices with a single request. For example, run `PUT /my-index-000001,my-index-000002/_mapping` to update mappings for the `my-index-000001` and `my-index-000002` indices at the same time.\n",
+ "value": "{\n \"properties\": {\n \"user\": {\n \"properties\": {\n \"name\": {\n \"type\": \"keyword\"\n }\n }\n }\n }\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "indices.put_settings": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/indices._types.IndexSettings"
+ },
+ "examples": {
+ "IndicesPutSettingsRequestExample1": {
+ "summary": "Change a dynamic index setting",
+ "value": "{\n \"index\" : {\n \"number_of_replicas\" : 2\n }\n}"
+ },
+ "indicesPutSettingsRequestExample2": {
+ "summary": "Reset an index setting",
+ "description": "To revert a setting to the default value, use `null`.",
+ "value": "{\n \"index\" : {\n \"refresh_interval\" : null\n }\n}"
+ },
+ "indicesPutSettingsRequestExample3": {
+ "summary": "Update index analysis",
+ "description": "To add an analyzer, you must close the index (`POST /my-index-000001/_close`), define the analyzer, then reopen the index (`POST /my-index-000001/_open`).",
+ "value": "{\n \"analysis\": {\n \"analyzer\": {\n \"content\": {\n \"type\": \"custom\",\n \"tokenizer\": \"whitespace\"\n }\n }\n }\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "indices.rollover": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "aliases": {
+ "description": "Aliases for the target index.\nData streams do not support this parameter.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/indices._types.Alias"
+ }
+ },
+ "conditions": {
+ "description": "Conditions for the rollover.\nIf specified, Elasticsearch only performs the rollover if the current index satisfies these conditions.\nIf this parameter is not specified, Elasticsearch performs the rollover unconditionally.\nIf conditions are specified, at least one of them must be a `max_*` condition.\nThe index will rollover if any `max_*` condition is satisfied and all `min_*` conditions are satisfied.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices.rollover.RolloverConditions"
+ }
+ ]
+ },
+ "mappings": {
+ "description": "Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping paramaters.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.TypeMapping"
+ }
+ ]
+ },
+ "settings": {
+ "description": "Configuration options for the index.\nData streams do not support this parameter.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "examples": {
+ "indicesRolloverRequestExample1": {
+ "summary": "Stack request",
+ "description": "Create a new index for a data stream",
+ "value": "{\n \"conditions\": {\n \"max_age\": \"7d\",\n \"max_docs\": 1000,\n \"max_primary_shard_size\": \"50gb\",\n \"max_primary_shard_docs\": \"2000\"\n }\n}"
+ },
+ "indicesRolloverRequestExample2": {
+ "summary": "Serverless request",
+ "description": "Create a new index for a data stream",
+ "value": "{}"
+ }
+ }
+ }
+ }
+ },
+ "indices.simulate_template": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "allow_auto_create": {
+ "description": "This setting overrides the value of the `action.auto_create_index` cluster setting.\nIf set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.\nIf set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.",
+ "type": "boolean"
+ },
+ "index_patterns": {
+ "description": "Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Indices"
+ }
+ ]
+ },
+ "composed_of": {
+ "description": "An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ },
+ "template": {
+ "description": "Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices.put_index_template.IndexTemplateMapping"
+ }
+ ]
+ },
+ "data_stream": {
+ "description": "If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/indices._types.DataStreamVisibility"
+ }
+ ]
+ },
+ "priority": {
+ "description": "Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.",
+ "type": "number"
+ },
+ "version": {
+ "description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ }
+ ]
+ },
+ "_meta": {
+ "description": "Optional user metadata about the index template.\nMay have any contents.\nThis map is not automatically generated by Elasticsearch.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ },
+ "ignore_missing_component_templates": {
+ "description": "The configuration option ignore_missing_component_templates can be used when an index template\nreferences a component template that might not exist",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": {
+ "description": "Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.",
+ "type": "boolean"
+ }
+ }
+ },
+ "examples": {
+ "indicesSimulateTemplateRequestExample1": {
+ "description": "To see what settings will be applied by a template before you add it to the cluster, you can pass a template configuration in the request body. The specified template is used for the simulation if it has a higher priority than existing templates.\n",
+ "value": "{\n \"index_patterns\": [\"my-index-*\"],\n \"composed_of\": [\"ct2\"],\n \"priority\": 10,\n \"template\": {\n \"settings\": {\n \"index.number_of_replicas\": 1\n }\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "indices.validate_query": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "query": {
+ "description": "Query in the Lucene query string syntax.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "inference.inference": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "query": {
+ "description": "The query input, which is required only for the `rerank` task.\nIt is not required for other tasks.",
+ "type": "string"
+ },
+ "input": {
+ "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.",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "input_type": {
+ "description": "Specifies the input data type for the text embedding model. The `input_type` parameter only applies to Inference Endpoints with the `text_embedding` task type. Possible values include:\n* `SEARCH`\n* `INGEST`\n* `CLASSIFICATION`\n* `CLUSTERING`\nNot all services support all values. Unsupported values will trigger a validation exception.\nAccepted values depend on the configured inference service, refer to the relevant service-specific documentation for more info.\n\n> info\n> The `input_type` parameter specified on the root level of the request body will take precedence over the `input_type` parameter specified in `task_settings`.",
+ "type": "string"
+ },
+ "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.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/inference._types.TaskSettings"
+ }
+ ]
+ }
+ },
+ "required": [
+ "input"
+ ]
+ }
+ }
+ }
+ },
+ "inference.put": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/inference._types.InferenceEndpoint"
+ },
+ "examples": {
+ "InferencePutExample1": {
+ "description": "An example body for a `PUT _inference/rerank/my-rerank-model` request.",
+ "value": "{\n \"service\": \"cohere\",\n \"service_settings\": {\n \"model_id\": \"rerank-english-v3.0\",\n \"api_key\": \"{{COHERE_API_KEY}}\"\n },\n \"chunking_settings\": {\n \"strategy\": \"recursive\",\n \"max_chunk_size\": 200,\n \"separator_group\": \"markdown\"\n }\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "ingest.simulate": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "docs": {
+ "description": "Sample documents to test in the pipeline.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ingest._types.Document"
+ }
+ },
+ "pipeline": {
+ "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.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ingest._types.Pipeline"
+ }
+ ]
+ }
+ },
+ "required": [
+ "docs"
+ ]
+ },
+ "examples": {
+ "SimulatePipelineRequestExample1": {
+ "summary": "Run an ingest pipeline against a set of provided documents.",
+ "description": "You can specify the used pipeline either in the request body or as a path parameter.",
+ "value": "{\n \"pipeline\" :\n {\n \"description\": \"_description\",\n \"processors\": [\n {\n \"set\" : {\n \"field\" : \"field2\",\n \"value\" : \"_value\"\n }\n }\n ]\n },\n \"docs\": [\n {\n \"_index\": \"index\",\n \"_id\": \"id\",\n \"_source\": {\n \"foo\": \"bar\"\n }\n },\n {\n \"_index\": \"index\",\n \"_id\": \"id\",\n \"_source\": {\n \"foo\": \"rab\"\n }\n }\n ]\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "mget": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "docs": {
+ "description": "The documents you want to retrieve. Required if no index is specified in the request URI.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.mget.Operation"
+ }
+ },
+ "ids": {
+ "description": "The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Ids"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "MultiGetRequestExample1": {
+ "summary": "Get documents by ID",
+ "description": "Run `GET /my-index-000001/_mget`. When you specify an index in the request URI, only the document IDs are required in the request body.\n",
+ "value": "{\n \"docs\": [\n {\n \"_id\": \"1\"\n },\n {\n \"_id\": \"2\"\n }\n ]\n}"
+ },
+ "MultiGetRequestExample2": {
+ "summary": "Filter source fields",
+ "description": "Run `GET /_mget`. This request sets `_source` to `false` for document 1 to exclude the source entirely. It retrieves `field3` and `field4` from document 2. It retrieves the `user` field from document 3 but filters out the `user.location` field.\n",
+ "value": "{\n \"docs\": [\n {\n \"_index\": \"test\",\n \"_id\": \"1\",\n \"_source\": false\n },\n {\n \"_index\": \"test\",\n \"_id\": \"2\",\n \"_source\": [ \"field3\", \"field4\" ]\n },\n {\n \"_index\": \"test\",\n \"_id\": \"3\",\n \"_source\": {\n \"include\": [ \"user\" ],\n \"exclude\": [ \"user.location\" ]\n }\n }\n ]\n}"
+ },
+ "MultiGetRequestExample3": {
+ "summary": "Get stored fields",
+ "description": "Run `GET /_mget`. This request retrieves `field1` and `field2` from document 1 and `field3` and `field4` from document 2.\n",
+ "value": "{\n \"docs\": [\n {\n \"_index\": \"test\",\n \"_id\": \"1\",\n \"stored_fields\": [ \"field1\", \"field2\" ]\n },\n {\n \"_index\": \"test\",\n \"_id\": \"2\",\n \"stored_fields\": [ \"field3\", \"field4\" ]\n }\n ]\n}"
+ },
+ "MultiGetRequestExample4": {
+ "summary": "Document routing",
+ "description": "Run `GET /_mget?routing=key1`. If routing is used during indexing, you need to specify the routing value to retrieve documents. This request fetches `test/_doc/2` from the shard corresponding to routing key `key1`. It fetches `test/_doc/1` from the shard corresponding to routing key `key2`.\n",
+ "value": "{\n \"docs\": [\n {\n \"_index\": \"test\",\n \"_id\": \"1\",\n \"routing\": \"key2\"\n },\n {\n \"_index\": \"test\",\n \"_id\": \"2\"\n }\n ]\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "ml.get_calendars": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "page": {
+ "description": "This object is supported only when you omit the calendar identifier.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.Page"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "ml.get_overall_buckets": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "allow_no_match": {
+ "description": "Refer to the description for the `allow_no_match` query parameter.",
+ "default": true,
+ "type": "boolean"
+ },
+ "bucket_span": {
+ "description": "Refer to the description for the `bucket_span` query parameter.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "end": {
+ "description": "Refer to the description for the `end` query parameter.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "exclude_interim": {
+ "description": "Refer to the description for the `exclude_interim` query parameter.",
+ "default": false,
+ "type": "boolean"
+ },
+ "overall_score": {
+ "description": "Refer to the description for the `overall_score` query parameter.",
+ "oneOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "start": {
+ "description": "Refer to the description for the `start` query parameter.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.DateTime"
+ }
+ ]
+ },
+ "top_n": {
+ "description": "Refer to the description for the `top_n` query parameter.",
+ "default": 1.0,
+ "type": "number"
+ }
+ }
+ },
+ "examples": {
+ "MlGetOverallBucketsExample1": {
+ "description": "An example body for a `GET _ml/anomaly_detectors/job-*/results/overall_buckets` request.",
+ "value": "{\n \"overall_score\": 80,\n \"start\": \"1403532000000\"\n}"
+ }
+ }
+ }
+ }
+ },
+ "ml.preview_data_frame_analytics": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "config": {
+ "description": "A data frame analytics config as described in create data frame analytics\njobs. Note that `id` and `dest` don’t need to be provided in the context of\nthis API.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml.preview_data_frame_analytics.DataframePreviewConfig"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "MlPreviewDataFrameAnalyticsExample1": {
+ "description": "An example body for a `POST _ml/data_frame/analytics/_preview` request.",
+ "value": "{\n \"config\": {\n \"source\": {\n \"index\": \"houses_sold_last_10_yrs\"\n },\n \"analysis\": {\n \"regression\": {\n \"dependent_variable\": \"price\"\n }\n }\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "ml.preview_datafeed": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "datafeed_config": {
+ "description": "The datafeed definition to preview.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.DatafeedConfig"
+ }
+ ]
+ },
+ "job_config": {
+ "description": "The configuration details for the anomaly detection job that is associated with the datafeed. If the\n`datafeed_config` object does not include a `job_id` that references an existing anomaly detection job, you must\nsupply this `job_config` object. If you include both a `job_id` and a `job_config`, the latter information is\nused. You cannot specify a `job_config` object unless you also supply a `datafeed_config` object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ml._types.JobConfig"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "msearch": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.msearch.RequestItem"
+ }
+ },
+ "examples": {
+ "MsearchRequestExample1": {
+ "description": "An example body for a `GET my-index-000001/_msearch` request.",
+ "value": "{ }\n{\"query\" : {\"match\" : { \"message\": \"this is a test\"}}}\n{\"index\": \"my-index-000002\"}\n{\"query\" : {\"match_all\" : {}}}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "msearch_template": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.msearch_template.RequestItem"
+ }
+ },
+ "examples": {
+ "MultiSearchTemplateRequestExample1": {
+ "description": "Run `GET my-index/_msearch/template` to run multiple templated searches.",
+ "value": "{ }\n{ \"id\": \"my-search-template\", \"params\": { \"query_string\": \"hello world\", \"from\": 0, \"size\": 10 }}\n{ }\n{ \"id\": \"my-other-search-template\", \"params\": { \"query_type\": \"match_all\" }}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "mtermvectors": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "docs": {
+ "description": "An array of existing or artificial documents.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.mtermvectors.Operation"
+ }
+ },
+ "ids": {
+ "description": "A simplified syntax to specify documents by their ID if they're in the same index.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ }
+ }
+ },
+ "examples": {
+ "MultiTermVectorsRequestExample1": {
+ "summary": "Get multiple term vectors",
+ "description": "Run `POST /my-index-000001/_mtermvectors`. When you specify an index in the request URI, the index does not need to be specified for each documents in the request body.\n",
+ "value": "{\n \"docs\": [\n {\n \"_id\": \"2\",\n \"fields\": [\n \"message\"\n ],\n \"term_statistics\": true\n },\n {\n \"_id\": \"1\"\n }\n ]\n}"
+ },
+ "MultiTermVectorsRequestExample2": {
+ "summary": "Simplified syntax",
+ "description": "Run `POST /my-index-000001/_mtermvectors`. If all requested documents are in same index and the parameters are the same, you can use a simplified syntax.\n",
+ "value": "{\n \"ids\": [ \"1\", \"2\" ],\n \"fields\": [\n \"message\"\n ],\n \"term_statistics\": true\n}"
+ },
+ "MultiTermVectorsRequestExample3": {
+ "summary": "Artificial documents",
+ "description": "Run `POST /_mtermvectors` to generate term vectors for artificial documents provided in the body of the request. The mapping used is determined by the specified `_index`.\n",
+ "value": "{\n \"docs\": [\n {\n \"_index\": \"my-index-000001\",\n \"doc\" : {\n \"message\" : \"test test test\"\n }\n },\n {\n \"_index\": \"my-index-000001\",\n \"doc\" : {\n \"message\" : \"Another test ...\"\n }\n }\n ]\n}"
+ }
+ }
+ }
+ }
+ },
+ "put_script": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "script": {
+ "description": "The script or search template, its parameters, and its language.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.StoredScript"
+ }
+ ]
+ }
+ },
+ "required": [
+ "script"
+ ]
+ },
+ "examples": {
+ "PutScriptRequestExample1": {
+ "summary": "Create a search template",
+ "description": "Run `PUT _scripts/my-search-template` to create a search template.\n",
+ "value": "{\n \"script\": {\n \"lang\": \"mustache\",\n \"source\": {\n \"query\": {\n \"match\": {\n \"message\": \"{{query_string}}\"\n }\n },\n \"from\": \"{{from}}\",\n \"size\": \"{{size}}\"\n }\n }\n}"
+ },
+ "PutScriptRequestExample2": {
+ "summary": "Create a stored script",
+ "description": "Run `PUT _scripts/my-stored-script` to create a stored script.\n",
+ "value": "{\n \"script\": {\n \"lang\": \"painless\",\n \"source\": \"Math.log(_score * 2) + params['my_modifier']\"\n }\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "rank_eval": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "requests": {
+ "description": "A set of typical search requests, together with their provided ratings.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.rank_eval.RankEvalRequestItem"
+ }
+ },
+ "metric": {
+ "description": "Definition of the evaluation metric to calculate.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetric"
+ }
+ ]
+ }
+ },
+ "required": [
+ "requests"
+ ]
+ },
+ "examples": {
+ "RankEvalRequestExample1": {
+ "description": "An example body for a `GET /my-index-000001/_rank_eval` request.",
+ "value": "{\n \"requests\": [\n {\n \"id\": \"JFK query\",\n \"request\": { \"query\": { \"match_all\": {} } },\n \"ratings\": []\n } ],\n \"metric\": {\n \"precision\": {\n \"k\": 20,\n \"relevant_rating_threshold\": 1,\n \"ignore_unlabeled\": false\n }\n }\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "render_search_template": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The ID of the search template to render.\nIf no `source` is specified, this or the `` request path parameter is required.\nIf you specify both this parameter and the `` parameter, the API uses only ``.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "file": {
+ "type": "string"
+ },
+ "params": {
+ "description": "Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "source": {
+ "description": "An inline search template.\nIt supports the same parameters as the search API's request body.\nThese parameters also support Mustache variables.\nIf no `id` or `` is specified, this parameter is required.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScriptSource"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "RenderSearchTemplateRequestExample1": {
+ "description": "Run `POST _render/template`",
+ "value": "{\n \"id\": \"my-search-template\",\n \"params\": {\n \"query_string\": \"hello world\",\n \"from\": 20,\n \"size\": 10\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "scripts_painless_execute": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "context": {
+ "description": "The context that the script should run in.\nNOTE: Result ordering in the field contexts is not guaranteed.\n\nSupported values include:\n - `painless_test`: The default context if no other context is specified.\n - `filter`: Treats scripts as if they were run inside a script query.\n - `score`: Treats scripts as if they were run inside a `script_score` function in a `function_score` query.\n - `boolean_field`: The context for boolean fields. The script returns a `true` or `false` response.\n - `date_field`: The context for date fields. `emit` takes a long value and the script returns a sorted list of dates.\n - `double_field`: The context for double numeric fields. The script returns a sorted list of double values.\n - `geo_point_field`: The context for geo-point fields. `emit` takes two double parameters, the latitude and longitude values, and the script returns an object in GeoJSON format containing the coordinates for the geo point.\n - `ip_field`: The context for `ip` fields. The script returns a sorted list of IP addresses.\n - `keyword_field`: The context for keyword fields. The script returns a sorted list of string values.\n - `long_field`: The context for long numeric fields. The script returns a sorted list of long values.\n - `composite_field`: The context for composite runtime fields. The script returns a map of values.\n\n",
+ "default": "painless_test",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.scripts_painless_execute.PainlessContext"
+ }
+ ]
+ },
+ "context_setup": {
+ "description": "Additional parameters for the `context`.\nNOTE: This parameter is required for all contexts except `painless_test`, which is the default if no value is provided for `context`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.scripts_painless_execute.PainlessContextSetup"
+ }
+ ]
+ },
+ "script": {
+ "description": "The Painless script to run.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Script"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "ExecutePainlessScriptRequestExample1": {
+ "summary": "Test context",
+ "description": "Run `POST /_scripts/painless/_execute`. The `painless_test` context is the default context. It runs scripts without additional parameters. The only variable that is available is `params`, which can be used to access user defined values. The result of the script is always converted to a string.\n",
+ "value": "{\n \"script\": {\n \"source\": \"params.count / params.total\",\n \"params\": {\n \"count\": 100.0,\n \"total\": 1000.0\n }\n }\n}"
+ },
+ "ExecutePainlessScriptRequestExample2": {
+ "summary": "Filter context",
+ "description": "Run `POST /_scripts/painless/_execute` with a `filter` context. It treats scripts as if they were run inside a script query. For testing purposes, a document must be provided so that it will be temporarily indexed in-memory and is accessible from the script. More precisely, the `_source`, stored fields, and doc values of such a document are available to the script being tested.\n",
+ "value": "{\n \"script\": {\n \"source\": \"doc['field'].value.length() <= params.max_length\",\n \"params\": {\n \"max_length\": 4\n }\n },\n \"context\": \"filter\",\n \"context_setup\": {\n \"index\": \"my-index-000001\",\n \"document\": {\n \"field\": \"four\"\n }\n }\n}"
+ },
+ "ExecutePainlessScriptRequestExample3": {
+ "summary": "Score context",
+ "description": "Run `POST /_scripts/painless/_execute` with a `score` context. It treats scripts as if they were run inside a `script_score` function in a `function_score` query.\n",
+ "value": "{\n \"script\": {\n \"source\": \"doc['rank'].value / params.max_rank\",\n \"params\": {\n \"max_rank\": 5.0\n }\n },\n \"context\": \"score\",\n \"context_setup\": {\n \"index\": \"my-index-000001\",\n \"document\": {\n \"rank\": 4\n }\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "scroll": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "scroll": {
+ "description": "The period to retain the search context for scrolling.",
+ "default": "1d",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "scroll_id": {
+ "description": "The scroll ID of the search.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScrollId"
+ }
+ ]
+ }
+ },
+ "required": [
+ "scroll_id"
+ ]
+ },
+ "examples": {
+ "ScrollRequestExample1": {
+ "description": "Run `GET /_search/scroll` to get the next batch of results for a scrolling search.",
+ "value": "{\n \"scroll_id\" : \"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==\"\n}"
+ }
+ }
+ }
+ }
+ },
+ "search": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "aggregations": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/explore-analyze/query-filter/aggregations"
+ },
+ "description": "Defines the aggregations that are run as part of the search request.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.AggregationContainer"
+ }
+ },
+ "collapse": {
+ "description": "Collapses search results the values of the specified field.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.FieldCollapse"
+ }
+ ]
+ },
+ "explain": {
+ "description": "If `true`, the request returns detailed information about score computation as part of a hit.",
+ "default": false,
+ "type": "boolean"
+ },
+ "ext": {
+ "description": "Configuration of search extensions defined by Elasticsearch plugins.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "from": {
+ "description": "The starting document offset, which must be non-negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "highlight": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/highlighting"
+ },
+ "description": "Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.Highlight"
+ }
+ ]
+ },
+ "track_total_hits": {
+ "description": "Number of hits matching the query to count accurately.\nIf `true`, the exact number of hits is returned at the cost of some performance.\nIf `false`, the response does not include the total number of hits matching the query.",
+ "default": "10000",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.TrackHits"
+ }
+ ]
+ },
+ "indices_boost": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl#relevance-scores"
+ },
+ "description": "Boost the `_score` of documents from specified indices.\nThe boost value is the factor by which scores are multiplied.\nA boost value greater than `1.0` increases the score.\nA boost value between `0` and `1.0` decreases the score.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "number"
+ },
+ "minProperties": 1,
+ "maxProperties": 1
+ }
+ },
+ "docvalue_fields": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#docvalue-fields"
+ },
+ "description": "An array of wildcard (`*`) field patterns.\nThe request returns doc values for field names matching these patterns in the `hits.fields` property of the response.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
+ }
+ },
+ "knn": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/solutions/search/vector/knn#approximate-knn"
+ },
+ "description": "The approximate kNN search to run.",
+ "x-state": "Generally available",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_types.KnnSearch"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.KnnSearch"
+ }
+ }
+ ]
+ },
+ "min_score": {
+ "description": "The minimum `_score` for matching documents.\nDocuments with a lower `_score` are not included in search results and results collected by aggregations.",
+ "type": "number"
+ },
+ "post_filter": {
+ "description": "Use the `post_filter` parameter to filter search results.\nThe search hits are filtered after the aggregations are calculated.\nA post filter has no impact on the aggregation results.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "profile": {
+ "description": "Set to `true` to return detailed timing information about the execution of individual components in a search request.\nNOTE: This is a debugging tool and adds significant overhead to search execution.",
+ "default": false,
+ "type": "boolean"
+ },
+ "query": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl"
+ },
+ "description": "The search definition using the Query DSL.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "rescore": {
+ "description": "Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.Rescore"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_global.search._types.Rescore"
+ }
+ }
+ ]
+ },
+ "retriever": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrievers"
+ },
+ "description": "A retriever is a specification to describe top documents returned from a search.\nA retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.RetrieverContainer"
+ }
+ ]
+ },
+ "script_fields": {
+ "description": "Retrieve a script evaluation (based on different fields) for each hit.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.ScriptField"
+ }
+ },
+ "search_after": {
+ "description": "Used to retrieve the next page of hits using a set of sort values from the previous page.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SortResults"
+ }
+ ]
+ },
+ "size": {
+ "description": "The number of hits to return, which must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` property.",
+ "default": 10.0,
+ "type": "number"
+ },
+ "slice": {
+ "description": "Split a scrolled search into multiple slices that can be consumed independently.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SlicedScroll"
+ }
+ ]
+ },
+ "sort": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results"
+ },
+ "description": "A comma-separated list of : pairs.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Sort"
+ }
+ ]
+ },
+ "_source": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#source-filtering"
+ },
+ "description": "The source fields that are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nIf the `stored_fields` property is specified, the `_source` property defaults to `false`.\nOtherwise, it defaults to `true`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.SourceConfig"
+ }
+ ]
+ },
+ "fields": {
+ "description": "An array of wildcard (`*`) field patterns.\nThe request returns values for field names matching these patterns in the `hits.fields` property of the response.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.query_dsl.FieldAndFormat"
+ }
+ },
+ "suggest": {
+ "description": "Defines a suggester that provides similar looking terms based on a provided text.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.Suggester"
+ }
+ ]
+ },
+ "terminate_after": {
+ "description": "The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this property to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this property for requests that target data streams with backing indices across multiple data tiers.\n\nIf set to `0` (default), the query does not terminate early.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "timeout": {
+ "description": "The period of time to wait for a response from each shard.\nIf no response is received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.",
+ "type": "string"
+ },
+ "track_scores": {
+ "description": "If `true`, calculate and return document scores, even if the scores are not used for sorting.",
+ "default": false,
+ "type": "boolean"
+ },
+ "version": {
+ "description": "If `true`, the request returns the document version as part of a hit.",
+ "default": false,
+ "type": "boolean"
+ },
+ "seq_no_primary_term": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control"
+ },
+ "description": "If `true`, the request returns sequence number and primary term of the last modification of each hit.",
+ "type": "boolean"
+ },
+ "stored_fields": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#stored-fields"
+ },
+ "description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` property defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ },
+ "pit": {
+ "description": "Limit the search to a point in time (PIT).\nIf you provide a PIT, you cannot specify an `` in the request path.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.PointInTimeReference"
+ }
+ ]
+ },
+ "runtime_mappings": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/manage-data/data-store/mapping/define-runtime-fields-in-search-request"
+ },
+ "description": "One or more runtime fields in the search request.\nThese fields take precedence over mapped fields with the same name.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RuntimeFields"
+ }
+ ]
+ },
+ "stats": {
+ "description": "The stats groups to associate with the search.\nEach group maintains a statistics aggregation for its associated searches.\nYou can retrieve these stats using the indices stats API.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "SearchRequestExample1": {
+ "summary": "A simple term search",
+ "description": "Run `GET /my-index-000001/_search?from=40&size=20` to run a search.\n",
+ "value": "{\n \"query\": {\n \"term\": {\n \"user.id\": \"kimchy\"\n }\n }\n}"
+ },
+ "SearchRequestExample2": {
+ "summary": "A point in time search",
+ "description": "Run `POST /_search` to run a point in time search. The `id` parameter tells Elasticsearch to run the request using contexts from this open point in time. The `keep_alive` parameter tells Elasticsearch how long it should extend the time to live of the point in time.\n",
+ "value": "{\n \"size\": 100, \n \"query\": {\n \"match\" : {\n \"title\" : \"elasticsearch\"\n }\n },\n \"pit\": {\n \"id\": \"46ToAwMDaWR5BXV1aWQyKwZub2RlXzMAAAAAAAAAACoBYwADaWR4BXV1aWQxAgZub2RlXzEAAAAAAAAAAAEBYQADaWR5BXV1aWQyKgZub2RlXzIAAAAAAAAAAAwBYgACBXV1aWQyAAAFdXVpZDEAAQltYXRjaF9hbGw_gAAAAA==\", \n \"keep_alive\": \"1m\" \n }\n}"
+ },
+ "SearchRequestExample3": {
+ "summary": "Search slicing",
+ "description": "When paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently. The result from running the first `GET /_search` request returns documents belonging to the first slice (`id: 0`). If you run a second request with `id` set to `1', it returns documents in the second slice. Since the maximum number of slices is set to `2`, the union of the results is equivalent to the results of a point-in-time search without slicing.\n",
+ "value": "{\n \"slice\": {\n \"id\": 0, \n \"max\": 2 \n },\n \"query\": {\n \"match\": {\n \"message\": \"foo\"\n }\n },\n \"pit\": {\n \"id\": \"46ToAwMDaWR5BXV1aWQyKwZub2RlXzMAAAAAAAAAACoBYwADaWR4BXV1aWQxAgZub2RlXzEAAAAAAAAAAAEBYQADaWR5BXV1aWQyKgZub2RlXzIAAAAAAAAAAAwBYgACBXV1aWQyAAAFdXVpZDEAAQltYXRjaF9hbGw_gAAAAA==\"\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "search_application.search": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "params": {
+ "description": "Query parameters specific to this request, which will override any defaults specified in the template.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "examples": {
+ "SearchApplicationsSearchRequestExample1": {
+ "description": "Use `POST _application/search_application/my-app/_search` to run a search against a search application called `my-app` that uses a search template.",
+ "value": "{\n \"params\": {\n \"query_string\": \"my first query\",\n \"text_fields\": [\n {\"name\": \"title\", \"boost\": 5},\n {\"name\": \"description\", \"boost\": 1}\n ]\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "search_mvt": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "aggs": {
+ "description": "Sub-aggregations for the geotile_grid.\n\nIt supports the following aggregation types:\n\n- `avg`\n- `boxplot`\n- `cardinality`\n- `extended stats`\n- `max`\n- `median absolute deviation`\n- `min`\n- `percentile`\n- `percentile-rank`\n- `stats`\n- `sum`\n- `value count`\n\nThe aggregation names can't start with `_mvt_`. The `_mvt_` prefix is reserved for internal aggregations.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/_types.aggregations.AggregationContainer"
+ }
+ },
+ "buffer": {
+ "description": "The size, in pixels, of a clipping buffer outside the tile. This allows renderers\nto avoid outline artifacts from geometries that extend past the extent of the tile.",
+ "default": 5.0,
+ "type": "number"
+ },
+ "exact_bounds": {
+ "description": "If `false`, the meta layer's feature is the bounding box of the tile.\nIf `true`, the meta layer's feature is a bounding box resulting from a\n`geo_bounds` aggregation. The aggregation runs on values that intersect\nthe `//` tile with `wrap_longitude` set to `false`. The resulting\nbounding box may be larger than the vector tile.",
+ "default": false,
+ "type": "boolean"
+ },
+ "extent": {
+ "description": "The size, in pixels, of a side of the tile. Vector tiles are square with equal sides.",
+ "default": 4096.0,
+ "type": "number"
+ },
+ "fields": {
+ "description": "The fields to return in the `hits` layer.\nIt supports wildcards (`*`).\nThis parameter does not support fields with array values. Fields with array\nvalues may return inconsistent results.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Fields"
+ }
+ ]
+ },
+ "grid_agg": {
+ "description": "The aggregation used to create a grid for the `field`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search_mvt._types.GridAggregationType"
+ }
+ ]
+ },
+ "grid_precision": {
+ "description": "Additional zoom levels available through the aggs layer. For example, if `` is `7`\nand `grid_precision` is `8`, you can zoom in up to level 15. Accepts 0-8. If 0, results\ndon't include the aggs layer.",
+ "default": 8.0,
+ "type": "number"
+ },
+ "grid_type": {
+ "description": "Determines the geometry type for features in the aggs layer. In the aggs layer,\neach feature represents a `geotile_grid` cell. If `grid, each feature is a polygon\nof the cells bounding box. If `point`, each feature is a Point that is the centroid\nof the cell.",
+ "default": "grid",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search_mvt._types.GridType"
+ }
+ ]
+ },
+ "query": {
+ "description": "The query DSL used to filter documents for the search.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "runtime_mappings": {
+ "description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RuntimeFields"
+ }
+ ]
+ },
+ "size": {
+ "description": "The maximum number of features to return in the hits layer. Accepts 0-10000.\nIf 0, results don't include the hits layer.",
+ "default": 10000.0,
+ "type": "number"
+ },
+ "sort": {
+ "description": "Sort the features in the hits layer. By default, the API calculates a bounding\nbox for each feature. It sorts features based on this box's diagonal length,\nfrom longest to shortest.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Sort"
+ }
+ ]
+ },
+ "track_total_hits": {
+ "description": "The number of hits matching the query to count accurately. If `true`, the exact number\nof hits is returned at the cost of some performance. If `false`, the response does\nnot include the total number of hits matching the query.",
+ "default": "10000",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.search._types.TrackHits"
+ }
+ ]
+ },
+ "with_labels": {
+ "description": "If `true`, the hits and aggs layers will contain additional point features representing\nsuggested label positions for the original features.\n\n* `Point` and `MultiPoint` features will have one of the points selected.\n* `Polygon` and `MultiPolygon` features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree.\n* `LineString` features will likewise provide a roughly central point selected from the triangle-tree.\n* The aggregation results will provide one central point for each aggregation bucket.\n\nAll attributes from the original features will also be copied to the new label features.\nIn addition, the new features will be distinguishable using the tag `_mvt_label_position`.",
+ "type": "boolean"
+ }
+ }
+ },
+ "examples": {
+ "SearchMvtRequestExample1": {
+ "description": "Run `GET museums/_mvt/location/13/4207/2692` to search an index for `location` values that intersect the `13/4207/2692` vector tile.\n",
+ "value": "{\n \"grid_agg\": \"geotile\",\n \"grid_precision\": 2,\n \"fields\": [\n \"name\",\n \"price\"\n ],\n \"query\": {\n \"term\": {\n \"included\": true\n }\n },\n \"aggs\": {\n \"min_price\": {\n \"min\": {\n \"field\": \"price\"\n }\n },\n \"max_price\": {\n \"max\": {\n \"field\": \"price\"\n }\n },\n \"avg_price\": {\n \"avg\": {\n \"field\": \"price\"\n }\n }\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "search_template": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "explain": {
+ "description": "If `true`, returns detailed information about score calculation as part of each hit.\nIf you specify both this and the `explain` query parameter, the API uses only the query parameter.",
+ "default": false,
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The ID of the search template to use. If no `source` is specified,\nthis parameter is required.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Id"
+ }
+ ]
+ },
+ "params": {
+ "description": "Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "profile": {
+ "description": "If `true`, the query execution is profiled.",
+ "default": false,
+ "type": "boolean"
+ },
+ "source": {
+ "description": "An inline search template. Supports the same parameters as the search API's\nrequest body. It also supports Mustache variables. If no `id` is specified, this\nparameter is required.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.ScriptSource"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "SearchTemplateRequestExample1": {
+ "description": "Run `GET my-index/_search/template` to run a search with a search template.\n",
+ "value": "{\n \"id\": \"my-search-template\",\n \"params\": {\n \"query_string\": \"hello world\",\n \"from\": 0,\n \"size\": 10\n }\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "security.create_api_key": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "expiration": {
+ "description": "The expiration time for the API key.\nBy default, API keys never expire.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "name": {
+ "description": "A name for the API key.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Name"
+ }
+ ]
+ },
+ "role_descriptors": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role"
+ },
+ "description": "An array of role descriptors for this API key.\nWhen it is not specified or it is an empty array, the API key will have a point in time snapshot of permissions of the authenticated user.\nIf you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the authenticated user's permissions thereby limiting the access scope for API keys.\nThe structure of role descriptor is the same as the request for the create role API.\nFor more details, refer to the create or update roles API.\n\nNOTE: Due to the way in which this permission intersection is calculated, it is not possible to create an API key that is a child of another API key, unless the derived key is created without any privileges.\nIn this case, you must explicitly specify a role descriptor with no privileges.\nThe derived API key can be used for authentication; it will not have authority to call Elasticsearch APIs.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/security._types.RoleDescriptor"
+ }
+ },
+ "metadata": {
+ "description": "Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with `_` are reserved for system usage.",
+ "x-state": "Generally available",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "SecurityCreateApiKeyRequestExample1": {
+ "description": "Run `POST /_security/api_key` to create an API key. If `expiration` is not provided, the API keys do not expire. If `role_descriptors` is not provided, the permissions of the authenticated user are applied.\n",
+ "value": "{\n \"name\": \"my-api-key\",\n \"expiration\": \"1d\", \n \"role_descriptors\": { \n \"role-a\": {\n \"cluster\": [\"all\"],\n \"indices\": [\n {\n \"names\": [\"index-a*\"],\n \"privileges\": [\"read\"]\n }\n ]\n },\n \"role-b\": {\n \"cluster\": [\"all\"],\n \"indices\": [\n {\n \"names\": [\"index-b*\"],\n \"privileges\": [\"all\"]\n }\n ]\n }\n },\n \"metadata\": {\n \"application\": \"my-application\",\n \"environment\": {\n \"level\": 1,\n \"trusted\": true,\n \"tags\": [\"dev\", \"staging\"]\n }\n }\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "security.has_privileges": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "application": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/security.has_privileges.ApplicationPrivilegesCheck"
+ }
+ },
+ "cluster": {
+ "description": "A list of the cluster privileges that you want to check.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/security._types.ClusterPrivilege"
+ }
+ },
+ "index": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/security.has_privileges.IndexPrivilegesCheck"
+ }
+ }
+ }
+ },
+ "examples": {
+ "SecurityHasPrivilegesRequestExample1": {
+ "description": "Run `GET /_security/user/_has_privileges` to check whether the current user has a specific set of cluster, index, and application privileges.",
+ "value": "{\n \"cluster\": [ \"monitor\", \"manage\" ],\n \"index\" : [\n {\n \"names\": [ \"suppliers\", \"products\" ],\n \"privileges\": [ \"read\" ]\n },\n {\n \"names\": [ \"inventory\" ],\n \"privileges\" : [ \"read\", \"write\" ]\n }\n ],\n \"application\": [\n {\n \"application\": \"inventory_manager\",\n \"privileges\" : [ \"read\", \"data:write/inventory\" ],\n \"resources\" : [ \"product/1852563\" ]\n }\n ]\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "security.put_role": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "applications": {
+ "description": "A list of application privilege entries.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/security._types.ApplicationPrivileges"
+ }
+ },
+ "cluster": {
+ "description": "A list of cluster privileges. These privileges define the cluster-level actions for users with this role.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/security._types.ClusterPrivilege"
+ }
+ },
+ "indices": {
+ "description": "A list of indices permissions entries.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/security._types.IndicesPrivileges"
+ }
+ },
+ "metadata": {
+ "description": "Optional metadata. Within the metadata object, keys that begin with an underscore (`_`) are reserved for system use.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Metadata"
+ }
+ ]
+ },
+ "run_as": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/submitting-requests-on-behalf-of-other-users"
+ },
+ "description": "A list of users that the owners of this role can impersonate. *Note*: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "description": "Optional description of the role descriptor",
+ "type": "string"
+ },
+ "transient_metadata": {
+ "description": "Indicates roles that might be incompatible with the current cluster license, specifically roles with document and field level security. When the cluster license doesn’t allow certain features for a given role, this parameter is updated dynamically to list the incompatible features. If `enabled` is `false`, the role is ignored, but is still listed in the response from the authenticate API.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "examples": {
+ "SecurityPutRoleRequestExample1": {
+ "summary": "Role example 1",
+ "description": "Run `POST /_security/role/my_admin_role` to create a role.",
+ "value": "{\n \"description\": \"Grants full access to all management features within the cluster.\",\n \"cluster\": [\"all\"],\n \"indices\": [\n {\n \"names\": [ \"index1\", \"index2\" ],\n \"privileges\": [\"all\"],\n \"field_security\" : { // optional\n \"grant\" : [ \"title\", \"body\" ]\n },\n \"query\": \"{\\\"match\\\": {\\\"title\\\": \\\"foo\\\"}}\" // optional\n }\n ],\n \"applications\": [\n {\n \"application\": \"myapp\",\n \"privileges\": [ \"admin\", \"read\" ],\n \"resources\": [ \"*\" ]\n }\n ],\n \"run_as\": [ \"other_user\" ], // optional\n \"metadata\" : { // optional\n \"version\" : 1\n }\n}"
+ },
+ "SecurityPutRoleRequestExample2": {
+ "summary": "Role example 2",
+ "description": "Run `POST /_security/role/cli_or_drivers_minimal` to configure a role that can run SQL in JDBC.",
+ "value": "{\n \"cluster\": [\"cluster:monitor/main\"],\n \"indices\": [\n {\n \"names\": [\"test\"],\n \"privileges\": [\"read\", \"indices:admin/get\"]\n }\n ]\n}"
+ },
+ "SecurityPutRoleRequestExample3": {
+ "summary": "Role example 3",
+ "description": "Run `POST /_security/role/only_remote_access_role` to configure a role with remote indices and remote cluster privileges for a remote cluster.",
+ "value": "{\n \"remote_indices\": [\n {\n \"clusters\": [\"my_remote\"], \n \"names\": [\"logs*\"], \n \"privileges\": [\"read\", \"read_cross_cluster\", \"view_index_metadata\"] \n }\n ],\n \"remote_cluster\": [\n {\n \"clusters\": [\"my_remote\"], \n \"privileges\": [\"monitor_stats\"] \n }\n ]\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "security.query_api_keys": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "aggregations": {
+ "description": "Any aggregations to run over the corpus of returned API keys.\nAggregations and queries work together. Aggregations are computed only on the API keys that match the query.\nThis supports only a subset of aggregation types, namely: `terms`, `range`, `date_range`, `missing`,\n`cardinality`, `value_count`, `composite`, `filter`, and `filters`.\nAdditionally, aggregations only run over the same subset of fields that query works with.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/security.query_api_keys.ApiKeyAggregationContainer"
+ }
+ },
+ "query": {
+ "description": "A query to filter which API keys to return.\nIf the query parameter is missing, it is equivalent to a `match_all` query.\nThe query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`,\n`ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`.\nYou can query the following public information associated with an API key: `id`, `type`, `name`,\n`creation`, `expiration`, `invalidated`, `invalidation`, `username`, `realm`, and `metadata`.\n\nNOTE: The queryable string values associated with API keys are internally mapped as keywords.\nConsequently, if no `analyzer` parameter is specified for a `match` query, then the provided match query string is interpreted as a single keyword value.\nSuch a match query is hence equivalent to a `term` query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/security.query_api_keys.ApiKeyQueryContainer"
+ }
+ ]
+ },
+ "from": {
+ "description": "The starting document offset.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "sort": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results"
+ },
+ "description": "The sort definition.\nOther than `id`, all public fields of an API key are eligible for sorting.\nIn addition, sort can also be applied to the `_doc` field to sort by index order.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Sort"
+ }
+ ]
+ },
+ "size": {
+ "description": "The number of hits to return.\nIt must not be negative.\nThe `size` parameter can be set to `0`, in which case no API key matches are returned, only the aggregation results.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.",
+ "default": 10.0,
+ "type": "number"
+ },
+ "search_after": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#search-after"
+ },
+ "description": "The search after definition.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SortResults"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "QueryApiKeysRequestExample1": {
+ "summary": "Query API keys by ID",
+ "description": "Run `GET /_security/_query/api_key?with_limited_by=true` to retrieve an API key by ID.",
+ "value": "{\n \"query\": {\n \"ids\": {\n \"values\": [\n \"VuaCfGcBCdbkQm-e5aOx\"\n ]\n }\n }\n}"
+ },
+ "QueryApiKeysRequestExample2": {
+ "summary": "Query API keys with pagination",
+ "description": "Run `GET /_security/_query/api_key`. Use a `bool` query to issue complex logical conditions and use `from`, `size`, and `sort` to help paginate the result. For example, the API key name must begin with `app1-key-` and must not be `app1-key-01`. It must be owned by a username with the wildcard pattern `org-*-user` and the `environment` metadata field must have a `production` value. The offset to begin the search result is the twentieth (zero-based index) API key. The page size of the response is 10 API keys. The result is first sorted by creation date in descending order, then by name in ascending order.\n",
+ "value": "{\n \"query\": {\n \"bool\": {\n \"must\": [\n {\n \"prefix\": {\n \"name\": \"app1-key-\" \n }\n },\n {\n \"term\": {\n \"invalidated\": \"false\" \n }\n }\n ],\n \"must_not\": [\n {\n \"term\": {\n \"name\": \"app1-key-01\" \n }\n }\n ],\n \"filter\": [\n {\n \"wildcard\": {\n \"username\": \"org-*-user\" \n }\n },\n {\n \"term\": {\n \"metadata.environment\": \"production\" \n }\n }\n ]\n }\n },\n \"from\": 20, \n \"size\": 10, \n \"sort\": [ \n { \"creation\": { \"order\": \"desc\", \"format\": \"date_time\" } },\n \"name\"\n ]\n}"
+ },
+ "QueryApiKeysRequestExample3": {
+ "summary": "Query API keys by name",
+ "description": "Run `GET /_security/_query/api_key` to retrieve the API key by name.",
+ "value": "{\n \"query\": {\n \"term\": {\n \"name\": {\n \"value\": \"application-key-1\"\n }\n }\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "security.query_role": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "query": {
+ "description": "A query to filter which roles to return.\nIf the query parameter is missing, it is equivalent to a `match_all` query.\nThe query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`,\n`ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`.\nYou can query the following information associated with roles: `name`, `description`, `metadata`,\n`applications.application`, `applications.privileges`, and `applications.resources`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/security.query_role.RoleQueryContainer"
+ }
+ ]
+ },
+ "from": {
+ "description": "The starting document offset.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.",
+ "default": 0.0,
+ "type": "number"
+ },
+ "sort": {
+ "description": "The sort definition.\nYou can sort on `username`, `roles`, or `enabled`.\nIn addition, sort can also be applied to the `_doc` field to sort by index order.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Sort"
+ }
+ ]
+ },
+ "size": {
+ "description": "The number of hits to return.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.",
+ "default": 10.0,
+ "type": "number"
+ },
+ "search_after": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#search-after"
+ },
+ "description": "The search after definition.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.SortResults"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "QueryRolesRequestExample1": {
+ "summary": "Query roles by name",
+ "description": "Run `POST /_security/_query/role` to lists all roles, sorted by the role name.",
+ "value": "{\n \"sort\": [\"name\"]\n}"
+ },
+ "QueryRolesRequestExample2": {
+ "summary": "Query roles by description",
+ "description": "Run `POST /_security/_query/role` to query only the user access role, given its description. It returns only the best matching role because `size` is set to `1`.\n",
+ "value": "{\n \"query\": {\n \"match\": {\n \"description\": {\n \"query\": \"user access\"\n }\n }\n },\n \"size\": 1 \n}"
+ }
+ }
+ }
+ }
+ },
+ "sql.query": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "allow_partial_search_results": {
+ "description": "If `true`, the response has partial results when there are shard request timeouts or shard failures.\nIf `false`, the API returns an error with no partial results.",
+ "default": false,
+ "type": "boolean"
+ },
+ "catalog": {
+ "description": "The default catalog (cluster) for queries.\nIf unspecified, the queries execute on the data in the local cluster only.",
+ "type": "string"
+ },
+ "columnar": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql-rest-columnar"
+ },
+ "description": "If `true`, the results are in a columnar fashion: one row represents all the values of a certain column from the current page of results.\nThe API supports this parameter only for CBOR, JSON, SMILE, and YAML responses.",
+ "default": false,
+ "type": "boolean"
+ },
+ "cursor": {
+ "description": "The cursor used to retrieve a set of paginated results.\nIf you specify a cursor, the API only uses the `columnar` and `time_zone` request body parameters.\nIt ignores other request body parameters.",
+ "type": "string"
+ },
+ "fetch_size": {
+ "description": "The maximum number of rows (or entries) to return in one response.",
+ "default": 1000.0,
+ "type": "number"
+ },
+ "field_multi_value_leniency": {
+ "description": "If `false`, the API returns an exception when encountering multiple values for a field.\nIf `true`, the API is lenient and returns the first value from the array with no guarantee of consistent results.",
+ "default": false,
+ "type": "boolean"
+ },
+ "filter": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql-rest-filtering"
+ },
+ "description": "The Elasticsearch query DSL for additional filtering.",
+ "default": "none",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "index_using_frozen": {
+ "description": "If `true`, the search can run on frozen indices.",
+ "default": false,
+ "type": "boolean"
+ },
+ "keep_alive": {
+ "description": "The retention period for an async or saved synchronous search.",
+ "default": "5d",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "keep_on_completion": {
+ "description": "If `true`, Elasticsearch stores synchronous searches if you also specify the `wait_for_completion_timeout` parameter.\nIf `false`, Elasticsearch only stores async searches that don't finish before the `wait_for_completion_timeout`.",
+ "default": false,
+ "type": "boolean"
+ },
+ "page_timeout": {
+ "description": "The minimum retention period for the scroll cursor.\nAfter this time period, a pagination request might fail because the scroll cursor is no longer available.\nSubsequent scroll requests prolong the lifetime of the scroll cursor by the duration of `page_timeout` in the scroll request.",
+ "default": "45s",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "params": {
+ "description": "The values for parameters in the query.",
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ },
+ "query": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/sql/sql-spec"
+ },
+ "description": "The SQL query to run.",
+ "type": "string"
+ },
+ "request_timeout": {
+ "description": "The timeout before the request fails.",
+ "default": "90s",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "runtime_mappings": {
+ "description": "One or more runtime fields for the search request.\nThese fields take precedence over mapped fields with the same name.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.mapping.RuntimeFields"
+ }
+ ]
+ },
+ "time_zone": {
+ "externalDocs": {
+ "url": "https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html"
+ },
+ "description": "The ISO-8601 time zone ID for the search.",
+ "default": "Z",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.TimeZone"
+ }
+ ]
+ },
+ "wait_for_completion_timeout": {
+ "description": "The period to wait for complete results.\nIt defaults to no timeout, meaning the request waits for complete search results.\nIf the search doesn't finish within this period, the search becomes async.\n\nTo save a synchronous search, you must specify this parameter and the `keep_on_completion` parameter.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "QuerySqlRequestExample1": {
+ "description": "Run `POST _sql?format=txt` to get results for an SQL search.",
+ "value": "{\n \"query\": \"SELECT * FROM library ORDER BY page_count DESC LIMIT 5\"\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "sql.translate": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "fetch_size": {
+ "description": "The maximum number of rows (or entries) to return in one response.",
+ "default": 1000.0,
+ "type": "number"
+ },
+ "filter": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql-rest-filtering"
+ },
+ "description": "The Elasticsearch query DSL for additional filtering.",
+ "default": "none",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "query": {
+ "description": "The SQL query to run.",
+ "type": "string"
+ },
+ "time_zone": {
+ "externalDocs": {
+ "url": "https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html"
+ },
+ "description": "The ISO-8601 time zone ID for the search.",
+ "default": "Z",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.TimeZone"
+ }
+ ]
+ }
+ },
+ "required": [
+ "query"
+ ]
+ },
+ "examples": {
+ "TranslateSqlRequestExample1": {
+ "summary": "sql/apis/sql-translate-api.asciidoc:12",
+ "description": "",
+ "value": "{\n \"query\": \"SELECT * FROM library ORDER BY page_count DESC\",\n \"fetch_size\": 10\n}"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "terms_enum": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "The string to match at the start of indexed terms. If not provided, all terms in the field are considered.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ ]
+ },
+ "size": {
+ "description": "The number of matching terms to return.",
+ "default": 10.0,
+ "type": "number"
+ },
+ "timeout": {
+ "description": "The maximum length of time to spend collecting results.\nIf the timeout is exceeded the `complete` flag set to `false` in the response and the results may be partial or empty.",
+ "default": "1s",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "case_insensitive": {
+ "description": "When `true`, the provided search string is matched against index terms without case sensitivity.",
+ "default": false,
+ "type": "boolean"
+ },
+ "index_filter": {
+ "description": "Filter an index shard if the provided query rewrites to `match_none`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.query_dsl.QueryContainer"
+ }
+ ]
+ },
+ "string": {
+ "description": "The string to match at the start of indexed terms.\nIf it is not provided, all terms in the field are considered.\n\n> info\n> The prefix string cannot be larger than the largest possible keyword value, which is Lucene's term byte-length limit of 32766.",
+ "type": "string"
+ },
+ "search_after": {
+ "description": "The string after which terms in the index should be returned.\nIt allows for a form of pagination if the last result from one request is passed as the `search_after` parameter for a subsequent request.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "field"
+ ]
+ },
+ "examples": {
+ "TermsEnumRequestExample1": {
+ "description": "Run `POST stackoverflow/_terms_enum`.",
+ "value": "{\n \"field\" : \"tags\",\n \"string\" : \"kiba\"\n}"
+ }
+ }
+ }
+ }
+ },
+ "termvectors": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "doc": {
+ "description": "An artificial document (a document not present in the index) for which you want to retrieve term vectors.",
+ "type": "object"
+ },
+ "filter": {
+ "externalDocs": {
+ "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-mlt-query"
+ },
+ "description": "Filter terms based on their tf-idf scores.\nThis could be useful in order find out a good characteristic vector of a document.\nThis feature works in a similar manner to the second phase of the More Like This Query.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_global.termvectors.Filter"
+ }
+ ]
+ },
+ "per_field_analyzer": {
+ "description": "Override the default per-field analyzer.\nThis is useful in order to generate term vectors in any fashion, especially when using artificial documents.\nWhen providing an analyzer for a field that already stores term vectors, the term vectors will be regenerated.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "fields": {
+ "description": "A list of fields to include in the statistics.\nIt is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/_types.Field"
+ }
+ },
+ "field_statistics": {
+ "description": "If `true`, the response includes:\n\n* The document count (how many documents contain this field).\n* The sum of document frequencies (the sum of document frequencies for all terms in this field).\n* The sum of total term frequencies (the sum of total term frequencies of each term in this field).",
+ "default": true,
+ "type": "boolean"
+ },
+ "offsets": {
+ "description": "If `true`, the response includes term offsets.",
+ "default": true,
+ "type": "boolean"
+ },
+ "payloads": {
+ "description": "If `true`, the response includes term payloads.",
+ "default": true,
+ "type": "boolean"
+ },
+ "positions": {
+ "description": "If `true`, the response includes term positions.",
+ "default": true,
+ "type": "boolean"
+ },
+ "term_statistics": {
+ "description": "If `true`, the response includes:\n\n* The total term frequency (how often a term occurs in all documents).\n* The document frequency (the number of documents containing the current term).\n\nBy default these values are not returned since term statistics can have a serious performance impact.",
+ "default": false,
+ "type": "boolean"
+ },
+ "routing": {
+ "description": "A custom value that is used to route operations to a specific shard.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Routing"
+ }
+ ]
+ },
+ "version": {
+ "description": "If `true`, returns the document version as part of a hit.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionNumber"
+ }
+ ]
+ },
+ "version_type": {
+ "description": "The version type.\n\nSupported values include:\n - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n - `force`: This option is deprecated because it can cause primary and replica shards to diverge.\n\n",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.VersionType"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "TermVectorsRequestExample1": {
+ "summary": "Return stored term vectors",
+ "description": "Run `GET /my-index-000001/_termvectors/1` to return all information and statistics for field `text` in document 1.\n",
+ "value": "{\n \"fields\" : [\"text\"],\n \"offsets\" : true,\n \"payloads\" : true,\n \"positions\" : true,\n \"term_statistics\" : true,\n \"field_statistics\" : true\n}"
+ },
+ "TermVectorsRequestExample2": {
+ "summary": "Per-field analyzer",
+ "description": "Run `GET /my-index-000001/_termvectors/1` to set per-field analyzers. A different analyzer than the one at the field may be provided by using the `per_field_analyzer` parameter.\n",
+ "value": "{\n \"doc\" : {\n \"fullname\" : \"John Doe\",\n \"text\" : \"test test test\"\n },\n \"fields\": [\"fullname\"],\n \"per_field_analyzer\" : {\n \"fullname\": \"keyword\"\n }\n}"
+ },
+ "TermVectorsRequestExample3": {
+ "summary": "Terms filtering",
+ "description": "Run `GET /imdb/_termvectors` to filter the terms returned based on their tf-idf scores. It returns the three most \"interesting\" keywords from the artificial document having the given \"plot\" field value. Notice that the keyword \"Tony\" or any stop words are not part of the response, as their tf-idf must be too low.\n",
+ "value": "{\n \"doc\": {\n \"plot\": \"When wealthy industrialist Tony Stark is forced to build an armored suit after a life-threatening incident, he ultimately decides to use its technology to fight against evil.\"\n },\n \"term_statistics\": true,\n \"field_statistics\": true,\n \"positions\": false,\n \"offsets\": false,\n \"filter\": {\n \"max_num_terms\": 3,\n \"min_term_freq\": 1,\n \"min_doc_freq\": 1\n }\n}"
+ },
+ "TermVectorsRequestExample4": {
+ "summary": "Generate term vectors on the fly",
+ "description": "Run `GET /my-index-000001/_termvectors/1`. Term vectors which are not explicitly stored in the index are automatically computed on the fly. This request returns all information and statistics for the fields in document 1, even though the terms haven't been explicitly stored in the index. Note that for the field text, the terms are not regenerated.\n",
+ "value": "{\n \"fields\" : [\"text\", \"some_field_without_term_vectors\"],\n \"offsets\" : true,\n \"positions\" : true,\n \"term_statistics\" : true,\n \"field_statistics\" : true\n}"
+ },
+ "TermVectorsRequestExample5": {
+ "summary": "Artificial documents",
+ "description": "Run `GET /my-index-000001/_termvectors`. Term vectors can be generated for artificial documents, that is for documents not present in the index. If dynamic mapping is turned on (default), the document fields not in the original mapping will be dynamically created.\n",
+ "value": "{\n \"doc\" : {\n \"fullname\" : \"John Doe\",\n \"text\" : \"test test test\"\n }\n}"
+ }
+ }
+ }
+ }
+ },
+ "transform.preview_transform": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "dest": {
+ "description": "The destination for the transform.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.Destination"
+ }
+ ]
+ },
+ "description": {
+ "description": "Free text description of the transform.",
+ "type": "string"
+ },
+ "frequency": {
+ "description": "The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is 1s and the maximum is 1h.",
+ "default": "1m",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/_types.Duration"
+ }
+ ]
+ },
+ "pivot": {
+ "description": "The pivot method transforms the data by aggregating and grouping it.\nThese objects define the group by fields and the aggregation to reduce\nthe data.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.Pivot"
+ }
+ ]
+ },
+ "source": {
+ "description": "The source of the data for the transform.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.Source"
+ }
+ ]
+ },
+ "settings": {
+ "description": "Defines optional transform settings.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.Settings"
+ }
+ ]
+ },
+ "sync": {
+ "description": "Defines the properties transforms require to run continuously.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.SyncContainer"
+ }
+ ]
+ },
+ "retention_policy": {
+ "description": "Defines a retention policy for the transform. Data that meets the defined\ncriteria is deleted from the destination index.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.RetentionPolicyContainer"
+ }
+ ]
+ },
+ "latest": {
+ "description": "The latest method transforms the data by finding the latest document for\neach unique key.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/transform._types.Latest"
+ }
+ ]
+ }
+ }
+ },
+ "examples": {
+ "PreviewTransformRequestExample1": {
+ "description": "Run `POST _transform/_preview` to preview a transform that uses the pivot method.",
+ "value": "{\n \"source\": {\n \"index\": \"kibana_sample_data_ecommerce\"\n },\n \"pivot\": {\n \"group_by\": {\n \"customer_id\": {\n \"terms\": {\n \"field\": \"customer_id\",\n \"missing_bucket\": true\n }\n }\n },\n \"aggregations\": {\n \"max_price\": {\n \"max\": {\n \"field\": \"taxful_total_price\"\n }\n }\n }\n }\n}"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/output/schema/schema.json b/output/schema/schema.json
index 98ed2adc73..78d5ee6b7d 100644
--- a/output/schema/schema.json
+++ b/output/schema/schema.json
@@ -21811,16 +21811,29 @@
"availability": {
"stack": {
"featureFlag": "logs_stream",
- "stability": "stable",
+ "since": "9.1.0",
+ "stability": "experimental",
"visibility": "feature_flag"
}
},
- "description": "Disable the Logs Streams feature for this cluster",
- "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/streams-logs-disable.html",
+ "description": "Disable logs stream.\n\nTurn off the logs stream feature for this cluster.",
+ "docId": "streams-logs-disable",
+ "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO",
"name": "streams.logs_disable",
- "request": null,
+ "privileges": {
+ "cluster": [
+ "manage"
+ ]
+ },
+ "request": {
+ "name": "Request",
+ "namespace": "streams.logs_disable"
+ },
"requestBodyRequired": false,
- "response": null,
+ "response": {
+ "name": "Response",
+ "namespace": "streams.logs_disable"
+ },
"responseMediaType": [
"application/json",
"text/plain"
@@ -21838,16 +21851,29 @@
"availability": {
"stack": {
"featureFlag": "logs_stream",
- "stability": "stable",
+ "since": "9.1.0",
+ "stability": "experimental",
"visibility": "feature_flag"
}
},
- "description": "Enable the Logs Streams feature for this cluster",
- "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/streams-logs-enable.html",
+ "description": "Enable logs stream.\n\nTurn on the logs stream feature for this cluster.\n\nNOTE: To protect existing data, this feature can be turned on only if the\ncluster does not have existing indices or data streams that match the pattern `logs|logs.*`.\nIf those indices or data streams exist, a `409 - Conflict` response and error is returned.",
+ "docId": "streams-logs-enable",
+ "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO",
"name": "streams.logs_enable",
- "request": null,
+ "privileges": {
+ "cluster": [
+ "manage"
+ ]
+ },
+ "request": {
+ "name": "Request",
+ "namespace": "streams.logs_enable"
+ },
"requestBodyRequired": false,
- "response": null,
+ "response": {
+ "name": "Response",
+ "namespace": "streams.logs_enable"
+ },
"responseMediaType": [
"application/json",
"text/plain"
@@ -21865,16 +21891,29 @@
"availability": {
"stack": {
"featureFlag": "logs_stream",
- "stability": "stable",
+ "since": "9.1.0",
+ "stability": "experimental",
"visibility": "feature_flag"
}
},
- "description": "Return the current status of the streams feature for each streams type",
- "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/streams-status.html",
+ "description": "Get the status of streams.\n\nGet the current status for all types of streams.",
+ "docId": "streams-status",
+ "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO",
"name": "streams.status",
- "request": null,
+ "privileges": {
+ "cluster": [
+ "monitor"
+ ]
+ },
+ "request": {
+ "name": "Request",
+ "namespace": "streams.status"
+ },
"requestBodyRequired": false,
- "response": null,
+ "response": {
+ "name": "Response",
+ "namespace": "streams.status"
+ },
"responseMediaType": [
"application/json"
],
@@ -253725,6 +253764,263 @@
},
"specLocation": "ssl/certificates/GetCertificatesResponse.ts#L22-L24"
},
+ {
+ "kind": "request",
+ "attachedBehaviors": [
+ "CommonQueryParameters"
+ ],
+ "body": {
+ "kind": "no_body"
+ },
+ "description": "Disable logs stream.\n\nTurn off the logs stream feature for this cluster.",
+ "examples": {
+ "PostStreamsDisableRequestExample1": {
+ "method_request": "POST _streams/logs/_disable",
+ "summary": "Disable the logs streams on this cluster"
+ }
+ },
+ "inherits": {
+ "type": {
+ "name": "RequestBase",
+ "namespace": "_types"
+ }
+ },
+ "name": {
+ "name": "Request",
+ "namespace": "streams.logs_disable"
+ },
+ "path": [],
+ "query": [
+ {
+ "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.",
+ "name": "master_timeout",
+ "required": false,
+ "serverDefault": "30s",
+ "type": {
+ "kind": "instance_of",
+ "type": {
+ "name": "Duration",
+ "namespace": "_types"
+ }
+ }
+ },
+ {
+ "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.",
+ "name": "timeout",
+ "required": false,
+ "serverDefault": "30s",
+ "type": {
+ "kind": "instance_of",
+ "type": {
+ "name": "Duration",
+ "namespace": "_types"
+ }
+ }
+ }
+ ],
+ "specLocation": "streams/logs_disable/StreamsLogsDisableRequest.ts#L23-L55"
+ },
+ {
+ "kind": "response",
+ "body": {
+ "kind": "value",
+ "value": {
+ "kind": "instance_of",
+ "type": {
+ "name": "AcknowledgedResponseBase",
+ "namespace": "_types"
+ }
+ }
+ },
+ "examples": {
+ "PostStreamsLogsDisableResponseExample1": {
+ "description": "A successful response from `POST _streams/logs/_disable` endpoint\n",
+ "summary": "Disable logs streams",
+ "value": "{\n \"acknowledged\": true\n}"
+ }
+ },
+ "name": {
+ "name": "Response",
+ "namespace": "streams.logs_disable"
+ },
+ "specLocation": "streams/logs_disable/StreamsLogsDisableResponse.ts#L22-L25"
+ },
+ {
+ "kind": "request",
+ "attachedBehaviors": [
+ "CommonQueryParameters"
+ ],
+ "body": {
+ "kind": "no_body"
+ },
+ "description": "Enable logs stream.\n\nTurn on the logs stream feature for this cluster.\n\nNOTE: To protect existing data, this feature can be turned on only if the\ncluster does not have existing indices or data streams that match the pattern `logs|logs.*`.\nIf those indices or data streams exist, a `409 - Conflict` response and error is returned.",
+ "examples": {
+ "PostStreamsEnableRequestExample1": {
+ "method_request": "POST _streams/logs/_enable",
+ "summary": "Enable the logs streams on this cluster"
+ }
+ },
+ "inherits": {
+ "type": {
+ "name": "RequestBase",
+ "namespace": "_types"
+ }
+ },
+ "name": {
+ "name": "Request",
+ "namespace": "streams.logs_enable"
+ },
+ "path": [],
+ "query": [
+ {
+ "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.",
+ "name": "master_timeout",
+ "required": false,
+ "serverDefault": "30s",
+ "type": {
+ "kind": "instance_of",
+ "type": {
+ "name": "Duration",
+ "namespace": "_types"
+ }
+ }
+ },
+ {
+ "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.",
+ "name": "timeout",
+ "required": false,
+ "serverDefault": "30s",
+ "type": {
+ "kind": "instance_of",
+ "type": {
+ "name": "Duration",
+ "namespace": "_types"
+ }
+ }
+ }
+ ],
+ "specLocation": "streams/logs_enable/StreamsLogsEnableRequest.ts#L23-L59"
+ },
+ {
+ "kind": "response",
+ "body": {
+ "kind": "value",
+ "value": {
+ "kind": "instance_of",
+ "type": {
+ "name": "AcknowledgedResponseBase",
+ "namespace": "_types"
+ }
+ }
+ },
+ "examples": {
+ "PostStreamsLogsEnableResponseExample1": {
+ "description": "A successful response from `POST _streams/logs/_enable` endpoint\n",
+ "summary": "Enable logs streams",
+ "value": "{\n \"acknowledged\": true\n}"
+ }
+ },
+ "name": {
+ "name": "Response",
+ "namespace": "streams.logs_enable"
+ },
+ "specLocation": "streams/logs_enable/StreamsLogsEnableResponse.ts#L22-L25"
+ },
+ {
+ "kind": "interface",
+ "name": {
+ "name": "LogsStatus",
+ "namespace": "streams.status"
+ },
+ "properties": [
+ {
+ "description": "If true, the logs stream feature is enabled.",
+ "name": "enabled",
+ "required": true,
+ "type": {
+ "kind": "instance_of",
+ "type": {
+ "name": "boolean",
+ "namespace": "_builtins"
+ }
+ }
+ }
+ ],
+ "specLocation": "streams/status/StreamsStatusResponse.ts#L26-L31"
+ },
+ {
+ "kind": "request",
+ "attachedBehaviors": [
+ "CommonQueryParameters"
+ ],
+ "body": {
+ "kind": "no_body"
+ },
+ "description": "Get the status of streams.\n\nGet the current status for all types of streams.",
+ "examples": {
+ "GetStreamsStatusRequestExample1": {
+ "method_request": "GET _streams/status",
+ "summary": "Get the current status of streams"
+ }
+ },
+ "inherits": {
+ "type": {
+ "name": "RequestBase",
+ "namespace": "_types"
+ }
+ },
+ "name": {
+ "name": "Request",
+ "namespace": "streams.status"
+ },
+ "path": [],
+ "query": [
+ {
+ "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.",
+ "name": "master_timeout",
+ "required": false,
+ "serverDefault": "30s",
+ "type": {
+ "kind": "instance_of",
+ "type": {
+ "name": "TimeUnit",
+ "namespace": "_types"
+ }
+ }
+ }
+ ],
+ "specLocation": "streams/status/StreamsStatusRequest.ts#L23-L47"
+ },
+ {
+ "kind": "response",
+ "body": {
+ "kind": "properties",
+ "properties": [
+ {
+ "name": "logs",
+ "required": true,
+ "type": {
+ "kind": "instance_of",
+ "type": {
+ "name": "LogsStatus",
+ "namespace": "streams.status"
+ }
+ }
+ }
+ ]
+ },
+ "examples": {
+ "GetStreamsStatusResponseExample1": {
+ "summary": "Get Streams Status A successful response from `GET _streams/status` that outlines the current state of all wired streams in the cluster.",
+ "value": "{\n \"logs\": {\n \"enabled\": true\n }\n}"
+ }
+ },
+ "name": {
+ "name": "Response",
+ "namespace": "streams.status"
+ },
+ "specLocation": "streams/status/StreamsStatusResponse.ts#L20-L24"
+ },
{
"kind": "interface",
"name": {
diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json
index 73626313ae..2bbafc9942 100644
--- a/output/schema/validation-errors.json
+++ b/output/schema/validation-errors.json
@@ -115,6 +115,12 @@
"Request: query parameter 'bytes' does not exist in the json spec"
],
"response": []
+ },
+ "streams.status": {
+ "request": [
+ "Request: query parameter 'master_timeout' does not exist in the json spec"
+ ],
+ "response": []
}
},
"generalErrors": [
diff --git a/output/typescript/types.ts b/output/typescript/types.ts
index c42c6769dc..40938c3f7e 100644
--- a/output/typescript/types.ts
+++ b/output/typescript/types.ts
@@ -21681,6 +21681,32 @@ export interface SslCertificatesRequest extends RequestBase {
export type SslCertificatesResponse = SslCertificatesCertificateInformation[]
+export interface StreamsLogsDisableRequest extends RequestBase {
+ master_timeout?: Duration
+ timeout?: Duration
+}
+
+export type StreamsLogsDisableResponse = AcknowledgedResponseBase
+
+export interface StreamsLogsEnableRequest extends RequestBase {
+ master_timeout?: Duration
+ timeout?: Duration
+}
+
+export type StreamsLogsEnableResponse = AcknowledgedResponseBase
+
+export interface StreamsStatusLogsStatus {
+ enabled: boolean
+}
+
+export interface StreamsStatusRequest extends RequestBase {
+ master_timeout?: TimeUnit
+}
+
+export interface StreamsStatusResponse {
+ logs: StreamsStatusLogsStatus
+}
+
export interface SynonymsSynonymRule {
id?: Id
synonyms: SynonymsSynonymString
diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv
index 134ad5d3a8..fe3dc2040b 100644
--- a/specification/_doc_ids/table.csv
+++ b/specification/_doc_ids/table.csv
@@ -869,6 +869,9 @@ stop-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch
stop-trained-model-deployment,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/stop-trained-model-deployment.html,,
stop-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/stop-transform.html,,
stored-fields,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-fields.html#stored-fields,,
+streams-status,https://www.elastic.co/docs/api/doc/elasticsearch#TODO,,
+streams-logs-enable,https://www.elastic.co/docs/api/doc/elasticsearch#TODO,,
+streams-logs-disable,https://www.elastic.co/docs/api/doc/elasticsearch#TODO,,
synonym-rule-create,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-synonym-rule.html,,
synonym-rule-delete,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-synonym-rule.html,,
synonym-rule-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-synonym-rule.html,,
diff --git a/specification/streams/logs_disable/StreamsLogsDisableRequest.ts b/specification/streams/logs_disable/StreamsLogsDisableRequest.ts
new file mode 100644
index 0000000000..c44e6060cb
--- /dev/null
+++ b/specification/streams/logs_disable/StreamsLogsDisableRequest.ts
@@ -0,0 +1,55 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { RequestBase } from '@_types/Base'
+import { Duration } from '@_types/Time'
+
+/**
+ * Disable logs stream.
+ *
+ * Turn off the logs stream feature for this cluster.
+ * @rest_spec_name streams.logs_disable
+ * @availability stack since=9.1.0 stability=experimental visibility=feature_flag feature_flag=logs_stream
+ * @cluster_privileges manage
+ * @doc_id streams-logs-disable
+ */
+export interface Request extends RequestBase {
+ urls: [
+ {
+ path: '/_streams/logs/_disable'
+ methods: ['POST']
+ }
+ ]
+ query_parameters: {
+ /**
+ * The period to wait for a connection to the master node.
+ * If no response is received before the timeout expires, the request fails and returns an error.
+ *
+ * @server_default 30s
+ */
+ master_timeout?: Duration
+ /**
+ * The period to wait for a response.
+ * If no response is received before the timeout expires, the request fails and returns an error.
+ *
+ * @server_default 30s
+ */
+ timeout?: Duration
+ }
+}
diff --git a/specification/streams/logs_disable/StreamsLogsDisableResponse.ts b/specification/streams/logs_disable/StreamsLogsDisableResponse.ts
new file mode 100644
index 0000000000..9e7bdb91cd
--- /dev/null
+++ b/specification/streams/logs_disable/StreamsLogsDisableResponse.ts
@@ -0,0 +1,25 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { AcknowledgedResponseBase } from '@_types/Base'
+
+export class Response {
+ /** @codegen_name result */
+ body: AcknowledgedResponseBase
+}
diff --git a/specification/streams/logs_disable/examples/200_response/PostStreamsLogsDisableResponseExample1.yaml b/specification/streams/logs_disable/examples/200_response/PostStreamsLogsDisableResponseExample1.yaml
new file mode 100644
index 0000000000..3add46c389
--- /dev/null
+++ b/specification/streams/logs_disable/examples/200_response/PostStreamsLogsDisableResponseExample1.yaml
@@ -0,0 +1,6 @@
+summary: Disable logs streams
+description: >
+ A successful response from `POST _streams/logs/_disable` endpoint
+# type: response
+value:
+ acknowledged: true
diff --git a/specification/streams/logs_disable/examples/request/PostStreamsDisableRequestExample1.yaml b/specification/streams/logs_disable/examples/request/PostStreamsDisableRequestExample1.yaml
new file mode 100644
index 0000000000..b286db3e0e
--- /dev/null
+++ b/specification/streams/logs_disable/examples/request/PostStreamsDisableRequestExample1.yaml
@@ -0,0 +1,3 @@
+summary: 'Disable the logs streams on this cluster'
+method_request: POST _streams/logs/_disable
+# type: request
diff --git a/specification/streams/logs_enable/StreamsLogsEnableRequest.ts b/specification/streams/logs_enable/StreamsLogsEnableRequest.ts
new file mode 100644
index 0000000000..71915b4446
--- /dev/null
+++ b/specification/streams/logs_enable/StreamsLogsEnableRequest.ts
@@ -0,0 +1,59 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { RequestBase } from '@_types/Base'
+import { Duration } from '@_types/Time'
+
+/**
+ * Enable logs stream.
+ *
+ * Turn on the logs stream feature for this cluster.
+ *
+ * NOTE: To protect existing data, this feature can be turned on only if the
+ * cluster does not have existing indices or data streams that match the pattern `logs|logs.*`.
+ * If those indices or data streams exist, a `409 - Conflict` response and error is returned.
+ * @rest_spec_name streams.logs_enable
+ * @availability stack since=9.1.0 stability=experimental visibility=feature_flag feature_flag=logs_stream
+ * @cluster_privileges manage
+ * @doc_id streams-logs-enable
+ */
+export interface Request extends RequestBase {
+ urls: [
+ {
+ path: '/_streams/logs/_enable'
+ methods: ['POST']
+ }
+ ]
+ query_parameters: {
+ /**
+ * The period to wait for a connection to the master node.
+ * If no response is received before the timeout expires, the request fails and returns an error.
+ *
+ * @server_default 30s
+ */
+ master_timeout?: Duration
+ /**
+ * The period to wait for a response.
+ * If no response is received before the timeout expires, the request fails and returns an error.
+ *
+ * @server_default 30s
+ */
+ timeout?: Duration
+ }
+}
diff --git a/specification/streams/logs_enable/StreamsLogsEnableResponse.ts b/specification/streams/logs_enable/StreamsLogsEnableResponse.ts
new file mode 100644
index 0000000000..9e7bdb91cd
--- /dev/null
+++ b/specification/streams/logs_enable/StreamsLogsEnableResponse.ts
@@ -0,0 +1,25 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { AcknowledgedResponseBase } from '@_types/Base'
+
+export class Response {
+ /** @codegen_name result */
+ body: AcknowledgedResponseBase
+}
diff --git a/specification/streams/logs_enable/examples/200_response/PostStreamsLogsEnableResponseExample1.yaml b/specification/streams/logs_enable/examples/200_response/PostStreamsLogsEnableResponseExample1.yaml
new file mode 100644
index 0000000000..bf5af6721a
--- /dev/null
+++ b/specification/streams/logs_enable/examples/200_response/PostStreamsLogsEnableResponseExample1.yaml
@@ -0,0 +1,6 @@
+summary: Enable logs streams
+description: >
+ A successful response from `POST _streams/logs/_enable` endpoint
+# type: response
+value:
+ acknowledged: true
diff --git a/specification/streams/logs_enable/examples/409_response/PostStreamsLogsEnableResponseExample2.yaml b/specification/streams/logs_enable/examples/409_response/PostStreamsLogsEnableResponseExample2.yaml
new file mode 100644
index 0000000000..5f20637ff6
--- /dev/null
+++ b/specification/streams/logs_enable/examples/409_response/PostStreamsLogsEnableResponseExample2.yaml
@@ -0,0 +1,19 @@
+summary: Enable logs streams - Failure due to conflicting index
+description: >
+ An error response from the `POST _streams/logs/_enable` endpoint caused by attempting to enable logs streams
+ when an existing index with the name `logs` already exists
+# type: response
+value: |-
+ {
+ "error": {
+ "root_cause": [
+ {
+ "type": "status_exception",
+ "reason": "Cannot enable logs streams: indices named 'logs' or starting with 'logs.' already exist."
+ }
+ ],
+ "type": "status_exception",
+ "reason": "Cannot enable logs streams: indices named 'logs' or starting with 'logs.' already exist."
+ },
+ "status": 409
+ }
diff --git a/specification/streams/logs_enable/examples/request/PostStreamsEnableRequestExample1.yaml b/specification/streams/logs_enable/examples/request/PostStreamsEnableRequestExample1.yaml
new file mode 100644
index 0000000000..246312fc54
--- /dev/null
+++ b/specification/streams/logs_enable/examples/request/PostStreamsEnableRequestExample1.yaml
@@ -0,0 +1,3 @@
+summary: 'Enable the logs streams on this cluster'
+method_request: POST _streams/logs/_enable
+# type: request
diff --git a/specification/streams/status/StreamsStatusRequest.ts b/specification/streams/status/StreamsStatusRequest.ts
new file mode 100644
index 0000000000..e3877e030c
--- /dev/null
+++ b/specification/streams/status/StreamsStatusRequest.ts
@@ -0,0 +1,47 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { RequestBase } from '@_types/Base'
+import { TimeUnit } from '@_types/Time'
+
+/**
+ * Get the status of streams.
+ *
+ * Get the current status for all types of streams.
+ * @rest_spec_name streams.status
+ * @availability stack since=9.1.0 stability=experimental visibility=feature_flag feature_flag=logs_stream
+ * @cluster_privileges monitor
+ * @doc_id streams-status
+ */
+export interface Request extends RequestBase {
+ urls: [
+ {
+ path: '/_streams/status'
+ methods: ['GET']
+ }
+ ]
+ query_parameters: {
+ /**
+ * Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
+ *
+ * @server_default 30s
+ */
+ master_timeout?: TimeUnit
+ }
+}
diff --git a/specification/streams/status/StreamsStatusResponse.ts b/specification/streams/status/StreamsStatusResponse.ts
new file mode 100644
index 0000000000..ccc7f8d957
--- /dev/null
+++ b/specification/streams/status/StreamsStatusResponse.ts
@@ -0,0 +1,31 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+export class Response {
+ body: {
+ logs: LogsStatus
+ }
+}
+
+export class LogsStatus {
+ /**
+ * If true, the logs stream feature is enabled.
+ */
+ enabled: boolean
+}
diff --git a/specification/streams/status/examples/200_response/GetStreamsStatusResponseExample1.yaml b/specification/streams/status/examples/200_response/GetStreamsStatusResponseExample1.yaml
new file mode 100644
index 0000000000..be7f745dcf
--- /dev/null
+++ b/specification/streams/status/examples/200_response/GetStreamsStatusResponseExample1.yaml
@@ -0,0 +1,9 @@
+summary: Get Streams Status
+ A successful response from `GET _streams/status` that outlines the current state of all wired streams in the cluster.
+# type: response
+value: |-
+ {
+ "logs": {
+ "enabled": true
+ }
+ }
diff --git a/specification/streams/status/examples/request/GetStreamsStatusRequestExample1.yaml b/specification/streams/status/examples/request/GetStreamsStatusRequestExample1.yaml
new file mode 100644
index 0000000000..920ce2cc90
--- /dev/null
+++ b/specification/streams/status/examples/request/GetStreamsStatusRequestExample1.yaml
@@ -0,0 +1,3 @@
+summary: 'Get the current status of streams'
+method_request: GET _streams/status
+# type: request
diff --git a/specification/tsconfig.json b/specification/tsconfig.json
index e920f83fce..867d8f0655 100644
--- a/specification/tsconfig.json
+++ b/specification/tsconfig.json
@@ -50,6 +50,7 @@
"@shutdown/*": ["shutdown/*"],
"@slm/*": ["slm/*"],
"@snapshot/*": ["snapshot/*"],
+ "@streams/*": ["streams/*"],
"@sql/*": ["sql/*"],
"@ssl/*": ["ssl/*"],
"@synonyms/*": ["synonyms/*"],